basedpyright 1.12.6 → 1.13.0

package/dist/typeshed-fallback/stdlib/_ctypes.pyi

@@ -1,3 +1,5 @@
+"""Create and manipulate C compatible data types in Python."""
+
 import sys
 from _typeshed import ReadableBuffer, WriteableBuffer
 from abc import abstractmethod
@@ -79,6 +81,7 @@ class _CData(metaclass=_CDataMeta):
     def __release_buffer__(self, buffer: memoryview, /) -> None: ...
 
 class _SimpleCData(_CData, Generic[_T]):
+    """XXX to be provided"""
     value: _T
     # The TypeVar can be unsolved here,
     # but we can't use overloads without creating many, many mypy false-positive errors
@@ -88,6 +91,7 @@ class _CanCastTo(_CData): ...
 class _PointerLike(_CanCastTo): ...
 
 class _Pointer(_PointerLike, _CData, Generic[_CT]):
+    """XXX to be provided"""
     _type_: type[_CT]
     contents: _CT
     @overload
@@ -95,22 +99,35 @@ class _Pointer(_PointerLike, _CData, Generic[_CT]):
     @overload
     def __init__(self, arg: _CT) -> None: ...
     @overload
-    def __getitem__(self, key: int, /) -> Any: ...
+    def __getitem__(self, key: int, /) -> Any:
+        """Return self[key]."""
+        ...
     @overload
-    def __getitem__(self, key: slice, /) -> list[Any]: ...
-    def __setitem__(self, key: int, value: Any, /) -> None: ...
+    def __getitem__(self, key: slice, /) -> list[Any]:
+        """Return self[key]."""
+        ...
+    def __setitem__(self, key: int, value: Any, /) -> None:
+        """Set self[key] to value."""
+        ...
 
 def POINTER(type: type[_CT]) -> type[_Pointer[_CT]]: ...
 def pointer(arg: _CT, /) -> _Pointer[_CT]: ...
 
 class _CArgObject: ...
 
-def byref(obj: _CData, offset: int = ...) -> _CArgObject: ...
+def byref(obj: _CData, offset: int = ...) -> _CArgObject:
+    """
+    byref(C instance[, offset=0]) -> byref-object
+    Return a pointer lookalike to a C instance, only usable
+    as function argument
+    """
+    ...
 
 _ECT: TypeAlias = Callable[[_CData | None, CFuncPtr, tuple[_CData, ...]], _CData]
 _PF: TypeAlias = tuple[int] | tuple[int, str | None] | tuple[int, str | None, Any]
 
 class CFuncPtr(_PointerLike, _CData):
+    """Function Pointer"""
     restype: type[_CData] | Callable[[int], Any] | None
     argtypes: Sequence[type[_CData]]
     errcheck: _ECT
@@ -130,7 +147,9 @@ class CFuncPtr(_PointerLike, _CData):
             self, vtbl_index: int, name: str, paramflags: tuple[_PF, ...] | None = ..., iid: _CData | None = ..., /
         ) -> None: ...
 
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
 
 _GetT = TypeVar("_GetT")
 _SetT = TypeVar("_SetT")
@@ -155,10 +174,15 @@ class _StructUnionBase(_CData, metaclass=_StructUnionMeta):
     def __getattr__(self, name: str) -> Any: ...
     def __setattr__(self, name: str, value: Any) -> None: ...
 
-class Union(_StructUnionBase): ...
-class Structure(_StructUnionBase): ...
+class Union(_StructUnionBase):
+    """Union base class"""
+    ...
+class Structure(_StructUnionBase):
+    """Structure base class"""
+    ...
 
 class Array(_CData, Generic[_CT]):
+    """XXX to be provided"""
     @property
     @abstractmethod
     def _length_(self) -> int: ...
@@ -189,23 +213,54 @@ class Array(_CData, Generic[_CT]):
     # the array element type would belong are annotated with Any instead.
     def __init__(self, *args: Any) -> None: ...
     @overload
-    def __getitem__(self, key: int, /) -> Any: ...
+    def __getitem__(self, key: int, /) -> Any:
+        """Return self[key]."""
+        ...
     @overload
-    def __getitem__(self, key: slice, /) -> list[Any]: ...
+    def __getitem__(self, key: slice, /) -> list[Any]:
+        """Return self[key]."""
+        ...
     @overload
-    def __setitem__(self, key: int, value: Any, /) -> None: ...
+    def __setitem__(self, key: int, value: Any, /) -> None:
+        """Set self[key] to value."""
+        ...
     @overload
-    def __setitem__(self, key: slice, value: Iterable[Any], /) -> None: ...
+    def __setitem__(self, key: slice, value: Iterable[Any], /) -> None:
+        """Set self[key] to value."""
+        ...
     def __iter__(self) -> Iterator[Any]: ...
     # Can't inherit from Sized because the metaclass conflict between
     # Sized and _CData prevents using _CDataMeta.
-    def __len__(self) -> int: ...
+    def __len__(self) -> int:
+        """Return len(self)."""
+        ...
     if sys.version_info >= (3, 9):
-        def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
+        def __class_getitem__(cls, item: Any, /) -> GenericAlias:
+            """See PEP 585"""
+            ...
 
-def addressof(obj: _CData) -> int: ...
-def alignment(obj_or_type: _CData | type[_CData]) -> int: ...
+def addressof(obj: _CData) -> int:
+    """
+    addressof(C instance) -> integer
+    Return the address of the C instance internal buffer
+    """
+    ...
+def alignment(obj_or_type: _CData | type[_CData]) -> int:
+    """
+    alignment(C type) -> integer
+    alignment(C instance) -> integer
+    Return the alignment requirements of a C instance
+    """
+    ...
 def get_errno() -> int: ...
-def resize(obj: _CData, size: int) -> None: ...
+def resize(obj: _CData, size: int) -> None:
+    """Resize the memory buffer of a ctypes instance"""
+    ...
 def set_errno(value: int) -> int: ...
-def sizeof(obj_or_type: _CData | type[_CData]) -> int: ...
+def sizeof(obj_or_type: _CData | type[_CData]) -> int:
+    """
+    sizeof(C type) -> integer
+    sizeof(C instance) -> integer
+    Return the size in bytes of a C instance
+    """
+    ...