basedpyright 1.13.2 → 1.13.3

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

@@ -1,160 +1,160 @@
-import sys
-from _typeshed import ReadableBuffer, Unused
-from collections.abc import Iterable, Iterator, Sized
-from typing import Final, NoReturn, overload
-from typing_extensions import Self
-
-ACCESS_DEFAULT: int
-ACCESS_READ: int
-ACCESS_WRITE: int
-ACCESS_COPY: int
-
-ALLOCATIONGRANULARITY: int
-
-if sys.platform == "linux":
-    MAP_DENYWRITE: int
-    MAP_EXECUTABLE: int
-    if sys.version_info >= (3, 10):
-        MAP_POPULATE: int
-if sys.version_info >= (3, 11) and sys.platform != "win32" and sys.platform != "darwin":
-    MAP_STACK: int
-
-if sys.platform != "win32":
-    MAP_ANON: int
-    MAP_ANONYMOUS: int
-    MAP_PRIVATE: int
-    MAP_SHARED: int
-    PROT_EXEC: int
-    PROT_READ: int
-    PROT_WRITE: int
-
-PAGESIZE: int
-
-class mmap(Iterable[int], Sized):
-    """
-    Windows: mmap(fileno, length[, tagname[, access[, offset]]])
-
-    Maps length bytes from the file specified by the file handle fileno,
-    and returns a mmap object.  If length is larger than the current size
-    of the file, the file is extended to contain length bytes.  If length
-    is 0, the maximum length of the map is the current size of the file,
-    except that if the file is empty Windows raises an exception (you cannot
-    create an empty mapping on Windows).
-
-    Unix: mmap(fileno, length[, flags[, prot[, access[, offset]]]])
-
-    Maps length bytes from the file specified by the file descriptor fileno,
-    and returns a mmap object.  If length is 0, the maximum length of the map
-    will be the current size of the file when mmap is called.
-    flags specifies the nature of the mapping. MAP_PRIVATE creates a
-    private copy-on-write mapping, so changes to the contents of the mmap
-    object will be private to this process, and MAP_SHARED creates a mapping
-    that's shared with all other processes mapping the same areas of the file.
-    The default value is MAP_SHARED.
-
-    To map anonymous memory, pass -1 as the fileno (both versions).
-    """
-    if sys.platform == "win32":
-        def __init__(self, fileno: int, length: int, tagname: str | None = ..., access: int = ..., offset: int = ...) -> None: ...
-    else:
-        def __init__(
-            self, fileno: int, length: int, flags: int = ..., prot: int = ..., access: int = ..., offset: int = ...
-        ) -> None: ...
-
-    def close(self) -> None: ...
-    def flush(self, offset: int = ..., size: int = ...) -> None: ...
-    def move(self, dest: int, src: int, count: int) -> None: ...
-    def read_byte(self) -> int: ...
-    def readline(self) -> bytes: ...
-    def resize(self, newsize: int) -> None: ...
-    def seek(self, pos: int, whence: int = ...) -> None: ...
-    def size(self) -> int: ...
-    def tell(self) -> int: ...
-    def write_byte(self, byte: int) -> None: ...
-    def __len__(self) -> int:
-        """Return len(self)."""
-        ...
-    closed: bool
-    if sys.platform != "win32":
-        def madvise(self, option: int, start: int = ..., length: int = ...) -> None: ...
-
-    def find(self, sub: ReadableBuffer, start: int = ..., stop: int = ...) -> int: ...
-    def rfind(self, sub: ReadableBuffer, start: int = ..., stop: int = ...) -> int: ...
-    def read(self, n: int | None = ...) -> bytes: ...
-    def write(self, bytes: ReadableBuffer) -> int: ...
-    @overload
-    def __getitem__(self, key: int, /) -> int:
-        """Return self[key]."""
-        ...
-    @overload
-    def __getitem__(self, key: slice, /) -> bytes:
-        """Return self[key]."""
-        ...
-    def __delitem__(self, key: int | slice, /) -> NoReturn:
-        """Delete self[key]."""
-        ...
-    @overload
-    def __setitem__(self, key: int, value: int, /) -> None:
-        """Set self[key] to value."""
-        ...
-    @overload
-    def __setitem__(self, key: slice, value: ReadableBuffer, /) -> None:
-        """Set self[key] to value."""
-        ...
-    # Doesn't actually exist, but the object actually supports "in" because it has __getitem__,
-    # so we claim that there is also a __contains__ to help type checkers.
-    def __contains__(self, o: object, /) -> bool: ...
-    # Doesn't actually exist, but the object is actually iterable because it has __getitem__ and __len__,
-    # so we claim that there is also an __iter__ to help type checkers.
-    def __iter__(self) -> Iterator[int]: ...
-    def __enter__(self) -> Self: ...
-    def __exit__(self, *args: Unused) -> None: ...
-    def __buffer__(self, flags: int, /) -> memoryview:
-        """Return a buffer object that exposes the underlying memory of the object."""
-        ...
-    def __release_buffer__(self, buffer: memoryview, /) -> None:
-        """Release the buffer object that exposes the underlying memory of the object."""
-        ...
-    if sys.version_info >= (3, 13):
-        def seekable(self) -> bool: ...
-
-if sys.platform != "win32":
-    MADV_NORMAL: int
-    MADV_RANDOM: int
-    MADV_SEQUENTIAL: int
-    MADV_WILLNEED: int
-    MADV_DONTNEED: int
-    MADV_FREE: int
-
-if sys.platform == "linux":
-    MADV_REMOVE: int
-    MADV_DONTFORK: int
-    MADV_DOFORK: int
-    MADV_HWPOISON: int
-    MADV_MERGEABLE: int
-    MADV_UNMERGEABLE: int
-    # Seems like this constant is not defined in glibc.
-    # See https://github.com/python/typeshed/pull/5360 for details
-    # MADV_SOFT_OFFLINE: int
-    MADV_HUGEPAGE: int
-    MADV_NOHUGEPAGE: int
-    MADV_DONTDUMP: int
-    MADV_DODUMP: int
-
-# This Values are defined for FreeBSD but type checkers do not support conditions for these
-if sys.platform != "linux" and sys.platform != "darwin" and sys.platform != "win32":
-    MADV_NOSYNC: int
-    MADV_AUTOSYNC: int
-    MADV_NOCORE: int
-    MADV_CORE: int
-    MADV_PROTECT: int
-
-if sys.version_info >= (3, 10) and sys.platform == "darwin":
-    MADV_FREE_REUSABLE: int
-    MADV_FREE_REUSE: int
-
-if sys.version_info >= (3, 13) and sys.platform != "win32":
-    MAP_32BIT: Final = 32768
-
-if sys.version_info >= (3, 13) and sys.platform == "darwin":
-    MAP_TPRO: Final = 524288
+import sys
+from _typeshed import ReadableBuffer, Unused
+from collections.abc import Iterable, Iterator, Sized
+from typing import Final, Literal, NoReturn, overload
+from typing_extensions import Self
+
+ACCESS_DEFAULT: int
+ACCESS_READ: int
+ACCESS_WRITE: int
+ACCESS_COPY: int
+
+ALLOCATIONGRANULARITY: int
+
+if sys.platform == "linux":
+    MAP_DENYWRITE: int
+    MAP_EXECUTABLE: int
+    if sys.version_info >= (3, 10):
+        MAP_POPULATE: int
+if sys.version_info >= (3, 11) and sys.platform != "win32" and sys.platform != "darwin":
+    MAP_STACK: int
+
+if sys.platform != "win32":
+    MAP_ANON: int
+    MAP_ANONYMOUS: int
+    MAP_PRIVATE: int
+    MAP_SHARED: int
+    PROT_EXEC: int
+    PROT_READ: int
+    PROT_WRITE: int
+
+PAGESIZE: int
+
+class mmap(Iterable[int], Sized):
+    """
+    Windows: mmap(fileno, length[, tagname[, access[, offset]]])
+
+    Maps length bytes from the file specified by the file handle fileno,
+    and returns a mmap object.  If length is larger than the current size
+    of the file, the file is extended to contain length bytes.  If length
+    is 0, the maximum length of the map is the current size of the file,
+    except that if the file is empty Windows raises an exception (you cannot
+    create an empty mapping on Windows).
+
+    Unix: mmap(fileno, length[, flags[, prot[, access[, offset]]]])
+
+    Maps length bytes from the file specified by the file descriptor fileno,
+    and returns a mmap object.  If length is 0, the maximum length of the map
+    will be the current size of the file when mmap is called.
+    flags specifies the nature of the mapping. MAP_PRIVATE creates a
+    private copy-on-write mapping, so changes to the contents of the mmap
+    object will be private to this process, and MAP_SHARED creates a mapping
+    that's shared with all other processes mapping the same areas of the file.
+    The default value is MAP_SHARED.
+
+    To map anonymous memory, pass -1 as the fileno (both versions).
+    """
+    if sys.platform == "win32":
+        def __init__(self, fileno: int, length: int, tagname: str | None = ..., access: int = ..., offset: int = ...) -> None: ...
+    else:
+        def __init__(
+            self, fileno: int, length: int, flags: int = ..., prot: int = ..., access: int = ..., offset: int = ...
+        ) -> None: ...
+
+    def close(self) -> None: ...
+    def flush(self, offset: int = ..., size: int = ...) -> None: ...
+    def move(self, dest: int, src: int, count: int) -> None: ...
+    def read_byte(self) -> int: ...
+    def readline(self) -> bytes: ...
+    def resize(self, newsize: int) -> None: ...
+    def seek(self, pos: int, whence: int = ...) -> None: ...
+    def size(self) -> int: ...
+    def tell(self) -> int: ...
+    def write_byte(self, byte: int) -> None: ...
+    def __len__(self) -> int:
+        """Return len(self)."""
+        ...
+    closed: bool
+    if sys.platform != "win32":
+        def madvise(self, option: int, start: int = ..., length: int = ...) -> None: ...
+
+    def find(self, sub: ReadableBuffer, start: int = ..., stop: int = ...) -> int: ...
+    def rfind(self, sub: ReadableBuffer, start: int = ..., stop: int = ...) -> int: ...
+    def read(self, n: int | None = ...) -> bytes: ...
+    def write(self, bytes: ReadableBuffer) -> int: ...
+    @overload
+    def __getitem__(self, key: int, /) -> int:
+        """Return self[key]."""
+        ...
+    @overload
+    def __getitem__(self, key: slice, /) -> bytes:
+        """Return self[key]."""
+        ...
+    def __delitem__(self, key: int | slice, /) -> NoReturn:
+        """Delete self[key]."""
+        ...
+    @overload
+    def __setitem__(self, key: int, value: int, /) -> None:
+        """Set self[key] to value."""
+        ...
+    @overload
+    def __setitem__(self, key: slice, value: ReadableBuffer, /) -> None:
+        """Set self[key] to value."""
+        ...
+    # Doesn't actually exist, but the object actually supports "in" because it has __getitem__,
+    # so we claim that there is also a __contains__ to help type checkers.
+    def __contains__(self, o: object, /) -> bool: ...
+    # Doesn't actually exist, but the object is actually iterable because it has __getitem__ and __len__,
+    # so we claim that there is also an __iter__ to help type checkers.
+    def __iter__(self) -> Iterator[int]: ...
+    def __enter__(self) -> Self: ...
+    def __exit__(self, *args: Unused) -> None: ...
+    def __buffer__(self, flags: int, /) -> memoryview:
+        """Return a buffer object that exposes the underlying memory of the object."""
+        ...
+    def __release_buffer__(self, buffer: memoryview, /) -> None:
+        """Release the buffer object that exposes the underlying memory of the object."""
+        ...
+    if sys.version_info >= (3, 13):
+        def seekable(self) -> Literal[True]: ...
+
+if sys.platform != "win32":
+    MADV_NORMAL: int
+    MADV_RANDOM: int
+    MADV_SEQUENTIAL: int
+    MADV_WILLNEED: int
+    MADV_DONTNEED: int
+    MADV_FREE: int
+
+if sys.platform == "linux":
+    MADV_REMOVE: int
+    MADV_DONTFORK: int
+    MADV_DOFORK: int
+    MADV_HWPOISON: int
+    MADV_MERGEABLE: int
+    MADV_UNMERGEABLE: int
+    # Seems like this constant is not defined in glibc.
+    # See https://github.com/python/typeshed/pull/5360 for details
+    # MADV_SOFT_OFFLINE: int
+    MADV_HUGEPAGE: int
+    MADV_NOHUGEPAGE: int
+    MADV_DONTDUMP: int
+    MADV_DODUMP: int
+
+# This Values are defined for FreeBSD but type checkers do not support conditions for these
+if sys.platform != "linux" and sys.platform != "darwin" and sys.platform != "win32":
+    MADV_NOSYNC: int
+    MADV_AUTOSYNC: int
+    MADV_NOCORE: int
+    MADV_CORE: int
+    MADV_PROTECT: int
+
+if sys.version_info >= (3, 10) and sys.platform == "darwin":
+    MADV_FREE_REUSABLE: int
+    MADV_FREE_REUSE: int
+
+if sys.version_info >= (3, 13) and sys.platform != "win32":
+    MAP_32BIT: Final = 32768
+
+if sys.version_info >= (3, 13) and sys.platform == "darwin":
+    MAP_TPRO: Final = 524288