basedpyright 1.13.2 → 1.13.3

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

@@ -71,6 +71,20 @@ _VT_co = TypeVar("_VT_co", covariant=True)
 # Make sure this class definition stays roughly in line with `builtins.function`
 @final
 class FunctionType:
+    """
+    Create a function object.
+
+    code
+      a code object
+    globals
+      the globals dictionary
+    name
+      a string that overrides the name from the code object
+    argdefs
+      a tuple that specifies the default argument values
+    closure
+      a tuple that supplies the bindings for free variables
+    """
     @property
     def __closure__(self) -> tuple[CellType, ...] | None: ...
     __code__: CodeType
@@ -97,18 +111,35 @@ class FunctionType:
         argdefs: tuple[object, ...] | None = ...,
         closure: tuple[CellType, ...] | None = ...,
     ) -> Self: ...
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
     @overload
-    def __get__(self, instance: None, owner: type, /) -> FunctionType: ...
+    def __get__(self, instance: None, owner: type, /) -> FunctionType:
+        """Return an attribute of instance, which is of type owner."""
+        ...
     @overload
-    def __get__(self, instance: object, owner: type | None = None, /) -> MethodType: ...
+    def __get__(self, instance: object, owner: type | None = None, /) -> MethodType:
+        """Return an attribute of instance, which is of type owner."""
+        ...
 
 LambdaType = FunctionType
 
 @final
 class CodeType:
-    def __eq__(self, value: object, /) -> bool: ...
-    def __hash__(self) -> int: ...
+    """
+    code(argcount, posonlyargcount, kwonlyargcount, nlocals, stacksize,
+          flags, codestring, constants, names, varnames, filename, name,
+          firstlineno, lnotab[, freevars[, cellvars]])
+
+    Create a code object.  Not for the faint of heart.
+    """
+    def __eq__(self, value: object, /) -> bool:
+        """Return self==value."""
+        ...
+    def __hash__(self) -> int:
+        """Return hash(self)."""
+        ...
     @property
     def co_argcount(self) -> int: ...
     @property
@@ -245,7 +276,9 @@ class CodeType:
             co_qualname: str = ...,
             co_linetable: bytes = ...,
             co_exceptiontable: bytes = ...,
-        ) -> CodeType: ...
+        ) -> Self:
+            """Return a copy of the code object with new values for the specified fields."""
+            ...
     elif sys.version_info >= (3, 10):
         def replace(
             self,
@@ -266,7 +299,9 @@ class CodeType:
             co_filename: str = ...,
             co_name: str = ...,
             co_linetable: bytes = ...,
-        ) -> CodeType: ...
+        ) -> Self:
+            """Return a copy of the code object with new values for the specified fields."""
+            ...
     else:
         def replace(
             self,
@@ -287,35 +322,79 @@ class CodeType:
             co_filename: str = ...,
             co_name: str = ...,
             co_lnotab: bytes = ...,
-        ) -> CodeType: ...
+        ) -> Self:
+            """Return a copy of the code object with new values for the specified fields."""
+            ...
+
+    if sys.version_info >= (3, 13):
+        __replace__ = replace
 
 @final
 class MappingProxyType(Mapping[_KT, _VT_co]):
     __hash__: ClassVar[None]  # type: ignore[assignment]
     def __new__(cls, mapping: SupportsKeysAndGetItem[_KT, _VT_co]) -> Self: ...
-    def __getitem__(self, key: _KT, /) -> _VT_co: ...
-    def __iter__(self) -> Iterator[_KT]: ...
-    def __len__(self) -> int: ...
-    def __eq__(self, value: object, /) -> bool: ...
-    def copy(self) -> dict[_KT, _VT_co]: ...
-    def keys(self) -> KeysView[_KT]: ...
-    def values(self) -> ValuesView[_VT_co]: ...
-    def items(self) -> ItemsView[_KT, _VT_co]: ...
+    def __getitem__(self, key: _KT, /) -> _VT_co:
+        """Return self[key]."""
+        ...
+    def __iter__(self) -> Iterator[_KT]:
+        """Implement iter(self)."""
+        ...
+    def __len__(self) -> int:
+        """Return len(self)."""
+        ...
+    def __eq__(self, value: object, /) -> bool:
+        """Return self==value."""
+        ...
+    def copy(self) -> dict[_KT, _VT_co]:
+        """D.copy() -> a shallow copy of D"""
+        ...
+    def keys(self) -> KeysView[_KT]:
+        """D.keys() -> list of D's keys"""
+        ...
+    def values(self) -> ValuesView[_VT_co]:
+        """D.values() -> list of D's values"""
+        ...
+    def items(self) -> ItemsView[_KT, _VT_co]:
+        """D.items() -> list of D's (key, value) pairs, as 2-tuples"""
+        ...
     if sys.version_info >= (3, 9):
-        def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
-        def __reversed__(self) -> Iterator[_KT]: ...
-        def __or__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]: ...
-        def __ror__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]: ...
+        def __class_getitem__(cls, item: Any, /) -> GenericAlias:
+            """See PEP 585"""
+            ...
+        def __reversed__(self) -> Iterator[_KT]:
+            """D.__reversed__() -> reverse iterator"""
+            ...
+        def __or__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]:
+            """Return self|value."""
+            ...
+        def __ror__(self, value: Mapping[_T1, _T2], /) -> dict[_KT | _T1, _VT_co | _T2]:
+            """Return value|self."""
+            ...
 
 class SimpleNamespace:
     __hash__: ClassVar[None]  # type: ignore[assignment]
     def __init__(self, **kwargs: Any) -> None: ...
-    def __eq__(self, value: object, /) -> bool: ...
-    def __getattribute__(self, name: str, /) -> Any: ...
-    def __setattr__(self, name: str, value: Any, /) -> None: ...
-    def __delattr__(self, name: str, /) -> None: ...
+    def __eq__(self, value: object, /) -> bool:
+        """Return self==value."""
+        ...
+    def __getattribute__(self, name: str, /) -> Any:
+        """Return getattr(self, name)."""
+        ...
+    def __setattr__(self, name: str, value: Any, /) -> None:
+        """Implement setattr(self, name, value)."""
+        ...
+    def __delattr__(self, name: str, /) -> None:
+        """Implement delattr(self, name)."""
+        ...
+    if sys.version_info >= (3, 13):
+        def __replace__(self, **kwargs: Any) -> Self: ...
 
 class ModuleType:
+    """
+    Create a module object.
+
+    The name must be a string; the optional doc argument can have any type.
+    """
     __name__: str
     __file__: str | None
     @property
@@ -332,6 +411,15 @@ class ModuleType:
 
 @final
 class CellType:
+    """
+    Create a new cell object.
+
+     contents
+       the contents of the cell. If not specified, the cell will be empty,
+       and 
+    further attempts to access its cell_contents attribute will
+       raise a ValueError.
+    """
     def __new__(cls, contents: object = ..., /) -> Self: ...
     __hash__: ClassVar[None]  # type: ignore[assignment]
     cell_contents: Any
@@ -343,46 +431,83 @@ _ReturnT_co = TypeVar("_ReturnT_co", covariant=True)
 @final
 class GeneratorType(Generator[_YieldT_co, _SendT_contra, _ReturnT_co]):
     @property
-    def gi_yieldfrom(self) -> GeneratorType[_YieldT_co, _SendT_contra, Any] | None: ...
+    def gi_yieldfrom(self) -> GeneratorType[_YieldT_co, _SendT_contra, Any] | None:
+        """object being iterated by yield from, or None"""
+        ...
     if sys.version_info >= (3, 11):
         @property
         def gi_suspended(self) -> bool: ...
     __name__: str
     __qualname__: str
-    def __iter__(self) -> Self: ...
-    def __next__(self) -> _YieldT_co: ...
-    def send(self, arg: _SendT_contra, /) -> _YieldT_co: ...
+    def __iter__(self) -> Self:
+        """Implement iter(self)."""
+        ...
+    def __next__(self) -> _YieldT_co:
+        """Implement next(self)."""
+        ...
+    def send(self, arg: _SendT_contra, /) -> _YieldT_co:
+        """
+        send(arg) -> send 'arg' into generator,
+        return next yielded value or raise StopIteration.
+        """
+        ...
     @overload
     def throw(
         self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., /
-    ) -> _YieldT_co: ...
+    ) -> _YieldT_co:
+        """
+        throw(typ[,val[,tb]]) -> raise exception in generator,
+        return next yielded value or raise StopIteration.
+        """
+        ...
     @overload
-    def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ...
+    def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co:
+        """
+        throw(typ[,val[,tb]]) -> raise exception in generator,
+        return next yielded value or raise StopIteration.
+        """
+        ...
     if sys.version_info >= (3, 13):
         def __class_getitem__(cls, item: Any, /) -> Any: ...
 
 @final
 class AsyncGeneratorType(AsyncGenerator[_YieldT_co, _SendT_contra]):
     @property
-    def ag_await(self) -> Awaitable[Any] | None: ...
+    def ag_await(self) -> Awaitable[Any] | None:
+        """object being awaited on, or None"""
+        ...
     __name__: str
     __qualname__: str
     if sys.version_info >= (3, 12):
         @property
         def ag_suspended(self) -> bool: ...
 
-    def __aiter__(self) -> Self: ...
-    def __anext__(self) -> Coroutine[Any, Any, _YieldT_co]: ...
-    def asend(self, val: _SendT_contra, /) -> Coroutine[Any, Any, _YieldT_co]: ...
+    def __aiter__(self) -> Self:
+        """Return an awaitable, that resolves in asynchronous iterator."""
+        ...
+    def __anext__(self) -> Coroutine[Any, Any, _YieldT_co]:
+        """Return a value or raise StopAsyncIteration."""
+        ...
+    def asend(self, val: _SendT_contra, /) -> Coroutine[Any, Any, _YieldT_co]:
+        """asend(v) -> send 'v' in generator."""
+        ...
     @overload
     async def athrow(
         self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., /
-    ) -> _YieldT_co: ...
+    ) -> _YieldT_co:
+        """athrow(typ[,val[,tb]]) -> raise exception in generator."""
+        ...
     @overload
-    async def athrow(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ...
-    def aclose(self) -> Coroutine[Any, Any, None]: ...
+    async def athrow(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co:
+        """athrow(typ[,val[,tb]]) -> raise exception in generator."""
+        ...
+    def aclose(self) -> Coroutine[Any, Any, None]:
+        """aclose() -> raise GeneratorExit inside generator."""
+        ...
     if sys.version_info >= (3, 9):
-        def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
+        def __class_getitem__(cls, item: Any, /) -> GenericAlias:
+            """See PEP 585"""
+            ...
 
 @final
 class CoroutineType(Coroutine[_YieldT_co, _SendT_contra, _ReturnT_co]):
@@ -394,36 +519,70 @@ class CoroutineType(Coroutine[_YieldT_co, _SendT_contra, _ReturnT_co]):
         @property
         def cr_suspended(self) -> bool: ...
 
-    def close(self) -> None: ...
-    def __await__(self) -> Generator[Any, None, _ReturnT_co]: ...
-    def send(self, arg: _SendT_contra, /) -> _YieldT_co: ...
+    def close(self) -> None:
+        """close() -> raise GeneratorExit inside coroutine."""
+        ...
+    def __await__(self) -> Generator[Any, None, _ReturnT_co]:
+        """Return an iterator to be used in await expression."""
+        ...
+    def send(self, arg: _SendT_contra, /) -> _YieldT_co:
+        """
+        send(arg) -> send 'arg' into coroutine,
+        return next iterated value or raise StopIteration.
+        """
+        ...
     @overload
     def throw(
         self, typ: type[BaseException], val: BaseException | object = ..., tb: TracebackType | None = ..., /
-    ) -> _YieldT_co: ...
+    ) -> _YieldT_co:
+        """
+        throw(typ[,val[,tb]]) -> raise exception in coroutine,
+        return next iterated value or raise StopIteration.
+        """
+        ...
     @overload
-    def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co: ...
+    def throw(self, typ: BaseException, val: None = None, tb: TracebackType | None = ..., /) -> _YieldT_co:
+        """
+        throw(typ[,val[,tb]]) -> raise exception in coroutine,
+        return next iterated value or raise StopIteration.
+        """
+        ...
     if sys.version_info >= (3, 13):
         def __class_getitem__(cls, item: Any, /) -> Any: ...
 
 @final
 class MethodType:
+    """
+    method(function, instance)
+
+    Create a bound instance method object.
+    """
     @property
     def __closure__(self) -> tuple[CellType, ...] | None: ...  # inherited from the added function
     @property
     def __defaults__(self) -> tuple[Any, ...] | None: ...  # inherited from the added function
     @property
-    def __func__(self) -> Callable[..., Any]: ...
+    def __func__(self) -> Callable[..., Any]:
+        """the function (or other callable) implementing a method"""
+        ...
     @property
-    def __self__(self) -> object: ...
+    def __self__(self) -> object:
+        """the instance to which a method is bound"""
+        ...
     @property
     def __name__(self) -> str: ...  # inherited from the added function
     @property
     def __qualname__(self) -> str: ...  # inherited from the added function
     def __new__(cls, func: Callable[..., Any], obj: object, /) -> Self: ...
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
-    def __eq__(self, value: object, /) -> bool: ...
-    def __hash__(self) -> int: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
+    def __eq__(self, value: object, /) -> bool:
+        """Return self==value."""
+        ...
+    def __hash__(self) -> int:
+        """Return hash(self)."""
+        ...
 
 @final
 class BuiltinFunctionType:
@@ -433,9 +592,15 @@ class BuiltinFunctionType:
     def __name__(self) -> str: ...
     @property
     def __qualname__(self) -> str: ...
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
-    def __eq__(self, value: object, /) -> bool: ...
-    def __hash__(self) -> int: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
+    def __eq__(self, value: object, /) -> bool:
+        """Return self==value."""
+        ...
+    def __hash__(self) -> int:
+        """Return hash(self)."""
+        ...
 
 BuiltinMethodType = BuiltinFunctionType
 
@@ -447,8 +612,12 @@ class WrapperDescriptorType:
     def __qualname__(self) -> str: ...
     @property
     def __objclass__(self) -> type: ...
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
-    def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
+    def __get__(self, instance: Any, owner: type | None = None, /) -> Any:
+        """Return an attribute of instance, which is of type owner."""
+        ...
 
 @final
 class MethodWrapperType:
@@ -460,10 +629,18 @@ class MethodWrapperType:
     def __qualname__(self) -> str: ...
     @property
     def __objclass__(self) -> type: ...
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
-    def __eq__(self, value: object, /) -> bool: ...
-    def __ne__(self, value: object, /) -> bool: ...
-    def __hash__(self) -> int: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
+    def __eq__(self, value: object, /) -> bool:
+        """Return self==value."""
+        ...
+    def __ne__(self, value: object, /) -> bool:
+        """Return self!=value."""
+        ...
+    def __hash__(self) -> int:
+        """Return hash(self)."""
+        ...
 
 @final
 class MethodDescriptorType:
@@ -473,8 +650,12 @@ class MethodDescriptorType:
     def __qualname__(self) -> str: ...
     @property
     def __objclass__(self) -> type: ...
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
-    def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
+    def __get__(self, instance: Any, owner: type | None = None, /) -> Any:
+        """Return an attribute of instance, which is of type owner."""
+        ...
 
 @final
 class ClassMethodDescriptorType:
@@ -484,11 +665,21 @@ class ClassMethodDescriptorType:
     def __qualname__(self) -> str: ...
     @property
     def __objclass__(self) -> type: ...
-    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
-    def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ...
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        """Call self as a function."""
+        ...
+    def __get__(self, instance: Any, owner: type | None = None, /) -> Any:
+        """Return an attribute of instance, which is of type owner."""
+        ...
 
 @final
 class TracebackType:
+    """
+    TracebackType(tb_next, tb_frame, tb_lasti, tb_lineno)
+    --
+
+    Create a new traceback object.
+    """
     def __new__(cls, tb_next: TracebackType | None, tb_frame: FrameType, tb_lasti: int, tb_lineno: int) -> Self: ...
     tb_next: TracebackType | None
     # the rest are read-only
@@ -521,7 +712,9 @@ class FrameType:
     f_trace: Callable[[FrameType, str, Any], Any] | None
     f_trace_lines: bool
     f_trace_opcodes: bool
-    def clear(self) -> None: ...
+    def clear(self) -> None:
+        """F.clear(): clear most references held by the frame"""
+        ...
 
 @final
 class GetSetDescriptorType:
@@ -531,9 +724,15 @@ class GetSetDescriptorType:
     def __qualname__(self) -> str: ...
     @property
     def __objclass__(self) -> type: ...
-    def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ...
-    def __set__(self, instance: Any, value: Any, /) -> None: ...
-    def __delete__(self, instance: Any, /) -> None: ...
+    def __get__(self, instance: Any, owner: type | None = None, /) -> Any:
+        """Return an attribute of instance, which is of type owner."""
+        ...
+    def __set__(self, instance: Any, value: Any, /) -> None:
+        """Set an attribute of instance to value."""
+        ...
+    def __delete__(self, instance: Any, /) -> None:
+        """Delete an attribute of instance."""
+        ...
 
 @final
 class MemberDescriptorType:
@@ -543,9 +742,15 @@ class MemberDescriptorType:
     def __qualname__(self) -> str: ...
     @property
     def __objclass__(self) -> type: ...
-    def __get__(self, instance: Any, owner: type | None = None, /) -> Any: ...
-    def __set__(self, instance: Any, value: Any, /) -> None: ...
-    def __delete__(self, instance: Any, /) -> None: ...
+    def __get__(self, instance: Any, owner: type | None = None, /) -> Any:
+        """Return an attribute of instance, which is of type owner."""
+        ...
+    def __set__(self, instance: Any, value: Any, /) -> None:
+        """Set an attribute of instance to value."""
+        ...
+    def __delete__(self, instance: Any, /) -> None:
+        """Delete an attribute of instance."""
+        ...
 
 def new_class(
     name: str,
@@ -581,19 +786,31 @@ if sys.version_info >= (3, 9):
         @property
         def __args__(self) -> tuple[Any, ...]: ...
         @property
-        def __parameters__(self) -> tuple[Any, ...]: ...
+        def __parameters__(self) -> tuple[Any, ...]:
+            """Type variables in the GenericAlias."""
+            ...
         def __new__(cls, origin: type, args: Any) -> Self: ...
-        def __getitem__(self, typeargs: Any, /) -> GenericAlias: ...
-        def __eq__(self, value: object, /) -> bool: ...
-        def __hash__(self) -> int: ...
+        def __getitem__(self, typeargs: Any, /) -> GenericAlias:
+            """Return self[key]."""
+            ...
+        def __eq__(self, value: object, /) -> bool:
+            """Return self==value."""
+            ...
+        def __hash__(self) -> int:
+            """Return hash(self)."""
+            ...
         if sys.version_info >= (3, 11):
             @property
             def __unpacked__(self) -> bool: ...
             @property
             def __typing_unpacked_tuple_args__(self) -> tuple[Any, ...] | None: ...
         if sys.version_info >= (3, 10):
-            def __or__(self, value: Any, /) -> UnionType: ...
-            def __ror__(self, value: Any, /) -> UnionType: ...
+            def __or__(self, value: Any, /) -> UnionType:
+                """Return self|value."""
+                ...
+            def __ror__(self, value: Any, /) -> UnionType:
+                """Return value|self."""
+                ...
 
         # GenericAlias delegates attr access to `__origin__`
         def __getattr__(self, name: str) -> Any: ...
@@ -601,7 +818,9 @@ if sys.version_info >= (3, 9):
 if sys.version_info >= (3, 10):
     @final
     class NoneType:
-        def __bool__(self) -> Literal[False]: ...
+        def __bool__(self) -> Literal[False]:
+            """True if self else False"""
+            ...
 
     @final
     class EllipsisType: ...
@@ -613,10 +832,18 @@ if sys.version_info >= (3, 10):
     class UnionType:
         @property
         def __args__(self) -> tuple[Any, ...]: ...
-        def __or__(self, value: Any, /) -> UnionType: ...
-        def __ror__(self, value: Any, /) -> UnionType: ...
-        def __eq__(self, value: object, /) -> bool: ...
-        def __hash__(self) -> int: ...
+        def __or__(self, value: Any, /) -> UnionType:
+            """Return self|value."""
+            ...
+        def __ror__(self, value: Any, /) -> UnionType:
+            """Return value|self."""
+            ...
+        def __eq__(self, value: object, /) -> bool:
+            """Return self==value."""
+            ...
+        def __hash__(self) -> int:
+            """Return hash(self)."""
+            ...
 
 if sys.version_info >= (3, 13):
     @final