basedpyright 1.1.389 → 1.1.392

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

@@ -1,257 +1,257 @@
-"""
-S_IFMT_: file type bits
-S_IFDIR: directory
-S_IFCHR: character device
-S_IFBLK: block device
-S_IFREG: regular file
-S_IFIFO: fifo (named pipe)
-S_IFLNK: symbolic link
-S_IFSOCK: socket file
-S_IFDOOR: door
-S_IFPORT: event port
-S_IFWHT: whiteout
-
-S_ISUID: set UID bit
-S_ISGID: set GID bit
-S_ENFMT: file locking enforcement
-S_ISVTX: sticky bit
-S_IREAD: Unix V7 synonym for S_IRUSR
-S_IWRITE: Unix V7 synonym for S_IWUSR
-S_IEXEC: Unix V7 synonym for S_IXUSR
-S_IRWXU: mask for owner permissions
-S_IRUSR: read by owner
-S_IWUSR: write by owner
-S_IXUSR: execute by owner
-S_IRWXG: mask for group permissions
-S_IRGRP: read by group
-S_IWGRP: write by group
-S_IXGRP: execute by group
-S_IRWXO: mask for others (not in group) permissions
-S_IROTH: read by others
-S_IWOTH: write by others
-S_IXOTH: execute by others
-
-UF_SETTABLE: mask of owner changable flags
-UF_NODUMP: do not dump file
-UF_IMMUTABLE: file may not be changed
-UF_APPEND: file may only be appended to
-UF_OPAQUE: directory is opaque when viewed through a union stack
-UF_NOUNLINK: file may not be renamed or deleted
-UF_COMPRESSED: macOS: file is hfs-compressed
-UF_TRACKED: used for dealing with document IDs
-UF_DATAVAULT: entitlement required for reading and writing
-UF_HIDDEN: macOS: file should not be displayed
-SF_SETTABLE: mask of super user changeable flags
-SF_ARCHIVED: file may be archived
-SF_IMMUTABLE: file may not be changed
-SF_APPEND: file may only be appended to
-SF_RESTRICTED: entitlement required for writing
-SF_NOUNLINK: file may not be renamed or deleted
-SF_SNAPSHOT: file is a snapshot file
-SF_FIRMLINK: file is a firmlink
-SF_DATALESS: file is a dataless object
-
-On macOS:
-SF_SUPPORTED: mask of super user supported flags
-SF_SYNTHETIC: mask of read-only synthetic flags
-
-ST_MODE
-ST_INO
-ST_DEV
-ST_NLINK
-ST_UID
-ST_GID
-ST_SIZE
-ST_ATIME
-ST_MTIME
-ST_CTIME
-
-FILE_ATTRIBUTE_*: Windows file attribute constants
-                   (only present on Windows)
-"""
-
-import sys
-from typing import Final
-
-SF_APPEND: Final = 0x00040000
-SF_ARCHIVED: Final = 0x00010000
-SF_IMMUTABLE: Final = 0x00020000
-SF_NOUNLINK: Final = 0x00100000
-SF_SNAPSHOT: Final = 0x00200000
-
-ST_MODE: Final = 0
-ST_INO: Final = 1
-ST_DEV: Final = 2
-ST_NLINK: Final = 3
-ST_UID: Final = 4
-ST_GID: Final = 5
-ST_SIZE: Final = 6
-ST_ATIME: Final = 7
-ST_MTIME: Final = 8
-ST_CTIME: Final = 9
-
-S_IFIFO: Final = 0o010000
-S_IFLNK: Final = 0o120000
-S_IFREG: Final = 0o100000
-S_IFSOCK: Final = 0o140000
-S_IFBLK: Final = 0o060000
-S_IFCHR: Final = 0o020000
-S_IFDIR: Final = 0o040000
-
-# These are 0 on systems that don't support the specific kind of file.
-# Example: Linux doesn't support door files, so S_IFDOOR is 0 on linux.
-S_IFDOOR: Final[int]
-S_IFPORT: Final[int]
-S_IFWHT: Final[int]
-
-S_ISUID: Final = 0o4000
-S_ISGID: Final = 0o2000
-S_ISVTX: Final = 0o1000
-
-S_IRWXU: Final = 0o0700
-S_IRUSR: Final = 0o0400
-S_IWUSR: Final = 0o0200
-S_IXUSR: Final = 0o0100
-
-S_IRWXG: Final = 0o0070
-S_IRGRP: Final = 0o0040
-S_IWGRP: Final = 0o0020
-S_IXGRP: Final = 0o0010
-
-S_IRWXO: Final = 0o0007
-S_IROTH: Final = 0o0004
-S_IWOTH: Final = 0o0002
-S_IXOTH: Final = 0o0001
-
-S_ENFMT: Final = 0o2000
-S_IREAD: Final = 0o0400
-S_IWRITE: Final = 0o0200
-S_IEXEC: Final = 0o0100
-
-UF_APPEND: Final = 0x00000004
-UF_COMPRESSED: Final = 0x00000020  # OS X 10.6+ only
-UF_HIDDEN: Final = 0x00008000  # OX X 10.5+ only
-UF_IMMUTABLE: Final = 0x00000002
-UF_NODUMP: Final = 0x00000001
-UF_NOUNLINK: Final = 0x00000010
-UF_OPAQUE: Final = 0x00000008
-
-def S_IMODE(mode: int, /) -> int:
-    """Return the portion of the file's mode that can be set by os.chmod()."""
-    ...
-def S_IFMT(mode: int, /) -> int:
-    """Return the portion of the file's mode that describes the file type."""
-    ...
-def S_ISBLK(mode: int, /) -> bool:
-    """
-    S_ISBLK(mode) -> bool
-
-    Return True if mode is from a block special device file.
-    """
-    ...
-def S_ISCHR(mode: int, /) -> bool:
-    """
-    S_ISCHR(mode) -> bool
-
-    Return True if mode is from a character special device file.
-    """
-    ...
-def S_ISDIR(mode: int, /) -> bool:
-    """
-    S_ISDIR(mode) -> bool
-
-    Return True if mode is from a directory.
-    """
-    ...
-def S_ISDOOR(mode: int, /) -> bool:
-    """
-    S_ISDOOR(mode) -> bool
-
-    Return True if mode is from a door.
-    """
-    ...
-def S_ISFIFO(mode: int, /) -> bool:
-    """
-    S_ISFIFO(mode) -> bool
-
-    Return True if mode is from a FIFO (named pipe).
-    """
-    ...
-def S_ISLNK(mode: int, /) -> bool:
-    """
-    S_ISLNK(mode) -> bool
-
-    Return True if mode is from a symbolic link.
-    """
-    ...
-def S_ISPORT(mode: int, /) -> bool:
-    """
-    S_ISPORT(mode) -> bool
-
-    Return True if mode is from an event port.
-    """
-    ...
-def S_ISREG(mode: int, /) -> bool:
-    """
-    S_ISREG(mode) -> bool
-
-    Return True if mode is from a regular file.
-    """
-    ...
-def S_ISSOCK(mode: int, /) -> bool:
-    """
-    S_ISSOCK(mode) -> bool
-
-    Return True if mode is from a socket.
-    """
-    ...
-def S_ISWHT(mode: int, /) -> bool:
-    """
-    S_ISWHT(mode) -> bool
-
-    Return True if mode is from a whiteout.
-    """
-    ...
-def filemode(mode: int, /) -> str:
-    """Convert a file's mode to a string of the form '-rwxrwxrwx'"""
-    ...
-
-if sys.platform == "win32":
-    IO_REPARSE_TAG_SYMLINK: Final = 0xA000000C
-    IO_REPARSE_TAG_MOUNT_POINT: Final = 0xA0000003
-    IO_REPARSE_TAG_APPEXECLINK: Final = 0x8000001B
-
-if sys.platform == "win32":
-    FILE_ATTRIBUTE_ARCHIVE: Final = 32
-    FILE_ATTRIBUTE_COMPRESSED: Final = 2048
-    FILE_ATTRIBUTE_DEVICE: Final = 64
-    FILE_ATTRIBUTE_DIRECTORY: Final = 16
-    FILE_ATTRIBUTE_ENCRYPTED: Final = 16384
-    FILE_ATTRIBUTE_HIDDEN: Final = 2
-    FILE_ATTRIBUTE_INTEGRITY_STREAM: Final = 32768
-    FILE_ATTRIBUTE_NORMAL: Final = 128
-    FILE_ATTRIBUTE_NOT_CONTENT_INDEXED: Final = 8192
-    FILE_ATTRIBUTE_NO_SCRUB_DATA: Final = 131072
-    FILE_ATTRIBUTE_OFFLINE: Final = 4096
-    FILE_ATTRIBUTE_READONLY: Final = 1
-    FILE_ATTRIBUTE_REPARSE_POINT: Final = 1024
-    FILE_ATTRIBUTE_SPARSE_FILE: Final = 512
-    FILE_ATTRIBUTE_SYSTEM: Final = 4
-    FILE_ATTRIBUTE_TEMPORARY: Final = 256
-    FILE_ATTRIBUTE_VIRTUAL: Final = 65536
-
-if sys.version_info >= (3, 13):
-    # Varies by platform.
-    SF_SETTABLE: Final[int]
-    # https://github.com/python/cpython/issues/114081#issuecomment-2119017790
-    # SF_RESTRICTED: Literal[0x00080000]
-    SF_FIRMLINK: Final = 0x00800000
-    SF_DATALESS: Final = 0x40000000
-
-    if sys.platform == "darwin":
-        SF_SUPPORTED: Final = 0x9F0000
-        SF_SYNTHETIC: Final = 0xC0000000
-
-    UF_TRACKED: Final = 0x00000040
-    UF_DATAVAULT: Final = 0x00000080
-    UF_SETTABLE: Final = 0x0000FFFF
+"""
+S_IFMT_: file type bits
+S_IFDIR: directory
+S_IFCHR: character device
+S_IFBLK: block device
+S_IFREG: regular file
+S_IFIFO: fifo (named pipe)
+S_IFLNK: symbolic link
+S_IFSOCK: socket file
+S_IFDOOR: door
+S_IFPORT: event port
+S_IFWHT: whiteout
+
+S_ISUID: set UID bit
+S_ISGID: set GID bit
+S_ENFMT: file locking enforcement
+S_ISVTX: sticky bit
+S_IREAD: Unix V7 synonym for S_IRUSR
+S_IWRITE: Unix V7 synonym for S_IWUSR
+S_IEXEC: Unix V7 synonym for S_IXUSR
+S_IRWXU: mask for owner permissions
+S_IRUSR: read by owner
+S_IWUSR: write by owner
+S_IXUSR: execute by owner
+S_IRWXG: mask for group permissions
+S_IRGRP: read by group
+S_IWGRP: write by group
+S_IXGRP: execute by group
+S_IRWXO: mask for others (not in group) permissions
+S_IROTH: read by others
+S_IWOTH: write by others
+S_IXOTH: execute by others
+
+UF_SETTABLE: mask of owner changable flags
+UF_NODUMP: do not dump file
+UF_IMMUTABLE: file may not be changed
+UF_APPEND: file may only be appended to
+UF_OPAQUE: directory is opaque when viewed through a union stack
+UF_NOUNLINK: file may not be renamed or deleted
+UF_COMPRESSED: macOS: file is hfs-compressed
+UF_TRACKED: used for dealing with document IDs
+UF_DATAVAULT: entitlement required for reading and writing
+UF_HIDDEN: macOS: file should not be displayed
+SF_SETTABLE: mask of super user changeable flags
+SF_ARCHIVED: file may be archived
+SF_IMMUTABLE: file may not be changed
+SF_APPEND: file may only be appended to
+SF_RESTRICTED: entitlement required for writing
+SF_NOUNLINK: file may not be renamed or deleted
+SF_SNAPSHOT: file is a snapshot file
+SF_FIRMLINK: file is a firmlink
+SF_DATALESS: file is a dataless object
+
+On macOS:
+SF_SUPPORTED: mask of super user supported flags
+SF_SYNTHETIC: mask of read-only synthetic flags
+
+ST_MODE
+ST_INO
+ST_DEV
+ST_NLINK
+ST_UID
+ST_GID
+ST_SIZE
+ST_ATIME
+ST_MTIME
+ST_CTIME
+
+FILE_ATTRIBUTE_*: Windows file attribute constants
+                   (only present on Windows)
+"""
+
+import sys
+from typing import Final
+
+SF_APPEND: Final = 0x00040000
+SF_ARCHIVED: Final = 0x00010000
+SF_IMMUTABLE: Final = 0x00020000
+SF_NOUNLINK: Final = 0x00100000
+SF_SNAPSHOT: Final = 0x00200000
+
+ST_MODE: Final = 0
+ST_INO: Final = 1
+ST_DEV: Final = 2
+ST_NLINK: Final = 3
+ST_UID: Final = 4
+ST_GID: Final = 5
+ST_SIZE: Final = 6
+ST_ATIME: Final = 7
+ST_MTIME: Final = 8
+ST_CTIME: Final = 9
+
+S_IFIFO: Final = 0o010000
+S_IFLNK: Final = 0o120000
+S_IFREG: Final = 0o100000
+S_IFSOCK: Final = 0o140000
+S_IFBLK: Final = 0o060000
+S_IFCHR: Final = 0o020000
+S_IFDIR: Final = 0o040000
+
+# These are 0 on systems that don't support the specific kind of file.
+# Example: Linux doesn't support door files, so S_IFDOOR is 0 on linux.
+S_IFDOOR: Final[int]
+S_IFPORT: Final[int]
+S_IFWHT: Final[int]
+
+S_ISUID: Final = 0o4000
+S_ISGID: Final = 0o2000
+S_ISVTX: Final = 0o1000
+
+S_IRWXU: Final = 0o0700
+S_IRUSR: Final = 0o0400
+S_IWUSR: Final = 0o0200
+S_IXUSR: Final = 0o0100
+
+S_IRWXG: Final = 0o0070
+S_IRGRP: Final = 0o0040
+S_IWGRP: Final = 0o0020
+S_IXGRP: Final = 0o0010
+
+S_IRWXO: Final = 0o0007
+S_IROTH: Final = 0o0004
+S_IWOTH: Final = 0o0002
+S_IXOTH: Final = 0o0001
+
+S_ENFMT: Final = 0o2000
+S_IREAD: Final = 0o0400
+S_IWRITE: Final = 0o0200
+S_IEXEC: Final = 0o0100
+
+UF_APPEND: Final = 0x00000004
+UF_COMPRESSED: Final = 0x00000020  # OS X 10.6+ only
+UF_HIDDEN: Final = 0x00008000  # OX X 10.5+ only
+UF_IMMUTABLE: Final = 0x00000002
+UF_NODUMP: Final = 0x00000001
+UF_NOUNLINK: Final = 0x00000010
+UF_OPAQUE: Final = 0x00000008
+
+def S_IMODE(mode: int, /) -> int:
+    """Return the portion of the file's mode that can be set by os.chmod()."""
+    ...
+def S_IFMT(mode: int, /) -> int:
+    """Return the portion of the file's mode that describes the file type."""
+    ...
+def S_ISBLK(mode: int, /) -> bool:
+    """
+    S_ISBLK(mode) -> bool
+
+    Return True if mode is from a block special device file.
+    """
+    ...
+def S_ISCHR(mode: int, /) -> bool:
+    """
+    S_ISCHR(mode) -> bool
+
+    Return True if mode is from a character special device file.
+    """
+    ...
+def S_ISDIR(mode: int, /) -> bool:
+    """
+    S_ISDIR(mode) -> bool
+
+    Return True if mode is from a directory.
+    """
+    ...
+def S_ISDOOR(mode: int, /) -> bool:
+    """
+    S_ISDOOR(mode) -> bool
+
+    Return True if mode is from a door.
+    """
+    ...
+def S_ISFIFO(mode: int, /) -> bool:
+    """
+    S_ISFIFO(mode) -> bool
+
+    Return True if mode is from a FIFO (named pipe).
+    """
+    ...
+def S_ISLNK(mode: int, /) -> bool:
+    """
+    S_ISLNK(mode) -> bool
+
+    Return True if mode is from a symbolic link.
+    """
+    ...
+def S_ISPORT(mode: int, /) -> bool:
+    """
+    S_ISPORT(mode) -> bool
+
+    Return True if mode is from an event port.
+    """
+    ...
+def S_ISREG(mode: int, /) -> bool:
+    """
+    S_ISREG(mode) -> bool
+
+    Return True if mode is from a regular file.
+    """
+    ...
+def S_ISSOCK(mode: int, /) -> bool:
+    """
+    S_ISSOCK(mode) -> bool
+
+    Return True if mode is from a socket.
+    """
+    ...
+def S_ISWHT(mode: int, /) -> bool:
+    """
+    S_ISWHT(mode) -> bool
+
+    Return True if mode is from a whiteout.
+    """
+    ...
+def filemode(mode: int, /) -> str:
+    """Convert a file's mode to a string of the form '-rwxrwxrwx'"""
+    ...
+
+if sys.platform == "win32":
+    IO_REPARSE_TAG_SYMLINK: Final = 0xA000000C
+    IO_REPARSE_TAG_MOUNT_POINT: Final = 0xA0000003
+    IO_REPARSE_TAG_APPEXECLINK: Final = 0x8000001B
+
+if sys.platform == "win32":
+    FILE_ATTRIBUTE_ARCHIVE: Final = 32
+    FILE_ATTRIBUTE_COMPRESSED: Final = 2048
+    FILE_ATTRIBUTE_DEVICE: Final = 64
+    FILE_ATTRIBUTE_DIRECTORY: Final = 16
+    FILE_ATTRIBUTE_ENCRYPTED: Final = 16384
+    FILE_ATTRIBUTE_HIDDEN: Final = 2
+    FILE_ATTRIBUTE_INTEGRITY_STREAM: Final = 32768
+    FILE_ATTRIBUTE_NORMAL: Final = 128
+    FILE_ATTRIBUTE_NOT_CONTENT_INDEXED: Final = 8192
+    FILE_ATTRIBUTE_NO_SCRUB_DATA: Final = 131072
+    FILE_ATTRIBUTE_OFFLINE: Final = 4096
+    FILE_ATTRIBUTE_READONLY: Final = 1
+    FILE_ATTRIBUTE_REPARSE_POINT: Final = 1024
+    FILE_ATTRIBUTE_SPARSE_FILE: Final = 512
+    FILE_ATTRIBUTE_SYSTEM: Final = 4
+    FILE_ATTRIBUTE_TEMPORARY: Final = 256
+    FILE_ATTRIBUTE_VIRTUAL: Final = 65536
+
+if sys.version_info >= (3, 13):
+    # Varies by platform.
+    SF_SETTABLE: Final[int]
+    # https://github.com/python/cpython/issues/114081#issuecomment-2119017790
+    # SF_RESTRICTED: Literal[0x00080000]
+    SF_FIRMLINK: Final = 0x00800000
+    SF_DATALESS: Final = 0x40000000
+
+    if sys.platform == "darwin":
+        SF_SUPPORTED: Final = 0x9F0000
+        SF_SYNTHETIC: Final = 0xC0000000
+
+    UF_TRACKED: Final = 0x00000040
+    UF_DATAVAULT: Final = 0x00000080
+    UF_SETTABLE: Final = 0x0000FFFF