basedpyright 1.12.6 → 1.13.0

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

@@ -1,111 +1,118 @@
-import sys
-
-if sys.platform == "win32":
-    # Actually defined here and re-exported from os at runtime,
-    # but this leads to less code duplication
-    from os import (
-        F_OK as F_OK,
-        O_APPEND as O_APPEND,
-        O_BINARY as O_BINARY,
-        O_CREAT as O_CREAT,
-        O_EXCL as O_EXCL,
-        O_NOINHERIT as O_NOINHERIT,
-        O_RANDOM as O_RANDOM,
-        O_RDONLY as O_RDONLY,
-        O_RDWR as O_RDWR,
-        O_SEQUENTIAL as O_SEQUENTIAL,
-        O_SHORT_LIVED as O_SHORT_LIVED,
-        O_TEMPORARY as O_TEMPORARY,
-        O_TEXT as O_TEXT,
-        O_TRUNC as O_TRUNC,
-        O_WRONLY as O_WRONLY,
-        P_DETACH as P_DETACH,
-        P_NOWAIT as P_NOWAIT,
-        P_NOWAITO as P_NOWAITO,
-        P_OVERLAY as P_OVERLAY,
-        P_WAIT as P_WAIT,
-        R_OK as R_OK,
-        TMP_MAX as TMP_MAX,
-        W_OK as W_OK,
-        X_OK as X_OK,
-        DirEntry as DirEntry,
-        abort as abort,
-        access as access,
-        chdir as chdir,
-        chmod as chmod,
-        close as close,
-        closerange as closerange,
-        cpu_count as cpu_count,
-        device_encoding as device_encoding,
-        dup as dup,
-        dup2 as dup2,
-        error as error,
-        execv as execv,
-        execve as execve,
-        fspath as fspath,
-        fstat as fstat,
-        fsync as fsync,
-        ftruncate as ftruncate,
-        get_handle_inheritable as get_handle_inheritable,
-        get_inheritable as get_inheritable,
-        get_terminal_size as get_terminal_size,
-        getcwd as getcwd,
-        getcwdb as getcwdb,
-        getlogin as getlogin,
-        getpid as getpid,
-        getppid as getppid,
-        isatty as isatty,
-        kill as kill,
-        link as link,
-        listdir as listdir,
-        lseek as lseek,
-        lstat as lstat,
-        mkdir as mkdir,
-        open as open,
-        pipe as pipe,
-        putenv as putenv,
-        read as read,
-        readlink as readlink,
-        remove as remove,
-        rename as rename,
-        replace as replace,
-        rmdir as rmdir,
-        scandir as scandir,
-        set_handle_inheritable as set_handle_inheritable,
-        set_inheritable as set_inheritable,
-        spawnv as spawnv,
-        spawnve as spawnve,
-        startfile as startfile,
-        stat as stat,
-        stat_result as stat_result,
-        statvfs_result as statvfs_result,
-        strerror as strerror,
-        symlink as symlink,
-        system as system,
-        terminal_size as terminal_size,
-        times as times,
-        times_result as times_result,
-        truncate as truncate,
-        umask as umask,
-        uname_result as uname_result,
-        unlink as unlink,
-        urandom as urandom,
-        utime as utime,
-        waitpid as waitpid,
-        write as write,
-    )
-
-    if sys.version_info >= (3, 9):
-        from os import unsetenv as unsetenv, waitstatus_to_exitcode as waitstatus_to_exitcode
-    if sys.version_info >= (3, 11):
-        from os import EX_OK as EX_OK
-    if sys.version_info >= (3, 12):
-        from os import (
-            get_blocking as get_blocking,
-            listdrives as listdrives,
-            listmounts as listmounts,
-            listvolumes as listvolumes,
-            set_blocking as set_blocking,
-        )
-
-    environ: dict[str, str]
+"""
+This module provides access to operating system functionality that is
+standardized by the C Standard and the POSIX standard (a thinly
+disguised Unix interface).  Refer to the library manual and
+corresponding Unix manual entries for more information on calls.
+"""
+
+import sys
+
+if sys.platform == "win32":
+    # Actually defined here and re-exported from os at runtime,
+    # but this leads to less code duplication
+    from os import (
+        F_OK as F_OK,
+        O_APPEND as O_APPEND,
+        O_BINARY as O_BINARY,
+        O_CREAT as O_CREAT,
+        O_EXCL as O_EXCL,
+        O_NOINHERIT as O_NOINHERIT,
+        O_RANDOM as O_RANDOM,
+        O_RDONLY as O_RDONLY,
+        O_RDWR as O_RDWR,
+        O_SEQUENTIAL as O_SEQUENTIAL,
+        O_SHORT_LIVED as O_SHORT_LIVED,
+        O_TEMPORARY as O_TEMPORARY,
+        O_TEXT as O_TEXT,
+        O_TRUNC as O_TRUNC,
+        O_WRONLY as O_WRONLY,
+        P_DETACH as P_DETACH,
+        P_NOWAIT as P_NOWAIT,
+        P_NOWAITO as P_NOWAITO,
+        P_OVERLAY as P_OVERLAY,
+        P_WAIT as P_WAIT,
+        R_OK as R_OK,
+        TMP_MAX as TMP_MAX,
+        W_OK as W_OK,
+        X_OK as X_OK,
+        DirEntry as DirEntry,
+        abort as abort,
+        access as access,
+        chdir as chdir,
+        chmod as chmod,
+        close as close,
+        closerange as closerange,
+        cpu_count as cpu_count,
+        device_encoding as device_encoding,
+        dup as dup,
+        dup2 as dup2,
+        error as error,
+        execv as execv,
+        execve as execve,
+        fspath as fspath,
+        fstat as fstat,
+        fsync as fsync,
+        ftruncate as ftruncate,
+        get_handle_inheritable as get_handle_inheritable,
+        get_inheritable as get_inheritable,
+        get_terminal_size as get_terminal_size,
+        getcwd as getcwd,
+        getcwdb as getcwdb,
+        getlogin as getlogin,
+        getpid as getpid,
+        getppid as getppid,
+        isatty as isatty,
+        kill as kill,
+        link as link,
+        listdir as listdir,
+        lseek as lseek,
+        lstat as lstat,
+        mkdir as mkdir,
+        open as open,
+        pipe as pipe,
+        putenv as putenv,
+        read as read,
+        readlink as readlink,
+        remove as remove,
+        rename as rename,
+        replace as replace,
+        rmdir as rmdir,
+        scandir as scandir,
+        set_handle_inheritable as set_handle_inheritable,
+        set_inheritable as set_inheritable,
+        spawnv as spawnv,
+        spawnve as spawnve,
+        startfile as startfile,
+        stat as stat,
+        stat_result as stat_result,
+        statvfs_result as statvfs_result,
+        strerror as strerror,
+        symlink as symlink,
+        system as system,
+        terminal_size as terminal_size,
+        times as times,
+        times_result as times_result,
+        truncate as truncate,
+        umask as umask,
+        uname_result as uname_result,
+        unlink as unlink,
+        urandom as urandom,
+        utime as utime,
+        waitpid as waitpid,
+        write as write,
+    )
+
+    if sys.version_info >= (3, 9):
+        from os import unsetenv as unsetenv, waitstatus_to_exitcode as waitstatus_to_exitcode
+    if sys.version_info >= (3, 11):
+        from os import EX_OK as EX_OK
+    if sys.version_info >= (3, 12):
+        from os import (
+            get_blocking as get_blocking,
+            listdrives as listdrives,
+            listmounts as listmounts,
+            listvolumes as listvolumes,
+            set_blocking as set_blocking,
+        )
+
+    environ: dict[str, str]

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

@@ -1,24 +1,55 @@
-from _typeshed import StrOrBytesPath
-from collections.abc import Sequence
-from types import CodeType
-from typing import Any, final
-
-def expr(source: str) -> STType: ...
-def suite(source: str) -> STType: ...
-def sequence2st(sequence: Sequence[Any]) -> STType: ...
-def tuple2st(sequence: Sequence[Any]) -> STType: ...
-def st2list(st: STType, line_info: bool = ..., col_info: bool = ...) -> list[Any]: ...
-def st2tuple(st: STType, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]: ...
-def compilest(st: STType, filename: StrOrBytesPath = ...) -> CodeType: ...
-def isexpr(st: STType) -> bool: ...
-def issuite(st: STType) -> bool: ...
-
-class ParserError(Exception): ...
-
-@final
-class STType:
-    def compile(self, filename: StrOrBytesPath = ...) -> CodeType: ...
-    def isexpr(self) -> bool: ...
-    def issuite(self) -> bool: ...
-    def tolist(self, line_info: bool = ..., col_info: bool = ...) -> list[Any]: ...
-    def totuple(self, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]: ...
+"""This is an interface to Python's internal parser."""
+
+from _typeshed import StrOrBytesPath
+from collections.abc import Sequence
+from types import CodeType
+from typing import Any, final
+
+def expr(source: str) -> STType:
+    """Creates an ST object from an expression."""
+    ...
+def suite(source: str) -> STType:
+    """Creates an ST object from a suite."""
+    ...
+def sequence2st(sequence: Sequence[Any]) -> STType:
+    """Creates an ST object from a tree representation."""
+    ...
+def tuple2st(sequence: Sequence[Any]) -> STType:
+    """Creates an ST object from a tree representation."""
+    ...
+def st2list(st: STType, line_info: bool = ..., col_info: bool = ...) -> list[Any]:
+    """Creates a list-tree representation of an ST."""
+    ...
+def st2tuple(st: STType, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]:
+    """Creates a tuple-tree representation of an ST."""
+    ...
+def compilest(st: STType, filename: StrOrBytesPath = ...) -> CodeType:
+    """Compiles an ST object into a code object."""
+    ...
+def isexpr(st: STType) -> bool:
+    """Determines if an ST object was created from an expression."""
+    ...
+def issuite(st: STType) -> bool:
+    """Determines if an ST object was created from a suite."""
+    ...
+
+class ParserError(Exception): ...
+
+@final
+class STType:
+    """Intermediate representation of a Python parse tree."""
+    def compile(self, filename: StrOrBytesPath = ...) -> CodeType:
+        """Compile this ST object into a code object."""
+        ...
+    def isexpr(self) -> bool:
+        """Determines if this ST object was created from an expression."""
+        ...
+    def issuite(self) -> bool:
+        """Determines if this ST object was created from a suite."""
+        ...
+    def tolist(self, line_info: bool = ..., col_info: bool = ...) -> list[Any]:
+        """Creates a list-tree representation of this ST."""
+        ...
+    def totuple(self, line_info: bool = ..., col_info: bool = ...) -> tuple[Any, ...]:
+        """Creates a tuple-tree representation of this ST."""
+        ...

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

@@ -1,3 +1,10 @@
+"""
+This module provides access to operating system functionality that is
+standardized by the C Standard and the POSIX standard (a thinly
+disguised Unix interface).  Refer to the library manual and
+corresponding Unix manual entries for more information on calls.
+"""
+
 import sys
 
 if sys.platform != "win32":

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

@@ -1,3 +1,14 @@
+"""
+This module provides access to the Unix password database.
+It is available on all Unix versions.
+
+Password database entries are reported as 7-tuples containing the following
+items from the password database (see `<pwd.h>'), in order:
+pw_name, pw_passwd, pw_uid, pw_gid, pw_gecos, pw_dir, pw_shell.
+The uid and gid items are integers, all others are strings. An
+exception is raised if the entry asked for cannot be found.
+"""
+
 import sys
 from _typeshed import structseq
 from typing import Any, Final, final
@@ -5,24 +16,63 @@ from typing import Any, Final, final
 if sys.platform != "win32":
     @final
     class struct_passwd(structseq[Any], tuple[str, str, int, int, str, str, str]):
+        """
+        pwd.struct_passwd: Results from getpw*() routines.
+
+        This object may be accessed either as a tuple of
+          (pw_name,pw_passwd,pw_uid,pw_gid,pw_gecos,pw_dir,pw_shell)
+        or via the object attributes as named in the above tuple.
+        """
         if sys.version_info >= (3, 10):
             __match_args__: Final = ("pw_name", "pw_passwd", "pw_uid", "pw_gid", "pw_gecos", "pw_dir", "pw_shell")
 
         @property
-        def pw_name(self) -> str: ...
+        def pw_name(self) -> str:
+            """user name"""
+            ...
         @property
-        def pw_passwd(self) -> str: ...
+        def pw_passwd(self) -> str:
+            """password"""
+            ...
         @property
-        def pw_uid(self) -> int: ...
+        def pw_uid(self) -> int:
+            """user id"""
+            ...
         @property
-        def pw_gid(self) -> int: ...
+        def pw_gid(self) -> int:
+            """group id"""
+            ...
         @property
-        def pw_gecos(self) -> str: ...
+        def pw_gecos(self) -> str:
+            """real name"""
+            ...
         @property
-        def pw_dir(self) -> str: ...
+        def pw_dir(self) -> str:
+            """home directory"""
+            ...
         @property
-        def pw_shell(self) -> str: ...
+        def pw_shell(self) -> str:
+            """shell program"""
+            ...
+
+    def getpwall() -> list[struct_passwd]:
+        """
+        Return a list of all available password database entries, in arbitrary order.
+
+        See help(pwd) for more on password database entries.
+        """
+        ...
+    def getpwuid(uid: int, /) -> struct_passwd:
+        """
+        Return the password database entry for the given numeric user ID.
+
+        See `help(pwd)` for more on password database entries.
+        """
+        ...
+    def getpwnam(name: str, /) -> struct_passwd:
+        """
+        Return the password database entry for the given user name.
 
-    def getpwall() -> list[struct_passwd]: ...
-    def getpwuid(uid: int, /) -> struct_passwd: ...
-    def getpwnam(name: str, /) -> struct_passwd: ...
+        See `help(pwd)` for more on password database entries.
+        """
+        ...

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

@@ -1,3 +1,5 @@
+"""Python wrapper for Expat parser."""
+
 from _typeshed import ReadableBuffer, SupportsRead
 from collections.abc import Callable
 from pyexpat import errors as errors, model as model
@@ -24,16 +26,59 @@ _Model: TypeAlias = tuple[int, int, str | None, tuple[Any, ...]]
 
 @final
 class XMLParserType:
-    def Parse(self, data: str | ReadableBuffer, isfinal: bool = False, /) -> int: ...
-    def ParseFile(self, file: SupportsRead[bytes], /) -> int: ...
-    def SetBase(self, base: str, /) -> None: ...
-    def GetBase(self) -> str | None: ...
-    def GetInputContext(self) -> bytes | None: ...
-    def ExternalEntityParserCreate(self, context: str | None, encoding: str = ..., /) -> XMLParserType: ...
-    def SetParamEntityParsing(self, flag: int, /) -> int: ...
-    def UseForeignDTD(self, flag: bool = True, /) -> None: ...
-    def GetReparseDeferralEnabled(self) -> bool: ...
-    def SetReparseDeferralEnabled(self, enabled: bool, /) -> None: ...
+    """XML parser"""
+    def Parse(self, data: str | ReadableBuffer, isfinal: bool = False, /) -> int:
+        """
+        Parse XML data.
+
+        `isfinal' should be true at end of input.
+        """
+        ...
+    def ParseFile(self, file: SupportsRead[bytes], /) -> int:
+        """Parse XML data from file-like object."""
+        ...
+    def SetBase(self, base: str, /) -> None:
+        """Set the base URL for the parser."""
+        ...
+    def GetBase(self) -> str | None:
+        """Return base URL string for the parser."""
+        ...
+    def GetInputContext(self) -> bytes | None:
+        """
+        Return the untranslated text of the input that caused the current event.
+
+        If the event was generated by a large amount of text (such as a start tag
+        for an element with many attributes), not all of the text may be available.
+        """
+        ...
+    def ExternalEntityParserCreate(self, context: str | None, encoding: str = ..., /) -> XMLParserType:
+        """Create a parser for parsing an external entity based on the information passed to the ExternalEntityRefHandler."""
+        ...
+    def SetParamEntityParsing(self, flag: int, /) -> int:
+        """
+        Controls parsing of parameter entities (including the external DTD subset).
+
+        Possible flag values are XML_PARAM_ENTITY_PARSING_NEVER,
+        XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE and
+        XML_PARAM_ENTITY_PARSING_ALWAYS. Returns true if setting the flag
+        was successful.
+        """
+        ...
+    def UseForeignDTD(self, flag: bool = True, /) -> None:
+        """
+        Allows the application to provide an artificial external subset if one is not specified as part of the document instance.
+
+        This readily allows the use of a 'default' document type controlled by the
+        application, while still getting the advantage of providing document type
+        information to the parser. 'flag' defaults to True if not provided.
+        """
+        ...
+    def GetReparseDeferralEnabled(self) -> bool:
+        """Retrieve reparse deferral enabled status; always returns false with Expat <2.6.0."""
+        ...
+    def SetReparseDeferralEnabled(self, enabled: bool, /) -> None:
+        """Enable/Disable reparse deferral; enabled by default with Expat >=2.6.0."""
+        ...
     @property
     def intern(self) -> dict[str, str]: ...
     buffer_size: int
@@ -77,9 +122,13 @@ class XMLParserType:
     ExternalEntityRefHandler: Callable[[str, str | None, str | None, str | None], int] | None
     SkippedEntityHandler: Callable[[str, bool], Any] | None
 
-def ErrorString(code: int, /) -> str: ...
+def ErrorString(code: int, /) -> str:
+    """Returns string error for given number."""
+    ...
 
 # intern is undocumented
 def ParserCreate(
     encoding: str | None = None, namespace_separator: str | None = None, intern: dict[str, Any] | None = None
-) -> XMLParserType: ...
+) -> XMLParserType:
+    """Return a new XML parser object."""
+    ...