basedpyright 1.12.6 → 1.13.0

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

@@ -1,3 +1,13 @@
+"""
+Operator interface.
+
+This module exports a set of functions implemented in C corresponding
+to the intrinsic operators of Python.  For example, operator.add(x, y)
+is equivalent to the expression x+y.  The function names are those
+used for special methods; variants without leading and trailing
+'__' are also provided for convenience.
+"""
+
 import sys
 from _typeshed import SupportsGetItem
 from collections.abc import Callable, Container, Iterable, MutableMapping, MutableSequence, Sequence
@@ -42,58 +52,159 @@ class _SupportsPos(Protocol[_T_co]):
     def __pos__(self) -> _T_co: ...
 
 # All four comparison functions must have the same signature, or we get false-positive errors
-def lt(a: _SupportsComparison, b: _SupportsComparison, /) -> Any: ...
-def le(a: _SupportsComparison, b: _SupportsComparison, /) -> Any: ...
-def eq(a: object, b: object, /) -> Any: ...
-def ne(a: object, b: object, /) -> Any: ...
-def ge(a: _SupportsComparison, b: _SupportsComparison, /) -> Any: ...
-def gt(a: _SupportsComparison, b: _SupportsComparison, /) -> Any: ...
-def not_(a: object, /) -> bool: ...
-def truth(a: object, /) -> bool: ...
-def is_(a: object, b: object, /) -> bool: ...
-def is_not(a: object, b: object, /) -> bool: ...
-def abs(a: SupportsAbs[_T], /) -> _T: ...
-def add(a: Any, b: Any, /) -> Any: ...
-def and_(a: Any, b: Any, /) -> Any: ...
-def floordiv(a: Any, b: Any, /) -> Any: ...
-def index(a: SupportsIndex, /) -> int: ...
-def inv(a: _SupportsInversion[_T_co], /) -> _T_co: ...
-def invert(a: _SupportsInversion[_T_co], /) -> _T_co: ...
-def lshift(a: Any, b: Any, /) -> Any: ...
-def mod(a: Any, b: Any, /) -> Any: ...
-def mul(a: Any, b: Any, /) -> Any: ...
-def matmul(a: Any, b: Any, /) -> Any: ...
-def neg(a: _SupportsNeg[_T_co], /) -> _T_co: ...
-def or_(a: Any, b: Any, /) -> Any: ...
-def pos(a: _SupportsPos[_T_co], /) -> _T_co: ...
-def pow(a: Any, b: Any, /) -> Any: ...
-def rshift(a: Any, b: Any, /) -> Any: ...
-def sub(a: Any, b: Any, /) -> Any: ...
-def truediv(a: Any, b: Any, /) -> Any: ...
-def xor(a: Any, b: Any, /) -> Any: ...
-def concat(a: Sequence[_T], b: Sequence[_T], /) -> Sequence[_T]: ...
-def contains(a: Container[object], b: object, /) -> bool: ...
-def countOf(a: Iterable[object], b: object, /) -> int: ...
+def lt(a: _SupportsComparison, b: _SupportsComparison, /) -> Any:
+    """Same as a < b."""
+    ...
+def le(a: _SupportsComparison, b: _SupportsComparison, /) -> Any:
+    """Same as a <= b."""
+    ...
+def eq(a: object, b: object, /) -> Any:
+    """Same as a == b."""
+    ...
+def ne(a: object, b: object, /) -> Any:
+    """Same as a != b."""
+    ...
+def ge(a: _SupportsComparison, b: _SupportsComparison, /) -> Any:
+    """Same as a >= b."""
+    ...
+def gt(a: _SupportsComparison, b: _SupportsComparison, /) -> Any:
+    """Same as a > b."""
+    ...
+def not_(a: object, /) -> bool:
+    """Same as not a."""
+    ...
+def truth(a: object, /) -> bool:
+    """Return True if a is true, False otherwise."""
+    ...
+def is_(a: object, b: object, /) -> bool:
+    """Same as a is b."""
+    ...
+def is_not(a: object, b: object, /) -> bool:
+    """Same as a is not b."""
+    ...
+def abs(a: SupportsAbs[_T], /) -> _T:
+    """Same as abs(a)."""
+    ...
+def add(a: Any, b: Any, /) -> Any:
+    """Same as a + b."""
+    ...
+def and_(a: Any, b: Any, /) -> Any:
+    """Same as a & b."""
+    ...
+def floordiv(a: Any, b: Any, /) -> Any:
+    """Same as a // b."""
+    ...
+def index(a: SupportsIndex, /) -> int:
+    """Same as a.__index__()"""
+    ...
+def inv(a: _SupportsInversion[_T_co], /) -> _T_co:
+    """Same as ~a."""
+    ...
+def invert(a: _SupportsInversion[_T_co], /) -> _T_co:
+    """Same as ~a."""
+    ...
+def lshift(a: Any, b: Any, /) -> Any:
+    """Same as a << b."""
+    ...
+def mod(a: Any, b: Any, /) -> Any:
+    """Same as a % b."""
+    ...
+def mul(a: Any, b: Any, /) -> Any:
+    """Same as a * b."""
+    ...
+def matmul(a: Any, b: Any, /) -> Any:
+    """Same as a @ b."""
+    ...
+def neg(a: _SupportsNeg[_T_co], /) -> _T_co:
+    """Same as -a."""
+    ...
+def or_(a: Any, b: Any, /) -> Any:
+    """Same as a | b."""
+    ...
+def pos(a: _SupportsPos[_T_co], /) -> _T_co:
+    """Same as +a."""
+    ...
+def pow(a: Any, b: Any, /) -> Any:
+    """Same as a ** b."""
+    ...
+def rshift(a: Any, b: Any, /) -> Any:
+    """Same as a >> b."""
+    ...
+def sub(a: Any, b: Any, /) -> Any:
+    """Same as a - b."""
+    ...
+def truediv(a: Any, b: Any, /) -> Any:
+    """Same as a / b."""
+    ...
+def xor(a: Any, b: Any, /) -> Any:
+    """Same as a ^ b."""
+    ...
+def concat(a: Sequence[_T], b: Sequence[_T], /) -> Sequence[_T]:
+    """Same as a + b, for a and b sequences."""
+    ...
+def contains(a: Container[object], b: object, /) -> bool:
+    """Same as b in a (note reversed operands)."""
+    ...
+def countOf(a: Iterable[object], b: object, /) -> int:
+    """Return the number of times b occurs in a."""
+    ...
 @overload
-def delitem(a: MutableSequence[Any], b: SupportsIndex, /) -> None: ...
+def delitem(a: MutableSequence[Any], b: SupportsIndex, /) -> None:
+    """Same as del a[b]."""
+    ...
 @overload
-def delitem(a: MutableSequence[Any], b: slice, /) -> None: ...
+def delitem(a: MutableSequence[Any], b: slice, /) -> None:
+    """Same as del a[b]."""
+    ...
 @overload
-def delitem(a: MutableMapping[_K, Any], b: _K, /) -> None: ...
+def delitem(a: MutableMapping[_K, Any], b: _K, /) -> None:
+    """Same as del a[b]."""
+    ...
 @overload
-def getitem(a: Sequence[_T], b: slice, /) -> Sequence[_T]: ...
+def getitem(a: Sequence[_T], b: slice, /) -> Sequence[_T]:
+    """Same as a[b]."""
+    ...
 @overload
-def getitem(a: SupportsGetItem[_K, _V], b: _K, /) -> _V: ...
-def indexOf(a: Iterable[_T], b: _T, /) -> int: ...
+def getitem(a: SupportsGetItem[_K, _V], b: _K, /) -> _V:
+    """Same as a[b]."""
+    ...
+def indexOf(a: Iterable[_T], b: _T, /) -> int:
+    """Return the first index of b in a."""
+    ...
 @overload
-def setitem(a: MutableSequence[_T], b: SupportsIndex, c: _T, /) -> None: ...
+def setitem(a: MutableSequence[_T], b: SupportsIndex, c: _T, /) -> None:
+    """Same as a[b] = c."""
+    ...
 @overload
-def setitem(a: MutableSequence[_T], b: slice, c: Sequence[_T], /) -> None: ...
+def setitem(a: MutableSequence[_T], b: slice, c: Sequence[_T], /) -> None:
+    """Same as a[b] = c."""
+    ...
 @overload
-def setitem(a: MutableMapping[_K, _V], b: _K, c: _V, /) -> None: ...
-def length_hint(obj: object, default: int = 0, /) -> int: ...
+def setitem(a: MutableMapping[_K, _V], b: _K, c: _V, /) -> None:
+    """Same as a[b] = c."""
+    ...
+def length_hint(obj: object, default: int = 0, /) -> int:
+    """
+    Return an estimate of the number of items in obj.
+
+    This is useful for presizing containers when building from an iterable.
+
+    If the object supports len(), the result will be exact.
+    Otherwise, it may over- or under-estimate by an arbitrary amount.
+    The result will be an integer >= 0.
+    """
+    ...
 @final
 class attrgetter(Generic[_T_co]):
+    """
+    attrgetter(attr, ...) --> attrgetter object
+
+    Return a callable object that fetches the given attribute(s) from its operand.
+    After f = attrgetter('name'), the call f(r) returns r.name.
+    After g = attrgetter('name', 'date'), the call g(r) returns (r.name, r.date).
+    After h = attrgetter('name.first', 'name.last'), the call h(r) returns
+    (r.name.first, r.name.last).
+    """
     @overload
     def __new__(cls, attr: str, /) -> attrgetter[Any]: ...
     @overload
@@ -104,10 +215,19 @@ class attrgetter(Generic[_T_co]):
     def __new__(cls, attr: str, attr2: str, attr3: str, attr4: str, /) -> attrgetter[tuple[Any, Any, Any, Any]]: ...
     @overload
     def __new__(cls, attr: str, /, *attrs: str) -> attrgetter[tuple[Any, ...]]: ...
-    def __call__(self, obj: Any, /) -> _T_co: ...
+    def __call__(self, obj: Any, /) -> _T_co:
+        """Call self as a function."""
+        ...
 
 @final
 class itemgetter(Generic[_T_co]):
+    """
+    itemgetter(item, ...) --> itemgetter object
+
+    Return a callable object that fetches the given item(s) from its operand.
+    After f = itemgetter(2), the call f(r) returns r[2].
+    After g = itemgetter(2, 5, 3), the call g(r) returns (r[2], r[5], r[3])
+    """
     @overload
     def __new__(cls, item: _T, /) -> itemgetter[_T]: ...
     @overload
@@ -119,29 +239,85 @@ class itemgetter(Generic[_T_co]):
     #
     # A suspected mypy issue prevents using [..., _T] instead of [..., Any] here.
     # https://github.com/python/mypy/issues/14032
-    def __call__(self, obj: SupportsGetItem[Any, Any]) -> Any: ...
+    def __call__(self, obj: SupportsGetItem[Any, Any]) -> Any:
+        """Call self as a function."""
+        ...
 
 @final
 class methodcaller:
+    """
+    methodcaller(name, ...) --> methodcaller object
+
+    Return a callable object that calls the given method on its operand.
+    After f = methodcaller('name'), the call f(r) returns r.name().
+    After g = methodcaller('name', 'date', foo=1), the call g(r) returns
+    r.name('date', foo=1).
+    """
     def __init__(self, name: str, /, *args: Any, **kwargs: Any) -> None: ...
-    def __call__(self, obj: Any) -> Any: ...
-
-def iadd(a: Any, b: Any, /) -> Any: ...
-def iand(a: Any, b: Any, /) -> Any: ...
-def iconcat(a: Any, b: Any, /) -> Any: ...
-def ifloordiv(a: Any, b: Any, /) -> Any: ...
-def ilshift(a: Any, b: Any, /) -> Any: ...
-def imod(a: Any, b: Any, /) -> Any: ...
-def imul(a: Any, b: Any, /) -> Any: ...
-def imatmul(a: Any, b: Any, /) -> Any: ...
-def ior(a: Any, b: Any, /) -> Any: ...
-def ipow(a: Any, b: Any, /) -> Any: ...
-def irshift(a: Any, b: Any, /) -> Any: ...
-def isub(a: Any, b: Any, /) -> Any: ...
-def itruediv(a: Any, b: Any, /) -> Any: ...
-def ixor(a: Any, b: Any, /) -> Any: ...
+    def __call__(self, obj: Any) -> Any:
+        """Call self as a function."""
+        ...
+
+def iadd(a: Any, b: Any, /) -> Any:
+    """Same as a += b."""
+    ...
+def iand(a: Any, b: Any, /) -> Any:
+    """Same as a &= b."""
+    ...
+def iconcat(a: Any, b: Any, /) -> Any:
+    """Same as a += b, for a and b sequences."""
+    ...
+def ifloordiv(a: Any, b: Any, /) -> Any:
+    """Same as a //= b."""
+    ...
+def ilshift(a: Any, b: Any, /) -> Any:
+    """Same as a <<= b."""
+    ...
+def imod(a: Any, b: Any, /) -> Any:
+    """Same as a %= b."""
+    ...
+def imul(a: Any, b: Any, /) -> Any:
+    """Same as a *= b."""
+    ...
+def imatmul(a: Any, b: Any, /) -> Any:
+    """Same as a @= b."""
+    ...
+def ior(a: Any, b: Any, /) -> Any:
+    """Same as a |= b."""
+    ...
+def ipow(a: Any, b: Any, /) -> Any:
+    """Same as a **= b."""
+    ...
+def irshift(a: Any, b: Any, /) -> Any:
+    """Same as a >>= b."""
+    ...
+def isub(a: Any, b: Any, /) -> Any:
+    """Same as a -= b."""
+    ...
+def itruediv(a: Any, b: Any, /) -> Any:
+    """Same as a /= b."""
+    ...
+def ixor(a: Any, b: Any, /) -> Any:
+    """Same as a ^= b."""
+    ...
 
 if sys.version_info >= (3, 11):
-    def call(obj: Callable[_P, _R], /, *args: _P.args, **kwargs: _P.kwargs) -> _R: ...
+    def call(obj: Callable[_P, _R], /, *args: _P.args, **kwargs: _P.kwargs) -> _R:
+        """Same as obj(*args, **kwargs)."""
+        ...
+
+def _compare_digest(a: AnyStr, b: AnyStr, /) -> bool:
+    """
+    Return 'a == b'.
+
+    This function uses an approach designed to prevent
+    timing analysis, making it appropriate for cryptography.
+
+    a and b must both be of the same type: either str (ASCII only),
+    or any bytes-like object.
 
-def _compare_digest(a: AnyStr, b: AnyStr, /) -> bool: ...
+    Note: If a and b are of different lengths, or if an error occurs,
+    a timing attack could theoretically reveal information about the
+    types and lengths of a and b--but not their values.
+    """
+    ...

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

@@ -1,3 +1,5 @@
+"""A POSIX helper for the subprocess module."""
+
 import sys
 from _typeshed import StrOrBytesPath
 from collections.abc import Callable, Sequence
@@ -30,4 +32,26 @@ if sys.platform != "win32":
         preexec_fn: Callable[[], None],
         allow_vfork: bool,
         /,
-    ) -> int: ...
+    ) -> int:
+        """
+        fork_exec(args, executable_list, close_fds, cwd, env,
+                  p2cread, p2cwrite, c2pread, c2pwrite,
+                  errread, errwrite, errpipe_read, errpipe_write,
+                  restore_signals, call_setsid, preexec_fn)
+
+        Forks a child process, closes parent file descriptors as appropriate in the
+        child and dups the few that are needed before calling exec() in the child
+        process.
+
+        The preexec_fn, if supplied, will be called immediately before exec.
+        WARNING: preexec_fn is NOT SAFE if your application uses threads.
+                 It may trigger infrequent, difficult to debug deadlocks.
+
+        If an error occurs in the child process before the exec, it is
+        serialized and written to the errpipe_write fd per subprocess.py.
+
+        Returns: the child process's PID.
+
+        Raises: Only on an error in the parent process.
+        """
+        ...

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

@@ -1,12 +1,30 @@
+"""Module implements the Mersenne Twister random number generator."""
+
 from typing_extensions import TypeAlias
 
 # Actually Tuple[(int,) * 625]
 _State: TypeAlias = tuple[int, ...]
 
 class Random:
+    """Random() -> create a random number generator with its own internal state."""
     def __init__(self, seed: object = ...) -> None: ...
-    def seed(self, n: object = None, /) -> None: ...
-    def getstate(self) -> _State: ...
-    def setstate(self, state: _State, /) -> None: ...
-    def random(self) -> float: ...
-    def getrandbits(self, k: int, /) -> int: ...
+    def seed(self, n: object = None, /) -> None:
+        """
+        seed([n]) -> None.
+
+        Defaults to use urandom and falls back to a combination
+        of the current time and the process identifier.
+        """
+        ...
+    def getstate(self) -> _State:
+        """getstate() -> tuple containing the current state."""
+        ...
+    def setstate(self, state: _State, /) -> None:
+        """setstate(state) -> None.  Restores generator state."""
+        ...
+    def random(self) -> float:
+        """random() -> x in the interval [0, 1)."""
+        ...
+    def getrandbits(self, k: int, /) -> int:
+        """getrandbits(k) -> x.  Generates an int with k random bits."""
+        ...