basedpyright 1.13.2 → 1.13.3

package/dist/typeshed-fallback/stdlib/multiprocessing/pool.pyi

@@ -21,7 +21,13 @@ class ApplyResult(Generic[_T]):
     def ready(self) -> bool: ...
     def successful(self) -> bool: ...
     if sys.version_info >= (3, 9):
-        def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
+        def __class_getitem__(cls, item: Any, /) -> GenericAlias:
+            """
+            Represent a PEP 585 generic type
+
+            E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
+            """
+            ...
 
 # alias created during issue #17805
 AsyncResult = ApplyResult

package/dist/typeshed-fallback/stdlib/multiprocessing/popen_spawn_win32.pyi

@@ -1,30 +1,30 @@
-import sys
-from multiprocessing.process import BaseProcess
-from typing import ClassVar
-
-from .util import Finalize
-
-if sys.platform == "win32":
-    __all__ = ["Popen"]
-
-    TERMINATE: int
-    WINEXE: bool
-    WINSERVICE: bool
-    WINENV: bool
-
-    class Popen:
-        finalizer: Finalize
-        method: ClassVar[str]
-        pid: int
-        returncode: int | None
-        sentinel: int
-
-        def __init__(self, process_obj: BaseProcess) -> None: ...
-        def duplicate_for_child(self, handle: int) -> int: ...
-        def wait(self, timeout: float | None = None) -> int | None: ...
-        def poll(self) -> int | None: ...
-        def terminate(self) -> None: ...
-
-        kill = terminate
-
-        def close(self) -> None: ...
+import sys
+from multiprocessing.process import BaseProcess
+from typing import ClassVar
+
+from .util import Finalize
+
+if sys.platform == "win32":
+    __all__ = ["Popen"]
+
+    TERMINATE: int
+    WINEXE: bool
+    WINSERVICE: bool
+    WINENV: bool
+
+    class Popen:
+        finalizer: Finalize
+        method: ClassVar[str]
+        pid: int
+        returncode: int | None
+        sentinel: int
+
+        def __init__(self, process_obj: BaseProcess) -> None: ...
+        def duplicate_for_child(self, handle: int) -> int: ...
+        def wait(self, timeout: float | None = None) -> int | None: ...
+        def poll(self) -> int | None: ...
+        def terminate(self) -> None: ...
+
+        kill = terminate
+
+        def close(self) -> None: ...

package/dist/typeshed-fallback/stdlib/multiprocessing/process.pyi

@@ -26,13 +26,24 @@ class BaseProcess:
     def join(self, timeout: float | None = None) -> None: ...
     def is_alive(self) -> bool: ...
     @property
-    def exitcode(self) -> int | None: ...
+    def exitcode(self) -> int | None:
+        """Return exit code of process or `None` if it has yet to stop"""
+        ...
     @property
-    def ident(self) -> int | None: ...
+    def ident(self) -> int | None:
+        """Return identifier (PID) of process or `None` if it has yet to start"""
+        ...
     @property
-    def pid(self) -> int | None: ...
+    def pid(self) -> int | None:
+        """Return identifier (PID) of process or `None` if it has yet to start"""
+        ...
     @property
-    def sentinel(self) -> int: ...
+    def sentinel(self) -> int:
+        """
+        Return a file descriptor (Unix) or handle (Windows) suitable for
+        waiting for process termination.
+        """
+        ...
 
 def current_process() -> BaseProcess: ...
 def active_children() -> list[BaseProcess]: ...

package/dist/typeshed-fallback/stdlib/multiprocessing/queues.pyi

@@ -23,7 +23,13 @@ class Queue(Generic[_T]):
     def join_thread(self) -> None: ...
     def cancel_join_thread(self) -> None: ...
     if sys.version_info >= (3, 12):
-        def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
+        def __class_getitem__(cls, item: Any, /) -> GenericAlias:
+            """
+            Represent a PEP 585 generic type
+
+            E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
+            """
+            ...
 
 class JoinableQueue(Queue[_T]):
     def task_done(self) -> None: ...
@@ -38,4 +44,10 @@ class SimpleQueue(Generic[_T]):
     def get(self) -> _T: ...
     def put(self, obj: _T) -> None: ...
     if sys.version_info >= (3, 9):
-        def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
+        def __class_getitem__(cls, item: Any, /) -> GenericAlias:
+            """
+            Represent a PEP 585 generic type
+
+            E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
+            """
+            ...

package/dist/typeshed-fallback/stdlib/multiprocessing/shared_memory.pyi

@@ -17,11 +17,17 @@ class SharedMemory:
         def __init__(self, name: str | None = None, create: bool = False, size: int = 0) -> None: ...
 
     @property
-    def buf(self) -> memoryview: ...
+    def buf(self) -> memoryview:
+        """A memoryview of contents of the shared memory block."""
+        ...
     @property
-    def name(self) -> str: ...
+    def name(self) -> str:
+        """Unique name that identifies the shared memory block."""
+        ...
     @property
-    def size(self) -> int: ...
+    def size(self) -> int:
+        """Size in bytes."""
+        ...
     def close(self) -> None: ...
     def unlink(self) -> None: ...
     def __del__(self) -> None: ...
@@ -37,8 +43,16 @@ class ShareableList(Generic[_SLT]):
     def __reduce__(self) -> tuple[Self, tuple[_SLT, ...]]: ...
     def __len__(self) -> int: ...
     @property
-    def format(self) -> str: ...
+    def format(self) -> str:
+        """The struct packing format used by all currently stored values."""
+        ...
     def count(self, value: _SLT) -> int: ...
     def index(self, value: _SLT) -> int: ...
     if sys.version_info >= (3, 9):
-        def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
+        def __class_getitem__(cls, item: Any, /) -> GenericAlias:
+            """
+            Represent a PEP 585 generic type
+
+            E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
+            """
+            ...

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

@@ -1,9 +1,36 @@
+"""This module contains functions for accessing NIS maps."""
+
 import sys
 
 if sys.platform != "win32":
-    def cat(map: str, domain: str = ...) -> dict[str, str]: ...
-    def get_default_domain() -> str: ...
-    def maps(domain: str = ...) -> list[str]: ...
-    def match(key: str, map: str, domain: str = ...) -> str: ...
+    def cat(map: str, domain: str = ...) -> dict[str, str]:
+        """
+        cat(map, domain = defaultdomain)
+        Returns the entire map as a dictionary. Optionally domain can be
+        specified but it defaults to the system default domain.
+        """
+        ...
+    def get_default_domain() -> str:
+        """
+        get_default_domain() -> str
+        Corresponds to the C library yp_get_default_domain() call, returning
+        the default NIS domain.
+        """
+        ...
+    def maps(domain: str = ...) -> list[str]:
+        """
+        maps(domain = defaultdomain)
+        Returns an array of all available NIS maps within a domain. If domain
+        is not specified it defaults to the system default domain.
+        """
+        ...
+    def match(key: str, map: str, domain: str = ...) -> str:
+        """
+        match(key, map, domain = defaultdomain)
+        Corresponds to the C library yp_match() call, returning the value of
+        key in the given map. Optionally domain can be specified but it
+        defaults to the system default domain.
+        """
+        ...
 
     class error(Exception): ...

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

@@ -70,10 +70,22 @@ class Complex(Number, _ComplexLike):
     def __bool__(self) -> bool: ...
     @property
     @abstractmethod
-    def real(self) -> _RealLike: ...
+    def real(self) -> _RealLike:
+        """
+        Retrieve the real component of this number.
+
+        This should subclass Real.
+        """
+        ...
     @property
     @abstractmethod
-    def imag(self) -> _RealLike: ...
+    def imag(self) -> _RealLike:
+        """
+        Retrieve the imaginary component of this number.
+
+        This should subclass Real.
+        """
+        ...
     @abstractmethod
     def __add__(self, other) -> _ComplexLike: ...
     @abstractmethod
@@ -136,9 +148,13 @@ class Real(Complex, _RealLike):
     def __le__(self, other) -> bool: ...
     def __complex__(self) -> complex: ...
     @property
-    def real(self) -> _RealLike: ...
+    def real(self) -> _RealLike:
+        """Real numbers are their real component."""
+        ...
     @property
-    def imag(self) -> Literal[0]: ...
+    def imag(self) -> Literal[0]:
+        """Real numbers have no imaginary component."""
+        ...
     def conjugate(self) -> _RealLike: ...
     # Not actually overridden at runtime,
     # but we override these in the stub to give them more precise return types:
@@ -190,9 +206,13 @@ class Integral(Rational, _IntegralLike):
     def __invert__(self) -> _IntegralLike: ...
     def __float__(self) -> float: ...
     @property
-    def numerator(self) -> _IntegralLike: ...
+    def numerator(self) -> _IntegralLike:
+        """Integers are their own numerators."""
+        ...
     @property
-    def denominator(self) -> Literal[1]: ...
+    def denominator(self) -> Literal[1]:
+        """Integers have a denominator of 1."""
+        ...
     # Not actually overridden at runtime,
     # but we override these in the stub to give them more precise return types:
     @abstractmethod

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

@@ -60,4 +60,6 @@ opmap: dict[str, int]
 HAVE_ARGUMENT: int
 EXTENDED_ARG: int
 
-def stack_effect(opcode: int, oparg: int | None = None, /, *, jump: bool | None = None) -> int: ...
+def stack_effect(opcode: int, oparg: int | None = None, /, *, jump: bool | None = None) -> int:
+    """Compute the stack effect of the opcode."""
+    ...

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

@@ -183,7 +183,9 @@ class Values:
     def read_file(self, filename: str, mode: str = "careful") -> None: ...
     def read_module(self, modname: str, mode: str = "careful") -> None: ...
     def __getattr__(self, name: str): ...
-    def __setattr__(self, name: str, value, /) -> None: ...
+    def __setattr__(self, name: str, value, /) -> None:
+        """Implement setattr(self, name, value)."""
+        ...
     def __eq__(self, other: object) -> bool: ...
 
 class OptionParser(OptionContainer):