basedpyright 1.40.1 → 1.40.2

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

@@ -1,4 +1,4 @@
-"""_blake2b provides BLAKE2b for hashlib"""
+"""_blake2 provides BLAKE2b and BLAKE2s for hashlib"""
 
 import sys
 from _typeshed import ReadableBuffer

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

@@ -910,10 +910,11 @@ def typeahead(fd: int, /) -> None:
     ...
 def unctrl(ch: _ChType, /) -> bytes:
     """
-    Return a string which is a printable representation of the character ch.
+    Return a bytes object which is a printable representation of ch.
 
-    Control characters are displayed as a caret followed by the character,
-    for example as ^C.  Printing characters are left as they are.
+    Control characters are displayed as a caret followed by the
+    character, for example as ^C.  Printing characters are left as they
+    are.  Any attributes and color pair are ignored.
     """
     ...
 def unget_wch(ch: int | str, /) -> None:
@@ -954,10 +955,18 @@ def use_env(flag: bool, /) -> None:
     """
     ...
 
-class error(Exception): ...
+class error(Exception):
+    """Exception raised when a curses library function returns an error."""
+    ...
 
 @final
 class window:  # undocumented
+    """
+    A curses window.
+
+    Window objects are returned by initscr() and newwin(), and by the
+    methods that create subwindows and pads.
+    """
     encoding: str
 
     @overload
@@ -1412,34 +1421,48 @@ class window:  # undocumented
     def getch(self) -> int:
         """
         getch([y, x])
-        Get a character code from terminal keyboard.
+        Read a key press and return it as an integer.
 
           y
             Y-coordinate.
           x
             X-coordinate.
 
-        The integer returned does not have to be in ASCII range: function
-        keys, keypad keys and so on return numbers higher than 256.  In
-        no-delay mode, -1 is returned if there is no input, else getch()
-        waits until a key is pressed.
+        Wait until a key is pressed, or return -1 if the read is
+        non-blocking or times out.
+
+        An ordinary key is returned as the code of a single byte of its
+        encoding in the current locale, so a character encoded with several
+        bytes takes several calls.  Use get_wch() to read it as a single
+        character.
+
+        In keypad mode function keys and other special keys are returned as
+        one of the KEY_* constants, which cannot be mistaken for an ordinary
+        key.  Otherwise their bytes are returned one at a time.
         """
         ...
     @overload
     def getch(self, y: int, x: int) -> int:
         """
         getch([y, x])
-        Get a character code from terminal keyboard.
+        Read a key press and return it as an integer.
 
           y
             Y-coordinate.
           x
             X-coordinate.
 
-        The integer returned does not have to be in ASCII range: function
-        keys, keypad keys and so on return numbers higher than 256.  In
-        no-delay mode, -1 is returned if there is no input, else getch()
-        waits until a key is pressed.
+        Wait until a key is pressed, or return -1 if the read is
+        non-blocking or times out.
+
+        An ordinary key is returned as the code of a single byte of its
+        encoding in the current locale, so a character encoded with several
+        bytes takes several calls.  Use get_wch() to read it as a single
+        character.
+
+        In keypad mode function keys and other special keys are returned as
+        one of the KEY_* constants, which cannot be mistaken for an ordinary
+        key.  Otherwise their bytes are returned one at a time.
         """
         ...
 
@@ -1447,30 +1470,38 @@ class window:  # undocumented
     def get_wch(self) -> int | str:
         """
         get_wch([y, x])
-        Get a wide character from terminal keyboard.
+        Read a key press and return it as a one-character str.
 
           y
             Y-coordinate.
           x
             X-coordinate.
 
-        Return a character for most keys, or an integer for function keys,
-        keypad keys, and other special keys.
+        Wait until a key is pressed, or raise curses.error if the read is
+        non-blocking or times out.
+
+        In keypad mode function keys and other special keys are returned as
+        one of the KEY_* constants, an integer.  Otherwise their characters
+        are returned one at a time.
         """
         ...
     @overload
     def get_wch(self, y: int, x: int) -> int | str:
         """
         get_wch([y, x])
-        Get a wide character from terminal keyboard.
+        Read a key press and return it as a one-character str.
 
           y
             Y-coordinate.
           x
             X-coordinate.
 
-        Return a character for most keys, or an integer for function keys,
-        keypad keys, and other special keys.
+        Wait until a key is pressed, or raise curses.error if the read is
+        non-blocking or times out.
+
+        In keypad mode function keys and other special keys are returned as
+        one of the KEY_* constants, an integer.  Otherwise their characters
+        are returned one at a time.
         """
         ...
 
@@ -1478,34 +1509,34 @@ class window:  # undocumented
     def getkey(self) -> str:
         """
         getkey([y, x])
-        Get a character (string) from terminal keyboard.
+        Read a key press and return it as a str.
 
           y
             Y-coordinate.
           x
             X-coordinate.
 
-        Returning a string instead of an integer, as getch() does.  Function
-        keys, keypad keys and other special keys return a multibyte string
-        containing the key name.  In no-delay mode, an exception is raised
-        if there is no input.
+        Read as getch() does, but return an ordinary key as a one-character
+        string, the byte decoded as Latin-1, and a special key as its name,
+        such as 'KEY_UP'.  Raise curses.error instead of returning -1 if
+        there is no input.
         """
         ...
     @overload
     def getkey(self, y: int, x: int) -> str:
         """
         getkey([y, x])
-        Get a character (string) from terminal keyboard.
+        Read a key press and return it as a str.
 
           y
             Y-coordinate.
           x
             X-coordinate.
 
-        Returning a string instead of an integer, as getch() does.  Function
-        keys, keypad keys and other special keys return a multibyte string
-        containing the key name.  In no-delay mode, an exception is raised
-        if there is no input.
+        Read as getch() does, but return an ordinary key as a one-character
+        string, the byte decoded as Latin-1, and a special key as its name,
+        such as 'KEY_UP'.  Raise curses.error instead of returning -1 if
+        there is no input.
         """
         ...
 
@@ -1520,56 +1551,56 @@ class window:  # undocumented
     def getstr(self) -> bytes:
         """
         getstr([[y, x,] n=2047])
-        Read a string from the user, with primitive line editing capacity.
+        Read a line of input and return it as a bytes object.
 
           y
             Y-coordinate.
           x
             X-coordinate.
           n
-            Maximal number of characters.
+            Maximal number of bytes.
         """
         ...
     @overload
     def getstr(self, n: int) -> bytes:
         """
         getstr([[y, x,] n=2047])
-        Read a string from the user, with primitive line editing capacity.
+        Read a line of input and return it as a bytes object.
 
           y
             Y-coordinate.
           x
             X-coordinate.
           n
-            Maximal number of characters.
+            Maximal number of bytes.
         """
         ...
     @overload
     def getstr(self, y: int, x: int) -> bytes:
         """
         getstr([[y, x,] n=2047])
-        Read a string from the user, with primitive line editing capacity.
+        Read a line of input and return it as a bytes object.
 
           y
             Y-coordinate.
           x
             X-coordinate.
           n
-            Maximal number of characters.
+            Maximal number of bytes.
         """
         ...
     @overload
     def getstr(self, y: int, x: int, n: int) -> bytes:
         """
         getstr([[y, x,] n=2047])
-        Read a string from the user, with primitive line editing capacity.
+        Read a line of input and return it as a bytes object.
 
           y
             Y-coordinate.
           x
             X-coordinate.
           n
-            Maximal number of characters.
+            Maximal number of bytes.
         """
         ...
 
@@ -1801,42 +1832,38 @@ class window:  # undocumented
     def instr(self, n: int = 2047) -> bytes:
         """
         instr([y, x,] n=2047)
-        Return a string of characters, extracted from the window.
+        Return the text of the window as a bytes object.
 
           y
             Y-coordinate.
           x
             X-coordinate.
           n
-            Maximal number of characters.
+            Maximal number of bytes.
 
-        Return a string of characters, extracted from the window starting
-        at the current cursor position, or at y, x if specified, and
-        stopping at the end of the line.  Attributes and color
-        information are stripped from the characters.  If n is specified,
-        instr() returns a string at most n characters long (exclusive of
-        the trailing NUL).
+        Read from the current cursor position, or from y, x if specified, to
+        the end of the line, and return the text in the encoding of the
+        current locale, with attributes and color pairs stripped.  At most n
+        bytes are read.
         """
         ...
     @overload
     def instr(self, y: int, x: int, n: int = 2047) -> bytes:
         """
         instr([y, x,] n=2047)
-        Return a string of characters, extracted from the window.
+        Return the text of the window as a bytes object.
 
           y
             Y-coordinate.
           x
             X-coordinate.
           n
-            Maximal number of characters.
+            Maximal number of bytes.
 
-        Return a string of characters, extracted from the window starting
-        at the current cursor position, or at y, x if specified, and
-        stopping at the end of the line.  Attributes and color
-        information are stripped from the characters.  If n is specified,
-        instr() returns a string at most n characters long (exclusive of
-        the trailing NUL).
+        Read from the current cursor position, or from y, x if specified, to
+        the end of the line, and return the text in the encoding of the
+        current locale, with attributes and color pairs stripped.  At most n
+        bytes are read.
         """
         ...
 

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

@@ -4,10 +4,17 @@ from typing import Final, final
 __version__: Final[str]
 version: Final[str]
 
-class error(Exception): ...
+class error(Exception):
+    """Exception raised when a curses panel library function returns an error."""
+    ...
 
 @final
 class panel:
+    """
+    A curses panel.
+
+    Panel objects are returned by new_panel().
+    """
     def above(self) -> panel:
         """Return the panel above the current panel."""
         ...

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

@@ -68,9 +68,11 @@ if sys.version_info >= (3, 11):
         flags: dict[_TrapType, bool] | None = None,
     ) -> _ContextManager:
         """
-        Return a context manager that will set the default context to a copy of ctx
-        on entry to the with-statement and restore the previous default context when
-        exiting the with-statement. If no context is specified, a copy of the current
+        Return a context manager for a copy of the supplied context.
+
+        That will set the default context to a copy of ctx on entry to the
+        with-statement and restore the previous default context when exiting
+        the with-statement. If no context is specified, a copy of the current
         default context is used.
         """
         ...
@@ -88,9 +90,10 @@ else:
 if sys.version_info >= (3, 14):
     def IEEEContext(bits: int, /) -> Context:
         """
-        Return a context object initialized to the proper values for one of the
-        IEEE interchange formats.  The argument must be a multiple of 32 and less
-        than IEEE_CONTEXT_MAX_BITS.
+        Return a context, initialized as one of the IEEE interchange formats.
+
+        The argument must be a multiple of 32 and less than
+        IEEE_CONTEXT_MAX_BITS.
         """
         ...
 

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

@@ -15,15 +15,22 @@ class QueueNotFoundError(QueueError): ...
 
 def bind(qid: SupportsIndex) -> None:
     """
-    bind(qid)
-
     Take a reference to the identified queue.
+
     The queue is not destroyed until there are no references left.
     """
     ...
 
 if sys.version_info >= (3, 15):
-    def create(maxsize: SupportsIndex, unboundop: SupportsIndex = -1, fallback: SupportsIndex = -1) -> int: ...
+    def create(maxsize: SupportsIndex, unboundop: SupportsIndex = -1, fallback: SupportsIndex = -1) -> int:
+        """
+        Create a new cross-interpreter queue and return its unique generated ID.
+
+        It is a new reference as though bind() had been called on the queue.
+        The caller is responsible for calling destroy() for the new queue
+        before the runtime is finalized.
+        """
+        ...
 
 else:
     def create(maxsize: SupportsIndex, fmt: SupportsIndex, unboundop: _UnboundOp) -> int:
@@ -40,61 +47,43 @@ else:
 
 def destroy(qid: SupportsIndex) -> None:
     """
-    destroy(qid)
+    Clear and destroy the queue.
 
-    Clear and destroy the queue.  Afterward attempts to use the queue
-    will behave as though it never existed.
+    Afterward attempts to use the queue will behave as though it never
+    existed.
     """
     ...
 def get(qid: SupportsIndex) -> tuple[Any, int, _UnboundOp | None]:
     """
-    get(qid) -> (obj, unboundop)
-
-    Return a new object from the data at the front of the queue.
-    The unbound op is also returned.
+    Return the (object, unbound op) from the front of the queue.
 
     If there is nothing to receive then raise QueueEmpty.
     """
     ...
 def get_count(qid: SupportsIndex) -> int:
-    """
-    get_count(qid)
-
-    Return the number of items in the queue.
-    """
+    """Return the number of items in the queue."""
     ...
 def get_maxsize(qid: SupportsIndex) -> int:
-    """
-    get_maxsize(qid)
-
-    Return the maximum number of items in the queue.
-    """
+    """Return the maximum number of items in the queue."""
     ...
 def get_queue_defaults(qid: SupportsIndex) -> tuple[int, _UnboundOp]:
-    """
-    get_queue_defaults(qid)
-
-    Return the queue's default values, set when it was created.
-    """
+    """Return the queue's default values, set when it was created."""
     ...
 def is_full(qid: SupportsIndex) -> bool:
-    """
-    is_full(qid)
-
-    Return true if the queue has a maxsize and has reached it.
-    """
+    """Return true if the queue has a maxsize and has reached it."""
     ...
 def list_all() -> list[tuple[int, int, _UnboundOp]]:
     """
-    list_all() -> [(qid, unboundop, fallback)]
+    Return the list of ID triples for all queues.
 
-    Return the list of IDs for all queues.
-    Each corresponding default unbound op and fallback is also included.
+    Each ID triple consists of (ID, default unbound op, default fallback).
     """
     ...
 
 if sys.version_info >= (3, 15):
-    def put(qid: SupportsIndex, obj: Any, unboundop: SupportsIndex = -1, fallback: SupportsIndex = -1) -> None: ...
+    def put(qid: SupportsIndex, obj: Any, unboundop: SupportsIndex = -1, fallback: SupportsIndex = -1) -> None:
+        """Add the object's data to the queue."""
+        ...
 
 else:
     def put(qid: SupportsIndex, obj: Any, fmt: SupportsIndex, unboundop: _UnboundOp) -> None:
@@ -107,9 +96,8 @@ else:
 
 def release(qid: SupportsIndex) -> None:
     """
-    release(qid)
-
     Release a reference to the queue.
+
     The queue is destroyed once there are no references left.
     """
     ...

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

@@ -29,8 +29,6 @@ class CrossInterpreterBufferView:
 
 def new_config(name: _Configs = "isolated", /, **overides: object) -> types.SimpleNamespace:
     """
-    new_config(name='isolated', /, **overrides) -> type.SimpleNamespace
-
     Return a representation of a new PyInterpreterConfig.
 
     The name determines the initial values of the config.  Supported named
@@ -42,24 +40,20 @@ def new_config(name: _Configs = "isolated", /, **overides: object) -> types.Simp
     ...
 def create(config: types.SimpleNamespace | _Configs | None = "isolated", *, reqrefs: bool = False) -> int:
     """
-    create([config], *, reqrefs=False) -> ID
-
     Create a new interpreter and return a unique generated ID.
 
     The caller is responsible for destroying the interpreter before exiting,
-    typically by using _interpreters.destroy().  This can be managed 
+    typically by using _interpreters.destroy().  This can be managed
     automatically by passing "reqrefs=True" and then using _incref() and
     _decref() appropriately.
 
     "config" must be a valid interpreter config or the name of a
-    predefined config ("isolated" or "legacy").  The default
-    is "isolated".
+    predefined config ('isolated' or 'legacy').  The default
+    is 'isolated'.
     """
     ...
 def destroy(id: SupportsIndex, *, restrict: bool = False) -> None:
     """
-    destroy(id, *, restrict=False)
-
     Destroy the identified interpreter.
 
     Attempting to destroy the current interpreter raises InterpreterError.
@@ -67,54 +61,29 @@ def destroy(id: SupportsIndex, *, restrict: bool = False) -> None:
     """
     ...
 def list_all(*, require_ready: bool = False) -> list[tuple[int, _Whence]]:
-    """
-    list_all() -> [(ID, whence)]
-
-    Return a list containing the ID of every existing interpreter.
-    """
+    """Return a list containing the ID of every existing interpreter."""
     ...
 def get_current() -> tuple[int, _Whence]:
-    """
-    get_current() -> (ID, whence)
-
-    Return the ID of current interpreter.
-    """
+    """Return (ID, whence) of the current interpreter."""
     ...
 def get_main() -> tuple[int, _Whence]:
-    """
-    get_main() -> (ID, whence)
-
-    Return the ID of main interpreter.
-    """
+    """Return (ID, whence) of the main interpreter."""
     ...
 def is_running(id: SupportsIndex, *, restrict: bool = False) -> bool:
-    """
-    is_running(id, *, restrict=False) -> bool
-
-    Return whether or not the identified interpreter is running.
-    """
+    """Return whether or not the identified interpreter is running."""
     ...
 def get_config(id: SupportsIndex, *, restrict: bool = False) -> types.SimpleNamespace:
-    """
-    get_config(id, *, restrict=False) -> types.SimpleNamespace
-
-    Return a representation of the config used to initialize the interpreter.
-    """
+    """Return a representation of the config used to initialize the interpreter."""
     ...
 def whence(id: SupportsIndex) -> _Whence:
-    """
-    whence(id) -> int
-
-    Return an identifier for where the interpreter was created.
-    """
+    """Return an identifier for where the interpreter was created."""
     ...
 def exec(
     id: SupportsIndex, code: str | types.CodeType | Callable[[], object], shared: _SharedDict = {}, *, restrict: bool = False
 ) -> None | types.SimpleNamespace:
     """
-    exec(id, code, shared=None, *, restrict=False)
-
     Execute the provided code in the identified interpreter.
+
     This is equivalent to running the builtin exec() under the target
     interpreter, using the __dict__ of its __main__ module as both
     globals and locals.
@@ -139,9 +108,8 @@ def call(
     restrict: bool = False,
 ) -> tuple[_R, types.SimpleNamespace]:
     """
-    call(id, callable, args=None, kwargs=None, *, restrict=False)
-
     Call the provided object in the identified interpreter.
+
     Pass the given args and kwargs, if possible.
     """
     ...
@@ -149,64 +117,51 @@ def run_string(
     id: SupportsIndex, script: str | types.CodeType | Callable[[], object], shared: _SharedDict = {}, *, restrict: bool = False
 ) -> None:
     """
-    run_string(id, script, shared=None, *, restrict=False)
-
     Execute the provided string in the identified interpreter.
 
-    (See _interpreters.exec().
+    (See _interpreters.exec().)
     """
     ...
 def run_func(
     id: SupportsIndex, func: types.CodeType | Callable[[], object], shared: _SharedDict = {}, *, restrict: bool = False
 ) -> None:
     """
-    run_func(id, func, shared=None, *, restrict=False)
-
     Execute the body of the provided function in the identified interpreter.
+
     Code objects are also supported.  In both cases, closures and args
-    are not supported.  Methods and other callables are not supported either.
+    are not supported.  Methods and other callables are not supported
+    either.
 
-    (See _interpreters.exec().
+    (See _interpreters.exec().)
     """
     ...
 def set___main___attrs(id: SupportsIndex, updates: _SharedDict, *, restrict: bool = False) -> None:
-    """
-    set___main___attrs(id, ns, *, restrict=False)
-
-    Bind the given attributes in the interpreter's __main__ module.
-    """
+    """Bind the given attributes in the interpreter's __main__ module."""
     ...
 def incref(id: SupportsIndex, *, implieslink: bool = False, restrict: bool = False) -> None: ...
 def decref(id: SupportsIndex, *, restrict: bool = False) -> None: ...
 def is_shareable(obj: object) -> bool:
-    """
-    is_shareable(obj) -> bool
-
-    Return True if the object's data may be shared between interpreters and
-    False otherwise.
-    """
+    """Return True if the object's data may be shared between interpreters and False otherwise."""
     ...
 
 @overload
 def capture_exception(exc: BaseException) -> types.SimpleNamespace:
     """
-    capture_exception(exc=None) -> types.SimpleNamespace
+    Return a snapshot of an exception.
 
-    Return a snapshot of an exception.  If "exc" is None
-    then the current exception, if any, is used (but not cleared).
-
-    The returned snapshot is the same as what _interpreters.exec() returns.
+    If "exc" is None then the current exception, if any, is used (but not
+    cleared).  The returned snapshot is the same as what
+    _interpreters.exec() returns.
     """
     ...
 @overload
 def capture_exception(exc: None = None) -> types.SimpleNamespace | None:
     """
-    capture_exception(exc=None) -> types.SimpleNamespace
-
-    Return a snapshot of an exception.  If "exc" is None
-    then the current exception, if any, is used (but not cleared).
+    Return a snapshot of an exception.
 
-    The returned snapshot is the same as what _interpreters.exec() returns.
+    If "exc" is None then the current exception, if any, is used (but not
+    cleared).  The returned snapshot is the same as what
+    _interpreters.exec() returns.
     """
     ...