basedpyright 1.15.2 → 1.16.0

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

@@ -11,48 +11,35 @@ if sys.platform != "win32":
     _CompDisp: TypeAlias = Callable[[str, Sequence[str], int], None]
 
     def parse_and_bind(string: str, /) -> None:
-        """
-        parse_and_bind(string) -> None
-        Execute the init line provided in the string argument.
-        """
+        """Execute the init line provided in the string argument."""
         ...
     def read_init_file(filename: StrOrBytesPath | None = None, /) -> None:
         """
-        read_init_file([filename]) -> None
         Execute a readline initialization file.
+
         The default filename is the last filename used.
         """
         ...
     def get_line_buffer() -> str:
-        """
-        get_line_buffer() -> string
-        return the current contents of the line buffer.
-        """
+        """Return the current contents of the line buffer."""
         ...
     def insert_text(string: str, /) -> None:
-        """
-        insert_text(string) -> None
-        Insert text into the line buffer at the cursor position.
-        """
+        """Insert text into the line buffer at the cursor position."""
         ...
     def redisplay() -> None:
-        """
-        redisplay() -> None
-        Change what's displayed on the screen to reflect the current
-        contents of the line buffer.
-        """
+        """Change what's displayed on the screen to reflect contents of the line buffer."""
         ...
     def read_history_file(filename: StrOrBytesPath | None = None, /) -> None:
         """
-        read_history_file([filename]) -> None
         Load a readline history file.
+
         The default filename is ~/.history.
         """
         ...
     def write_history_file(filename: StrOrBytesPath | None = None, /) -> None:
         """
-        write_history_file([filename]) -> None
         Save a readline history file.
+
         The default filename is ~/.history.
         """
         ...
@@ -64,66 +51,44 @@ if sys.platform != "win32":
         """
         ...
     def get_history_length() -> int:
-        """
-        get_history_length() -> int
-        return the maximum number of lines that will be written to
-        the history file.
-        """
+        """Return the maximum number of lines that will be written to the history file."""
         ...
     def set_history_length(length: int, /) -> None:
         """
-        set_history_length(length) -> None
-        set the maximal number of lines which will be written to
-        the history file. A negative length is used to inhibit
-        history truncation.
+        Set the maximal number of lines which will be written to the history file.
+
+        A negative length is used to inhibit history truncation.
         """
         ...
     def clear_history() -> None:
-        """
-        clear_history() -> None
-        Clear the current readline history.
-        """
+        """Clear the current readline history."""
         ...
     def get_current_history_length() -> int:
-        """
-        get_current_history_length() -> integer
-        return the current (not the maximum) length of history.
-        """
+        """Return the current (not the maximum) length of history."""
         ...
     def get_history_item(index: int, /) -> str:
-        """
-        get_history_item() -> string
-        return the current contents of history item at index.
-        """
+        """Return the current contents of history item at one-based index."""
         ...
     def remove_history_item(pos: int, /) -> None:
-        """
-        remove_history_item(pos) -> None
-        remove history item given by its position
-        """
+        """Remove history item given by its zero-based position."""
         ...
     def replace_history_item(pos: int, line: str, /) -> None:
         """
-        replace_history_item(pos, line) -> None
-        replaces history item given by its position with contents of line
+        Replaces history item given by its position with contents of line.
+
+        pos is zero-based.
         """
         ...
     def add_history(string: str, /) -> None:
-        """
-        add_history(string) -> None
-        add an item to the history buffer
-        """
+        """Add an item to the history buffer."""
         ...
     def set_auto_history(enabled: bool, /) -> None:
-        """
-        set_auto_history(enabled) -> None
-        Enables or disables automatic history.
-        """
+        """Enables or disables automatic history."""
         ...
     def set_startup_hook(function: Callable[[], object] | None = None, /) -> None:
         """
-        set_startup_hook([function]) -> None
         Set or remove the function invoked by the rl_startup_hook callback.
+
         The function is called with no arguments just
         before readline prints the first prompt.
         """
@@ -139,54 +104,35 @@ if sys.platform != "win32":
         ...
     def set_completer(function: _Completer | None = None, /) -> None:
         """
-        set_completer([function]) -> None
         Set or remove the completer function.
+
         The function is called as function(text, state),
         for state in 0, 1, 2, ..., until it returns a non-string.
         It should return the next possible completion starting with 'text'.
         """
         ...
     def get_completer() -> _Completer | None:
-        """
-        get_completer() -> function
-
-        Returns current completer function.
-        """
+        """Get the current completer function."""
         ...
     def get_completion_type() -> int:
-        """
-        get_completion_type() -> int
-        Get the type of completion being attempted.
-        """
+        """Get the type of completion being attempted."""
         ...
     def get_begidx() -> int:
-        """
-        get_begidx() -> int
-        get the beginning index of the completion scope
-        """
+        """Get the beginning index of the completion scope."""
         ...
     def get_endidx() -> int:
-        """
-        get_endidx() -> int
-        get the ending index of the completion scope
-        """
+        """Get the ending index of the completion scope."""
         ...
     def set_completer_delims(string: str, /) -> None:
-        """
-        set_completer_delims(string) -> None
-        set the word delimiters for completion
-        """
+        """Set the word delimiters for completion."""
         ...
     def get_completer_delims() -> str:
-        """
-        get_completer_delims() -> string
-        get the word delimiters for completion
-        """
+        """Get the word delimiters for completion."""
         ...
     def set_completion_display_matches_hook(function: _CompDisp | None = None, /) -> None:
         """
-        set_completion_display_matches_hook([function]) -> None
         Set or remove the completion display function.
+
         The function is called as
           function(substitution, [matches], longest_match_length)
         once each time matches need to be displayed.

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

@@ -69,9 +69,8 @@ _HANDLER: TypeAlias = Callable[[int, FrameType | None], Any] | int | Handlers |
 
 def default_int_handler(signalnum: int, frame: FrameType | None, /) -> Never:
     """
-    default_int_handler(...)
-
     The default handler for SIGINT installed by Python.
+
     It raises KeyboardInterrupt.
     """
     ...
@@ -239,8 +238,9 @@ def strsignal(signalnum: _SIGNUM, /) -> str | None:
     """
     Return the system description of the given signal.
 
-    The return values can be such as "Interrupt", "Segmentation fault", etc.
-    Returns None if the signal is not recognized.
+    Returns the description of signal *signalnum*, such as "Interrupt"
+    for :const:`SIGINT`. Returns :const:`None` if *signalnum* has no
+    description. Raises :exc:`ValueError` if *signalnum* is invalid.
     """
     ...
 def valid_signals() -> set[Signals]: ...

package/dist/typeshed-fallback/stdlib/sqlite3/dbapi2.pyi

@@ -219,18 +219,14 @@ if sys.version_info >= (3, 12):
 # Can take or return anything depending on what's in the registry.
 @overload
 def adapt(obj: Any, proto: Any, /) -> Any:
-    """adapt(obj, protocol, alternate) -> adapt obj to given protocol. Non-standard."""
+    """Adapt given object to given protocol."""
     ...
 @overload
 def adapt(obj: Any, proto: Any, alt: _T, /) -> Any | _T:
-    """adapt(obj, protocol, alternate) -> adapt obj to given protocol. Non-standard."""
+    """Adapt given object to given protocol."""
     ...
 def complete_statement(statement: str) -> bool:
-    """
-    complete_statement(sql)
-
-    Checks if a string contains a complete SQL statement. Non-standard.
-    """
+    """Checks if a string contains a complete SQL statement."""
     ...
 
 if sys.version_info >= (3, 12):
@@ -306,12 +302,10 @@ else:
         uri: bool = False,
     ) -> Connection:
         """
-        connect(database[, timeout, detect_types, isolation_level,
-                check_same_thread, factory, cached_statements, uri])
+        Opens a connection to the SQLite database file database.
 
-        Opens a connection to the SQLite database file *database*. You can use
-        ":memory:" to open a database connection to a database that resides in
-        RAM instead of on disk.
+        You can use ":memory:" to open a database connection to a database that resides
+        in RAM instead of on disk.
         """
         ...
     @overload
@@ -326,12 +320,10 @@ else:
         uri: bool = False,
     ) -> _ConnectionT:
         """
-        connect(database[, timeout, detect_types, isolation_level,
-                check_same_thread, factory, cached_statements, uri])
+        Opens a connection to the SQLite database file database.
 
-        Opens a connection to the SQLite database file *database*. You can use
-        ":memory:" to open a database connection to a database that resides in
-        RAM instead of on disk.
+        You can use ":memory:" to open a database connection to a database that resides
+        in RAM instead of on disk.
         """
         ...
     @overload
@@ -347,21 +339,15 @@ else:
         uri: bool = False,
     ) -> _ConnectionT:
         """
-        connect(database[, timeout, detect_types, isolation_level,
-                check_same_thread, factory, cached_statements, uri])
+        Opens a connection to the SQLite database file database.
 
-        Opens a connection to the SQLite database file *database*. You can use
-        ":memory:" to open a database connection to a database that resides in
-        RAM instead of on disk.
+        You can use ":memory:" to open a database connection to a database that resides
+        in RAM instead of on disk.
         """
         ...
 
 def enable_callback_tracebacks(enable: bool, /) -> None:
-    """
-    enable_callback_tracebacks(flag)
-
-    Enable or disable callback functions throwing errors to stderr.
-    """
+    """Enable or disable callback functions throwing errors to stderr."""
     ...
 
 if sys.version_info < (3, 12):
@@ -371,7 +357,6 @@ if sys.version_info < (3, 12):
         enable_shared_cache(do_enable)
 
         Enable or disable shared cache mode for the calling thread.
-        Experimental/Non-standard.
         """
         ...
 
@@ -388,14 +373,14 @@ else:
         """
         register_adapter(type, callable)
 
-        Registers an adapter with pysqlite's adapter registry. Non-standard.
+        Registers an adapter with sqlite3's adapter registry.
         """
         ...
     def register_converter(name: str, converter: _Converter, /) -> None:
         """
         register_converter(typename, callable)
 
-        Registers a converter with pysqlite. Non-standard.
+        Registers a converter with sqlite3.
         """
         ...
 
@@ -481,7 +466,11 @@ class Connection:
         ) -> None: ...
 
     def close(self) -> None:
-        """Closes the connection."""
+        """
+        Close the database connection.
+
+        Any pending transaction is not committed implicitly.
+        """
         ...
     if sys.version_info >= (3, 11):
         def blobopen(self, table: str, column: str, row: int, /, *, readonly: bool = False, name: str = "main") -> Blob:
@@ -502,10 +491,14 @@ class Connection:
             ...
 
     def commit(self) -> None:
-        """Commit the current transaction."""
+        """
+        Commit any pending transaction to the database.
+
+        If there is no open transaction, this method is a no-op.
+        """
         ...
     def create_aggregate(self, name: str, n_arg: int, aggregate_class: Callable[[], _AggregateProtocol]) -> None:
-        """Creates a new aggregate. Non-standard."""
+        """Creates a new aggregate."""
         ...
     if sys.version_info >= (3, 11):
         # num_params determines how many params will be passed to the aggregate class. We provide an overload
@@ -564,12 +557,12 @@ class Connection:
             ...
 
     def create_collation(self, name: str, callback: Callable[[str, str], int | SupportsIndex] | None, /) -> None:
-        """Creates a collation function. Non-standard."""
+        """Creates a collation function."""
         ...
     def create_function(
         self, name: str, narg: int, func: Callable[..., _SqliteData] | None, *, deterministic: bool = False
     ) -> None:
-        """Creates a new function. Non-standard."""
+        """Creates a new function."""
         ...
     @overload
     def cursor(self, factory: None = None) -> Cursor:
@@ -580,45 +573,49 @@ class Connection:
         """Return a cursor for the connection."""
         ...
     def execute(self, sql: str, parameters: _Parameters = ..., /) -> Cursor:
-        """Executes a SQL statement. Non-standard."""
+        """Executes an SQL statement."""
         ...
     def executemany(self, sql: str, parameters: Iterable[_Parameters], /) -> Cursor:
-        """Repeatedly executes a SQL statement. Non-standard."""
+        """Repeatedly executes an SQL statement."""
         ...
     def executescript(self, sql_script: str, /) -> Cursor:
-        """Executes a multiple SQL statements at once. Non-standard."""
+        """Executes multiple SQL statements at once."""
         ...
     def interrupt(self) -> None:
-        """Abort any pending database operation. Non-standard."""
+        """Abort any pending database operation."""
         ...
     if sys.version_info >= (3, 13):
         def iterdump(self, *, filter: str | None = None) -> Generator[str, None, None]: ...
     else:
         def iterdump(self) -> Generator[str, None, None]:
-            """Returns iterator to the dump of the database in an SQL text format. Non-standard."""
+            """Returns iterator to the dump of the database in an SQL text format."""
             ...
 
     def rollback(self) -> None:
-        """Roll back the current transaction."""
+        """
+        Roll back to the start of any pending transaction.
+
+        If there is no open transaction, this method is a no-op.
+        """
         ...
     def set_authorizer(
         self, authorizer_callback: Callable[[int, str | None, str | None, str | None, str | None], int] | None
     ) -> None:
-        """Sets authorizer callback. Non-standard."""
+        """Sets authorizer callback."""
         ...
     def set_progress_handler(self, progress_handler: Callable[[], int | None] | None, n: int) -> None:
-        """Sets progress handler callback. Non-standard."""
+        """Sets progress handler callback."""
         ...
     def set_trace_callback(self, trace_callback: Callable[[str], object] | None) -> None:
-        """Sets a trace callback called for each SQL statement (passed as unicode). Non-standard."""
+        """Sets a trace callback called for each SQL statement (passed as unicode)."""
         ...
     # enable_load_extension and load_extension is not available on python distributions compiled
     # without sqlite3 loadable extension support. see footnotes https://docs.python.org/3/library/sqlite3.html#f1
     def enable_load_extension(self, enable: bool, /) -> None:
-        """Enable dynamic loading of SQLite extension modules. Non-standard."""
+        """Enable dynamic loading of SQLite extension modules."""
         ...
     def load_extension(self, name: str, /) -> None:
-        """Load SQLite extension module. Non-standard."""
+        """Load SQLite extension module."""
         ...
     def backup(
         self,
@@ -629,7 +626,7 @@ class Connection:
         name: str = "main",
         sleep: float = 0.25,
     ) -> None:
-        """Makes a backup of the database. Non-standard."""
+        """Makes a backup of the database."""
         ...
     if sys.version_info >= (3, 11):
         def setlimit(self, category: int, limit: int, /) -> int:
@@ -707,12 +704,20 @@ class Connection:
         """Call self as a function."""
         ...
     def __enter__(self) -> Self:
-        """For context manager. Non-standard."""
+        """
+        Called when the connection is used as a context manager.
+
+        Returns itself as a convenience to the caller.
+        """
         ...
     def __exit__(
         self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None, /
     ) -> Literal[False]:
-        """For context manager. Non-standard."""
+        """
+        Called when the connection is used as a context manager.
+
+        If there was any exception, a rollback takes place; otherwise we commit.
+        """
         ...
 
 class Cursor(Iterator[Any]):
@@ -732,19 +737,24 @@ class Cursor(Iterator[Any]):
         """Closes the cursor."""
         ...
     def execute(self, sql: str, parameters: _Parameters = (), /) -> Self:
-        """Executes a SQL statement."""
+        """Executes an SQL statement."""
         ...
     def executemany(self, sql: str, seq_of_parameters: Iterable[_Parameters], /) -> Self:
-        """Repeatedly executes a SQL statement."""
+        """Repeatedly executes an SQL statement."""
         ...
     def executescript(self, sql_script: str, /) -> Cursor:
-        """Executes a multiple SQL statements at once. Non-standard."""
+        """Executes multiple SQL statements at once."""
         ...
     def fetchall(self) -> list[Any]:
         """Fetches all rows from the resultset."""
         ...
     def fetchmany(self, size: int | None = 1) -> list[Any]:
-        """Fetches several rows from the resultset."""
+        """
+        Fetches several rows from the resultset.
+
+        size
+          The default value is set by the Cursor.arraysize attribute.
+        """
         ...
     # Returns either a row (as created by the row_factory) or None, but
     # putting None in the return annotation causes annoying false positives.
@@ -752,10 +762,10 @@ class Cursor(Iterator[Any]):
         """Fetches one row from the resultset."""
         ...
     def setinputsizes(self, sizes: Unused, /) -> None:
-        """Required by DB-API. Does nothing in pysqlite."""
+        """Required by DB-API. Does nothing in sqlite3."""
         ...
     def setoutputsize(self, size: Unused, column: Unused = None, /) -> None:
-        """Required by DB-API. Does nothing in pysqlite."""
+        """Required by DB-API. Does nothing in sqlite3."""
         ...
     def __iter__(self) -> Self:
         """Implement iter(self)."""

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

@@ -114,7 +114,7 @@ if sys.version_info < (3, 12):
 
 def RAND_status() -> bool:
     """
-    Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.
+    Returns True if the OpenSSL PRNG has been seeded with enough data and False if not.
 
     It is necessary to seed the PRNG with RAND_add() on some platforms before
     using the ssl() function.

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

@@ -57,14 +57,7 @@ def calcsize(format: str | bytes, /) -> int:
     ...
 
 class Struct:
-    """
-    Create a compiled struct object.
-
-    Return a new Struct object which writes and reads binary data according to
-    the format string.
-
-    See help(struct) for more on format strings.
-    """
+    """Struct(fmt) --> compiled struct object"""
     @property
     def format(self) -> str:
         """struct format string"""

package/dist/typeshed-fallback/stdlib/sys/__init__.pyi

@@ -19,11 +19,13 @@ stderr -- standard error object; used for error messages
   By assigning other file objects (or objects that behave like files)
   to these, it is possible to redirect all of the interpreter's I/O.
 
+last_exc - the last uncaught exception
+  Only available in an interactive session after a
+  traceback has been printed.
 last_type -- type of last uncaught exception
 last_value -- value of last uncaught exception
 last_traceback -- traceback of last uncaught exception
-  These three are only available in an interactive session after a
-  traceback has been printed.
+  These three are the (deprecated) legacy representation of last_exc.
 
 Static objects:
 
@@ -54,7 +56,8 @@ Functions:
 
 displayhook() -- print an object to the screen, and save it in builtins._
 excepthook() -- print an exception and its traceback to sys.stderr
-exc_info() -- return thread-safe information about the current exception
+exception() -- return the current thread's active exception
+exc_info() -- return information about the current thread's active exception
 exit() -- exit the interpreter by raising SystemExit
 getdlopenflags() -- returns flags to be used for dlopen() calls
 getprofile() -- get the global profiling function
@@ -62,7 +65,6 @@ getrefcount() -- return the reference count for an object (plus one :-)
 getrecursionlimit() -- return the max recursion depth for the interpreter
 getsizeof() -- return the size of an object in bytes
 gettrace() -- get the global debug tracing function
-setcheckinterval() -- control how often the interpreter checks for events
 setdlopenflags() -- set the flags to be used for dlopen() calls
 setprofile() -- set the global profiling function
 setrecursionlimit() -- set the max recursion depth for the interpreter
@@ -648,7 +650,7 @@ def get_asyncgen_hooks() -> _asyncgen_hooks:
     ...
 def set_asyncgen_hooks(firstiter: _AsyncgenHook = ..., finalizer: _AsyncgenHook = ...) -> None:
     """
-    set_asyncgen_hooks(* [, firstiter] [, finalizer])
+    set_asyncgen_hooks([firstiter] [, finalizer])
 
     Set a finalizer for async generators objects.
     """

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

@@ -267,61 +267,52 @@ if sys.platform != "win32":
 
     def tcgetattr(fd: FileDescriptorLike, /) -> _AttrReturn:
         """
-        tcgetattr(fd) -> list_of_attrs
+        Get the tty attributes for file descriptor fd.
 
-        Get the tty attributes for file descriptor fd, as follows:
-        [iflag, oflag, cflag, lflag, ispeed, ospeed, cc] where cc is a list
-        of the tty special characters (each a string of length 1, except the items
-        with indices VMIN and VTIME, which are integers when these fields are
-        defined).  The interpretation of the flags and the speeds as well as the
-        indexing in the cc array must be done using the symbolic constants defined
-        in this module.
+        Returns a list [iflag, oflag, cflag, lflag, ispeed, ospeed, cc]
+        where cc is a list of the tty special characters (each a string of
+        length 1, except the items with indices VMIN and VTIME, which are
+        integers when these fields are defined).  The interpretation of the
+        flags and the speeds as well as the indexing in the cc array must be
+        done using the symbolic constants defined in this module.
         """
         ...
     def tcsetattr(fd: FileDescriptorLike, when: int, attributes: _Attr, /) -> None:
         """
-        tcsetattr(fd, when, attributes) -> None
-
         Set the tty attributes for file descriptor fd.
+
         The attributes to be set are taken from the attributes argument, which
         is a list like the one returned by tcgetattr(). The when argument
         determines when the attributes are changed: termios.TCSANOW to
         change immediately, termios.TCSADRAIN to change after transmitting all
         queued output, or termios.TCSAFLUSH to change after transmitting all
-        queued output and discarding all queued input. 
+        queued output and discarding all queued input.
         """
         ...
     def tcsendbreak(fd: FileDescriptorLike, duration: int, /) -> None:
         """
-        tcsendbreak(fd, duration) -> None
-
         Send a break on file descriptor fd.
+
         A zero duration sends a break for 0.25-0.5 seconds; a nonzero duration
         has a system dependent meaning.
         """
         ...
     def tcdrain(fd: FileDescriptorLike, /) -> None:
-        """
-        tcdrain(fd) -> None
-
-        Wait until all output written to file descriptor fd has been transmitted.
-        """
+        """Wait until all output written to file descriptor fd has been transmitted."""
         ...
     def tcflush(fd: FileDescriptorLike, queue: int, /) -> None:
         """
-        tcflush(fd, queue) -> None
-
         Discard queued data on file descriptor fd.
+
         The queue selector specifies which queue: termios.TCIFLUSH for the input
         queue, termios.TCOFLUSH for the output queue, or termios.TCIOFLUSH for
-        both queues. 
+        both queues.
         """
         ...
     def tcflow(fd: FileDescriptorLike, action: int, /) -> None:
         """
-        tcflow(fd, action) -> None
-
         Suspend or resume input or output on file descriptor fd.
+
         The action argument can be termios.TCOOFF to suspend output,
         termios.TCOON to restart output, termios.TCIOFF to suspend input,
         or termios.TCION to restart input.

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

@@ -4,8 +4,8 @@ This module provides various functions to manipulate time values.
 There are two standard representations of time.  One is the number
 of seconds since the Epoch, in UTC (a.k.a. GMT).  It may be an integer
 or a floating point number (to represent fractions of seconds).
-The Epoch is system-defined; on Unix, it is generally January 1st, 1970.
-The actual value can be retrieved by calling gmtime(0).
+The epoch is the point where the time starts, the return value of time.gmtime(0).
+It is January 1, 1970, 00:00:00 (UTC) on all platforms.
 
 The other representation is a tuple of 9 integers giving local time.
 The tuple items are: