Use Final for Constant Literals in the stdlib (#12332)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

stdlib/@tests/stubtest_allowlists/linux-py313.txt

@@ -1,5 +1,4 @@
 # TODO: triage these (new in py313)
-_stat.SF_SETTABLE
 _stat.SF_SUPPORTED
 _stat.SF_SYNTHETIC
 fcntl.F_GETOWN_EX
@@ -49,7 +48,6 @@ posix.timerfd_settime
 posix.timerfd_settime_ns
 posix.unlockpt
 readline.backend
-stat.SF_SETTABLE
 stat.SF_SUPPORTED
 stat.SF_SYNTHETIC
 syslog.LOG_INSTALL

stdlib/@tests/stubtest_allowlists/win32-py313.txt

@@ -1,6 +1,5 @@
 # New in py313 (triage these!)
 _msi
-_stat.SF_SETTABLE
 _stat.SF_SUPPORTED
 _stat.SF_SYNTHETIC
 _winapi.BatchedWaitForMultipleObjects
@@ -36,7 +35,6 @@ os.fchmod
 os.lchmod
 os.path.exists
 os.path.lexists
-stat.SF_SETTABLE
 stat.SF_SUPPORTED
 stat.SF_SYNTHETIC
 subprocess.__all__

stdlib/_csv.pyi

@@ -1,18 +1,18 @@
 import sys
 from _typeshed import SupportsWrite
 from collections.abc import Iterable, Iterator
-from typing import Any, Final, Literal
+from typing import Any, Final
 from typing_extensions import TypeAlias
 
 __version__: Final[str]
 
-QUOTE_ALL: Literal[1]
-QUOTE_MINIMAL: Literal[0]
-QUOTE_NONE: Literal[3]
-QUOTE_NONNUMERIC: Literal[2]
+QUOTE_ALL: Final = 1
+QUOTE_MINIMAL: Final = 0
+QUOTE_NONE: Final = 3
+QUOTE_NONNUMERIC: Final = 2
 if sys.version_info >= (3, 12):
- QUOTE_STRINGS: Literal[4]
- QUOTE_NOTNULL: Literal[5]
+ QUOTE_STRINGS: Final = 4
+ QUOTE_NOTNULL: Final = 5
 
 # Ideally this would be `QUOTE_ALL | QUOTE_MINIMAL | QUOTE_NONE | QUOTE_NONNUMERIC`
 # However, using literals in situations like these can cause false-positives (see #7258)

stdlib/_stat.pyi

@@ -1,68 +1,68 @@
 import sys
-from typing import Literal
-
-SF_APPEND: Literal[0x00040000]
-SF_ARCHIVED: Literal[0x00010000]
-SF_IMMUTABLE: Literal[0x00020000]
-SF_NOUNLINK: Literal[0x00100000]
-SF_SNAPSHOT: Literal[0x00200000]
-
-ST_MODE: Literal[0]
-ST_INO: Literal[1]
-ST_DEV: Literal[2]
-ST_NLINK: Literal[3]
-ST_UID: Literal[4]
-ST_GID: Literal[5]
-ST_SIZE: Literal[6]
-ST_ATIME: Literal[7]
-ST_MTIME: Literal[8]
-ST_CTIME: Literal[9]
-
-S_IFIFO: Literal[0o010000]
-S_IFLNK: Literal[0o120000]
-S_IFREG: Literal[0o100000]
-S_IFSOCK: Literal[0o140000]
-S_IFBLK: Literal[0o060000]
-S_IFCHR: Literal[0o020000]
-S_IFDIR: Literal[0o040000]
+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: int
 S_IFPORT: int
 S_IFWHT: int
 
-S_ISUID: Literal[0o4000]
-S_ISGID: Literal[0o2000]
-S_ISVTX: Literal[0o1000]
-
-S_IRWXU: Literal[0o0700]
-S_IRUSR: Literal[0o0400]
-S_IWUSR: Literal[0o0200]
-S_IXUSR: Literal[0o0100]
-
-S_IRWXG: Literal[0o0070]
-S_IRGRP: Literal[0o0040]
-S_IWGRP: Literal[0o0020]
-S_IXGRP: Literal[0o0010]
-
-S_IRWXO: Literal[0o0007]
-S_IROTH: Literal[0o0004]
-S_IWOTH: Literal[0o0002]
-S_IXOTH: Literal[0o0001]
-
-S_ENFMT: Literal[0o2000]
-S_IREAD: Literal[0o0400]
-S_IWRITE: Literal[0o0200]
-S_IEXEC: Literal[0o0100]
-
-UF_APPEND: Literal[0x00000004]
-UF_COMPRESSED: Literal[0x00000020] # OS X 10.6+ only
-UF_HIDDEN: Literal[0x00008000] # OX X 10.5+ only
-UF_IMMUTABLE: Literal[0x00000002]
-UF_NODUMP: Literal[0x00000001]
-UF_NOUNLINK: Literal[0x00000010]
-UF_OPAQUE: Literal[0x00000008]
+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: ...
 def S_IFMT(mode: int, /) -> int: ...
@@ -84,34 +84,35 @@ if sys.platform == "win32":
  IO_REPARSE_TAG_APPEXECLINK: int
 
 if sys.platform == "win32":
- FILE_ATTRIBUTE_ARCHIVE: Literal[32]
- FILE_ATTRIBUTE_COMPRESSED: Literal[2048]
- FILE_ATTRIBUTE_DEVICE: Literal[64]
- FILE_ATTRIBUTE_DIRECTORY: Literal[16]
- FILE_ATTRIBUTE_ENCRYPTED: Literal[16384]
- FILE_ATTRIBUTE_HIDDEN: Literal[2]
- FILE_ATTRIBUTE_INTEGRITY_STREAM: Literal[32768]
- FILE_ATTRIBUTE_NORMAL: Literal[128]
- FILE_ATTRIBUTE_NOT_CONTENT_INDEXED: Literal[8192]
- FILE_ATTRIBUTE_NO_SCRUB_DATA: Literal[131072]
- FILE_ATTRIBUTE_OFFLINE: Literal[4096]
- FILE_ATTRIBUTE_READONLY: Literal[1]
- FILE_ATTRIBUTE_REPARSE_POINT: Literal[1024]
- FILE_ATTRIBUTE_SPARSE_FILE: Literal[512]
- FILE_ATTRIBUTE_SYSTEM: Literal[4]
- FILE_ATTRIBUTE_TEMPORARY: Literal[256]
- FILE_ATTRIBUTE_VIRTUAL: Literal[65536]
+ 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):
- SF_SETTABLE: Literal[0x3FFF0000]
+ # Varies by platform.
+ SF_SETTABLE: Final[int]
  # https://github.com/python/cpython/issues/114081#issuecomment-2119017790
  # SF_RESTRICTED: Literal[0x00080000]
- SF_FIRMLINK: Literal[0x00800000]
- SF_DATALESS: Literal[0x40000000]
+ SF_FIRMLINK: Final = 0x00800000
+ SF_DATALESS: Final = 0x40000000
 
- SF_SUPPORTED: Literal[0x9F0000]
- SF_SYNTHETIC: Literal[0xC0000000]
+ SF_SUPPORTED: Final = 0x9F0000
+ SF_SYNTHETIC: Final = 0xC0000000
 
- UF_TRACKED: Literal[0x00000040]
- UF_DATAVAULT: Literal[0x00000080]
- UF_SETTABLE: Literal[0x0000FFFF]
+ UF_TRACKED: Final = 0x00000040
+ UF_DATAVAULT: Final = 0x00000080
+ UF_SETTABLE: Final = 0x0000FFFF

stdlib/_tkinter.pyi

@@ -1,6 +1,6 @@
 import sys
 from collections.abc import Callable
-from typing import Any, ClassVar, Literal, final
+from typing import Any, ClassVar, Final, final
 from typing_extensions import TypeAlias
 
 # _tkinter is meant to be only used internally by tkinter, but some tkinter
@@ -95,16 +95,16 @@ class TkappType:
  def settrace(self, func: _TkinterTraceFunc | None, /) -> None: ...
 
 # These should be kept in sync with tkinter.tix constants, except ALL_EVENTS which doesn't match TCL_ALL_EVENTS
-ALL_EVENTS: Literal[-3]
-FILE_EVENTS: Literal[8]
-IDLE_EVENTS: Literal[32]
-TIMER_EVENTS: Literal[16]
-WINDOW_EVENTS: Literal[4]
+ALL_EVENTS: Final = -3
+FILE_EVENTS: Final = 8
+IDLE_EVENTS: Final = 32
+TIMER_EVENTS: Final = 16
+WINDOW_EVENTS: Final = 4
 
-DONT_WAIT: Literal[2]
-EXCEPTION: Literal[8]
-READABLE: Literal[2]
-WRITABLE: Literal[4]
+DONT_WAIT: Final = 2
+EXCEPTION: Final = 8
+READABLE: Final = 2
+WRITABLE: Final = 4
 
 TCL_VERSION: str
 TK_VERSION: str