Repository navigation
migrate some stuffs in ctypes/__init__.pyi into _ctypes.pyi, but circular import occurs #8633
Description
When we submitted PR that adds the stdlib/_ctypes.pyi(#8582), imports some stuffs from ctypes.
But the implementation imports some stuffs from _ctypes to ctypes.
- also related to Add
stdlib/_ctypes#8571 (comment)
However, trying to write type stubs as close as possible to the implementation would result in circular imports if we just move definitions around.
- For example,
CDLLin args of_CDatamethods.- In implementation...
CDLLLis defined inctypes_CData(base class of_SimpleCData) is defined in_ctypes.
- In implementation...
- Some PRs, such as delete _importlib_modulespec #5350, were merged as "should be fine in
pyifiles" even if they are circular imports.
Any opinions would be appreciated.
Activity
hauntsaninja commentedon Aug 29, 2022
You don't really need to worry about circular imports, since stub files are never imported by Python. All type checkers know how to resolve circular imports when resolving references. That said, in this case you could probably move the fake definitions
_CArgObject, _PointerLiketo_ctypesand import them inctypes.junkmd commentedon Aug 29, 2022
When we tried to make the change, we found that the test using
pytyperunning in CI failed.Please see #8643.
I will work on adding TODO comments to the stuffs originally defined in
_ctypesuntilpytypeis fixed or better workarounds are found.junkmd commentedon Aug 30, 2022
I submitted issue to
pytypegoogle/pytype#1281junkmd commentedon Aug 30, 2022
The
pytypeproblem causes by its own_ctypesstub.This will be fixed "in a few weeks".
junkmd commentedon Aug 30, 2022
List of the stuffs in
ctypes/__init__.pyithose what originally defined in_ctypesmarked stuffs have been migrated.
ArgumentErrorArrayFormatErrorPOINTERRTLD_GLOBALRTLD_LOCALStructureUnion_Pointer_SimpleCData_CData(hidden base class)addressofalignmentbyrefget_errnoget_last_errorpointerresizeset_errnoset_last_errorsizeofrchen152 commentedon Aug 30, 2022
If you update to pytype 2022.08.30, you should be able to import
RTLD_GLOBALandRTLD_LOCALfrom_ctypesnow. (Just to clarify, what will happen "in a few weeks" is that I'll delete pytype's_ctypesstub so that it no longer has to be kept in sync with typeshed's.)junkmd commentedon Aug 31, 2022
Currently,
RTLD_GLOBALandRTLD_LOCALare imported from_ctypes.pyi(#8656).AlexWaygood commentedon Aug 31, 2022
Yes, the pytype update did the trick — thanks v much @rchen152!
AlexWaygood commentedon Apr 29, 2023
I just updated typeshed's pinned version of pytype to 2023.4.27 in #10111. pytype v2023.4.27 includes google/pytype@2e2088f, which removes pytype's copy of
stdlib/_ctypes.pyi. This means we can now move the rest of the definitions that should be in_ctypes.pyi(but are currently inctypes/__init__.pyi) over to_ctypes.pyi.junkmd commentedon May 3, 2023
#10118, #10125, #10128, #10130, #10133 and #10137 have been merged and the definition movings are completed.
The
CFuncPtrand the_FuncPointerwill be addressed within the scope of #8968 and #10132.