basedpyright 1.13.2 → 1.13.3

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

@@ -23,11 +23,23 @@ def ip_interface(
 
 class _IPAddressBase:
     @property
-    def compressed(self) -> str: ...
-    @property
-    def exploded(self) -> str: ...
-    @property
-    def reverse_pointer(self) -> str: ...
+    def compressed(self) -> str:
+        """Return the shorthand version of the IP address as a string."""
+        ...
+    @property
+    def exploded(self) -> str:
+        """Return the longhand version of the IP address as a string."""
+        ...
+    @property
+    def reverse_pointer(self) -> str:
+        """
+        The name of the reverse DNS pointer for the IP address, e.g.:
+        >>> ipaddress.ip_address("127.0.0.1").reverse_pointer
+        '1.0.0.127.in-addr.arpa'
+        >>> ipaddress.ip_address("2001:db8::1").reverse_pointer
+        '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa'
+        """
+        ...
     @property
     def version(self) -> int: ...
 
@@ -95,23 +107,80 @@ class _BaseNetwork(_IPAddressBase, Generic[_A]):
     def compare_networks(self, other: Self) -> int: ...
     def hosts(self) -> Iterator[_A]: ...
     @property
-    def is_global(self) -> bool: ...
-    @property
-    def is_link_local(self) -> bool: ...
-    @property
-    def is_loopback(self) -> bool: ...
-    @property
-    def is_multicast(self) -> bool: ...
-    @property
-    def is_private(self) -> bool: ...
-    @property
-    def is_reserved(self) -> bool: ...
-    @property
-    def is_unspecified(self) -> bool: ...
+    def is_global(self) -> bool:
+        """
+        Test if this address is allocated for public networks.
+
+        Returns:
+            A boolean, True if the address is not reserved per
+            iana-ipv4-special-registry or iana-ipv6-special-registry.
+        """
+        ...
+    @property
+    def is_link_local(self) -> bool:
+        """
+        Test if the address is reserved for link-local.
+
+        Returns:
+            A boolean, True if the address is reserved per RFC 4291.
+        """
+        ...
+    @property
+    def is_loopback(self) -> bool:
+        """
+        Test if the address is a loopback address.
+
+        Returns:
+            A boolean, True if the address is a loopback address as defined in
+            RFC 2373 2.5.3.
+        """
+        ...
+    @property
+    def is_multicast(self) -> bool:
+        """
+        Test if the address is reserved for multicast use.
+
+        Returns:
+            A boolean, True if the address is a multicast address.
+            See RFC 2373 2.7 for details.
+        """
+        ...
+    @property
+    def is_private(self) -> bool:
+        """
+        Test if this address is allocated for private networks.
+
+        Returns:
+            A boolean, True if the address is reserved per
+            iana-ipv4-special-registry or iana-ipv6-special-registry.
+        """
+        ...
+    @property
+    def is_reserved(self) -> bool:
+        """
+        Test if the address is otherwise IETF reserved.
+
+        Returns:
+            A boolean, True if the address is within one of the
+            reserved IPv6 Network ranges.
+        """
+        ...
+    @property
+    def is_unspecified(self) -> bool:
+        """
+        Test if the address is unspecified.
+
+        Returns:
+            A boolean, True if this is the unspecified address as defined in
+            RFC 2373 2.5.2.
+        """
+        ...
     @property
     def max_prefixlen(self) -> int: ...
     @property
-    def num_addresses(self) -> int: ...
+    def num_addresses(self) -> int:
+        """Number of hosts in the current subnet."""
+        ...
     def overlaps(self, other: _BaseNetwork[IPv4Address] | _BaseNetwork[IPv6Address]) -> bool: ...
     @property
     def prefixlen(self) -> int: ...
@@ -166,23 +235,79 @@ class _BaseV6:
 
 class IPv6Address(_BaseV6, _BaseAddress):
     @property
-    def ipv4_mapped(self) -> IPv4Address | None: ...
-    @property
-    def is_site_local(self) -> bool: ...
-    @property
-    def sixtofour(self) -> IPv4Address | None: ...
-    @property
-    def teredo(self) -> tuple[IPv4Address, IPv4Address] | None: ...
+    def ipv4_mapped(self) -> IPv4Address | None:
+        """
+        Return the IPv4 mapped address.
+
+        Returns:
+            If the IPv6 address is a v4 mapped address, return the
+            IPv4 mapped address. Return None otherwise.
+        """
+        ...
+    @property
+    def is_site_local(self) -> bool:
+        """
+        Test if the address is reserved for site-local.
+
+        Note that the site-local address space has been deprecated by RFC 3879.
+        Use is_private to test if this address is in the space of unique local
+        addresses as defined by RFC 4193.
+
+        Returns:
+            A boolean, True if the address is reserved per RFC 3513 2.5.6.
+        """
+        ...
+    @property
+    def sixtofour(self) -> IPv4Address | None:
+        """
+        Return the IPv4 6to4 embedded address.
+
+        Returns:
+            The IPv4 6to4-embedded address if present or None if the
+            address doesn't appear to contain a 6to4 embedded address.
+        """
+        ...
+    @property
+    def teredo(self) -> tuple[IPv4Address, IPv4Address] | None:
+        """
+        Tuple of embedded teredo IPs.
+
+        Returns:
+            Tuple of the (server, client) IPs or None if the address
+            doesn't appear to be a teredo address (doesn't start with
+            2001::/32)
+        """
+        ...
     if sys.version_info >= (3, 9):
         @property
-        def scope_id(self) -> str | None: ...
+        def scope_id(self) -> str | None:
+            """
+            Identifier of a particular zone of the address's scope.
+
+            See RFC 4007 for details.
+
+            Returns:
+                A string identifying the zone of the address if specified, else None.
+            """
+            ...
 
     def __hash__(self) -> int: ...
     def __eq__(self, other: object) -> bool: ...
 
 class IPv6Network(_BaseV6, _BaseNetwork[IPv6Address]):
     @property
-    def is_site_local(self) -> bool: ...
+    def is_site_local(self) -> bool:
+        """
+        Test if the address is reserved for site-local.
+
+        Note that the site-local address space has been deprecated by RFC 3879.
+        Use is_private to test if this address is in the space of unique local
+        addresses as defined by RFC 4193.
+
+        Returns:
+            A boolean, True if the address is reserved per RFC 3513 2.5.6.
+        """
+        ...
 
 class IPv6Interface(IPv6Address, _BaseInterface[IPv6Address, IPv6Network]):
     def __eq__(self, other: object) -> bool: ...

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

@@ -561,7 +561,11 @@ if sys.version_info >= (3, 12):
             ('D', 'E', 'F')
             ('G',)
         """
-        def __new__(cls, iterable: Iterable[_T_co], n: int) -> Self: ...
+        if sys.version_info >= (3, 13):
+            def __new__(cls, iterable: Iterable[_T_co], n: int, *, strict: bool = False) -> Self: ...
+        else:
+            def __new__(cls, iterable: Iterable[_T_co], n: int) -> Self: ...
+
         def __iter__(self) -> Self:
             """Implement iter(self)."""
             ...

package/dist/typeshed-fallback/stdlib/json/encoder.pyi

@@ -10,8 +10,20 @@ INFINITY: float
 
 def py_encode_basestring(s: str) -> str: ...  # undocumented
 def py_encode_basestring_ascii(s: str) -> str: ...  # undocumented
-def encode_basestring(s: str, /) -> str: ...  # undocumented
-def encode_basestring_ascii(s: str, /) -> str: ...  # undocumented
+def encode_basestring(s: str, /) -> str:
+    """
+    encode_basestring(string) -> string
+
+    Return a JSON representation of a Python string
+    """
+    ...
+def encode_basestring_ascii(s: str, /) -> str:
+    """
+    encode_basestring_ascii(string) -> string
+
+    Return an ASCII-only JSON representation of a Python string
+    """
+    ...
 
 class JSONEncoder:
     item_separator: str

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

@@ -7,14 +7,18 @@ if sys.version_info >= (3, 9):
 else:
     __all__ = ["iskeyword", "kwlist"]
 
-def iskeyword(s: str, /) -> bool: ...
+def iskeyword(s: str, /) -> bool:
+    """x.__contains__(y) <==> y in x."""
+    ...
 
 # a list at runtime, but you're not meant to mutate it;
 # type it as a sequence
 kwlist: Final[Sequence[str]]
 
 if sys.version_info >= (3, 9):
-    def issoftkeyword(s: str, /) -> bool: ...
+    def issoftkeyword(s: str, /) -> bool:
+        """x.__contains__(y) <==> y in x."""
+        ...
 
     # a list at runtime, but you're not meant to mutate it;
     # type it as a sequence

package/dist/typeshed-fallback/stdlib/lib2to3/pytree.pyi

@@ -37,9 +37,19 @@ class Base:
     def changed(self) -> None: ...
     def remove(self) -> int | None: ...
     @property
-    def next_sibling(self) -> _NL | None: ...
+    def next_sibling(self) -> _NL | None:
+        """
+        The node immediately following the invocant in their parent's children
+        list. If the invocant does not have a next sibling, it is None
+        """
+        ...
     @property
-    def prev_sibling(self) -> _NL | None: ...
+    def prev_sibling(self) -> _NL | None:
+        """
+        The node immediately preceding the invocant in their parent's children
+        list. If the invocant does not have a previous sibling, it is None.
+        """
+        ...
     def leaves(self) -> Iterator[Leaf]: ...
     def depth(self) -> int: ...
     def get_suffix(self) -> str: ...

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

@@ -361,7 +361,9 @@ class LogRecord:
     ) -> None: ...
     def getMessage(self) -> str: ...
     # Allows setting contextual information on LogRecord objects as per the docs, see #7833
-    def __setattr__(self, name: str, value: Any, /) -> None: ...
+    def __setattr__(self, name: str, value: Any, /) -> None:
+        """Implement setattr(self, name, value)."""
+        ...
 
 _L = TypeVar("_L", bound=Logger | LoggerAdapter[Any])
 
@@ -494,7 +496,13 @@ class LoggerAdapter(Generic[_L]):
     @property
     def name(self) -> str: ...  # undocumented
     if sys.version_info >= (3, 11):
-        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,).
+            """
+            ...
 
 def getLogger(name: str | None = None) -> Logger: ...
 def getLoggerClass() -> type[Logger]: ...
@@ -631,7 +639,13 @@ class StreamHandler(Handler, Generic[_StreamT]):
     def __init__(self: StreamHandler[_StreamT], stream: _StreamT) -> None: ...  # pyright: ignore[reportInvalidTypeVarUse]  #11780
     def setStream(self, stream: _StreamT) -> _StreamT | None: ...
     if sys.version_info >= (3, 11):
-        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 FileHandler(StreamHandler[TextIOWrapper]):
     baseFilename: str  # undocumented

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

@@ -82,27 +82,119 @@ PRESET_EXTREME: int  # v big number
 # from _lzma.c
 @final
 class LZMADecompressor:
+    """
+    Create a decompressor object for decompressing data incrementally.
+
+      format
+        Specifies the container format of the input stream.  If this is
+        FORMAT_AUTO (the default), the decompressor will automatically detect
+        whether the input is FORMAT_XZ or FORMAT_ALONE.  Streams created with
+        FORMAT_RAW cannot be autodetected.
+      memlimit
+        Limit the amount of memory used by the decompressor.  This will cause
+        decompression to fail if the input cannot be decompressed within the
+        given limit.
+      filters
+        A custom filter chain.  This argument is required for FORMAT_RAW, and
+        not accepted with any other format.  When provided, this should be a
+        sequence of dicts, each indicating the ID and options for a single
+        filter.
+
+    For one-shot decompression, use the decompress() function instead.
+    """
     def __init__(self, format: int | None = ..., memlimit: int | None = ..., filters: _FilterChain | None = ...) -> None: ...
-    def decompress(self, data: ReadableBuffer, max_length: int = -1) -> bytes: ...
+    def decompress(self, data: ReadableBuffer, max_length: int = -1) -> bytes:
+        """
+        Decompress *data*, returning uncompressed data as bytes.
+
+        If *max_length* is nonnegative, returns at most *max_length* bytes of
+        decompressed data. If this limit is reached and further output can be
+        produced, *self.needs_input* will be set to ``False``. In this case, the next
+        call to *decompress()* may provide *data* as b'' to obtain more of the output.
+
+        If all of the input data was decompressed and returned (either because this
+        was less than *max_length* bytes, or because *max_length* was negative),
+        *self.needs_input* will be set to True.
+
+        Attempting to decompress data after the end of stream is reached raises an
+        EOFError.  Any data found after the end of the stream is ignored and saved in
+        the unused_data attribute.
+        """
+        ...
     @property
-    def check(self) -> int: ...
+    def check(self) -> int:
+        """ID of the integrity check used by the input stream."""
+        ...
     @property
-    def eof(self) -> bool: ...
+    def eof(self) -> bool:
+        """True if the end-of-stream marker has been reached."""
+        ...
     @property
-    def unused_data(self) -> bytes: ...
+    def unused_data(self) -> bytes:
+        """Data found after the end of the compressed stream."""
+        ...
     @property
-    def needs_input(self) -> bool: ...
+    def needs_input(self) -> bool:
+        """True if more input is needed before more decompressed data can be produced."""
+        ...
 
 # from _lzma.c
 @final
 class LZMACompressor:
+    """
+    LZMACompressor(format=FORMAT_XZ, check=-1, preset=None, filters=None)
+
+    Create a compressor object for compressing data incrementally.
+
+    format specifies the container format to use for the output. This can
+    be FORMAT_XZ (default), FORMAT_ALONE, or FORMAT_RAW.
+
+    check specifies the integrity check to use. For FORMAT_XZ, the default
+    is CHECK_CRC64. FORMAT_ALONE and FORMAT_RAW do not support integrity
+    checks; for these formats, check must be omitted, or be CHECK_NONE.
+
+    The settings used by the compressor can be specified either as a
+    preset compression level (with the 'preset' argument), or in detail
+    as a custom filter chain (with the 'filters' argument). For FORMAT_XZ
+    and FORMAT_ALONE, the default is to use the PRESET_DEFAULT preset
+    level. For FORMAT_RAW, the caller must always specify a filter chain;
+    the raw compressor does not support preset compression levels.
+
+    preset (if provided) should be an integer in the range 0-9, optionally
+    OR-ed with the constant PRESET_EXTREME.
+
+    filters (if provided) should be a sequence of dicts. Each dict should
+    have an entry for "id" indicating the ID of the filter, plus
+    additional entries for options to the filter.
+
+    For one-shot compression, use the compress() function instead.
+    """
     def __init__(
         self, format: int | None = ..., check: int = ..., preset: int | None = ..., filters: _FilterChain | None = ...
     ) -> None: ...
-    def compress(self, data: ReadableBuffer, /) -> bytes: ...
-    def flush(self) -> bytes: ...
+    def compress(self, data: ReadableBuffer, /) -> bytes:
+        """
+        Provide data to the compressor object.
+
+        Returns a chunk of compressed data if possible, or b'' otherwise.
 
-class LZMAError(Exception): ...
+        When you have finished providing data to the compressor, call the
+        flush() method to finish the compression process.
+        """
+        ...
+    def flush(self) -> bytes:
+        """
+        Finish the compression process.
+
+        Returns the compressed data left in internal buffers.
+
+        The compressor object may not be used after this method is called.
+        """
+        ...
+
+class LZMAError(Exception):
+    """Call to liblzma failed."""
+    ...
 
 class LZMAFile(BaseStream, IO[bytes]):  # type: ignore[misc]  # incompatible definitions of writelines in the base classes
     def __init__(
@@ -194,4 +286,10 @@ def compress(
 def decompress(
     data: ReadableBuffer, format: int = 0, memlimit: int | None = None, filters: _FilterChain | None = None
 ) -> bytes: ...
-def is_check_supported(check_id: int, /) -> bool: ...
+def is_check_supported(check_id: int, /) -> bool:
+    """
+    Test whether the given integrity check is supported.
+
+    Always returns True for CHECK_NONE and CHECK_CRC32.
+    """
+    ...

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

@@ -102,7 +102,13 @@ class Mailbox(Generic[_MessageT]):
     @abstractmethod
     def close(self) -> 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,).
+            """
+            ...
 
 class Maildir(Mailbox[MaildirMessage]):
     colon: str
@@ -244,7 +250,13 @@ class _ProxyFile(Generic[AnyStr]):
     @property
     def closed(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,).
+            """
+            ...
 
 class _PartialFile(_ProxyFile[AnyStr]):
     def __init__(self, f: IO[AnyStr], start: int | None = None, stop: int | None = None) -> None: ...