Repository navigation
Add stdlib/_ctypes #8571
Description
My projects use some COM-ffi packages.
I use _ctypes.COMError or _ctypes.CopyComPointer too, but they are not defined in the type stub, so mypy type checker raises Cannot find implementation or library stub for module named "_ctypes" error.
I would like to add type stubs like this.
from ctypes import _CArgObject, _PointerLike
# are they correct?
_COMError_Details = tuple[str | None, str | None, str | None, int | None, int | None] # Description, Source, HelpFile, HelpContext, scode
class COMError(Exception):
"""Raised when a COM method call failed."""
hresult: int
text: str
details: _COMError_Details
def __init__(self, hresult: _COMError_HResult, text: str, details: _COMError_Details) -> None: ...
def CopyComPointer(src: _PointerLike, dst: _PointerLike | _CArgObject) -> int: ... # `dst` sometimes maybe return value of `ctypes.byref`.
"""CopyComPointer(src, dst) -> HRESULT value"""But other APIs are not clear to me.
- and where the
if sys.platform == "win32":needed.
Any opinions would be appreciated.
Activity
[-]Add `stdlib/ctypes/_ctypes.pyi`[/-][+]Add `stdlib/_ctypes.pyi`[/+][-]Add `stdlib/_ctypes.pyi`[/-][+]Add `stdlib/_ctypes`[/+]Akuli commentedon Aug 20, 2022
Feel free to make a pull request :) There's already lots of other
_foo.pyimodules instdlib/.Some thoughts:
_ctypesas incomplete. This is explained in CONTRIBUTING.md.if sys.platform == "win32"._COMError_Detailsreally be something like("blah", None, None, 123, None)? If it's not possible for some but not all elements to be None, it should betuple[str, str, str, int, int] | tuple[None, None, None, None, None].AlexWaygood commentedon Aug 20, 2022
Most of the stuff that we currently have in
stdlib/ctypes/__init__.pyiis actually re-exported from_ctypesat runtime. If we add_ctypes.pyi, we should eventually move those definitions fromstdlib/ctypes/__init__.pyito_ctypes.pyi, to mimic the runtime more precisely. (That doesn't need to be done in the initial PR adding_ctypes.pyi, though.)junkmd commentedon Aug 20, 2022
@Akuli
Thanks for your response.
I am motivated to contribute to this repository.
I see. I will have to peruse the
CONTRIBUTING.md.There was a post on stack overflow about the lack of
COMErrorin a linux environment.https://stackoverflow.com/questions/37161560/importerror-cannot-import-name-comerror-in-python
I will use
if sys.platform == "win32"when defining COM related objects in stubs.Each element of
_COMError_Detailscan beNone,intorstr.Searching
_ctypes.COMErrorin github often shows(None, None, None, 0, None).But there are also cases where we get
tuple[str, str, str, int, None]ortuple[str, str, None, int, int].COMError.textisNone.Therefore,
tuple[...] | tuple[...]does not represent the actual situation.junkmd commentedon Aug 20, 2022
@AlexWaygood
Thanks for your response.
Regardless of the relationship at runtime, I will create
_ctypesstub using imported stuffs fromctypesfor now.I see that the
_Pointerrecently added to thectypesstub is also originally defined in_ctypes.But I don't want to make it perfect from the beginning, I want to make it my first priority to get out of the situation where
Cannot find ... module named "_ctypes"is displayed for now.AlexWaygood commentedon Aug 20, 2022
Sounds good to me!
hauntsaninja commentedon Aug 20, 2022
You'll also need to add
_ctypesto https://github.com/python/typeshed/blob/master/stdlib/VERSIONS