Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improvements for hidden types in the sys module #13031

Merged
merged 5 commits into from
Nov 18, 2024
Merged

improvements for hidden types in the sys module #13031

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6c9b3f
improvements for hidden types in the sys module
tungol Nov 17, 2024
5acb453
if/else correctly
tungol Nov 17, 2024
58c2d2a
Apply suggestions from code review
tungol Nov 18, 2024
625d8a1
update _FlagTuple for int_max_str_digits backport
tungol Nov 18, 2024
26a816f
don't rely on the length of sys.flags
tungol Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 110 additions & 8 deletions stdlib/sys/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ from builtins import object as _object
from collections.abc import AsyncGenerator, Callable, Sequence
from io import TextIOWrapper
from types import FrameType, ModuleType, TracebackType
from typing import Any, Final, Literal, NoReturn, Protocol, TextIO, TypeVar, final
from typing import Any, Final, Literal, NoReturn, Protocol, TextIO, TypeVar, final, type_check_only
from typing_extensions import TypeAlias

_T = TypeVar("_T")
Expand Down Expand Up @@ -90,13 +90,63 @@ _UninstantiableStructseq: TypeAlias = structseq[Any]

flags: _flags

if sys.version_info >= (3, 10):
_FlagTuple: TypeAlias = tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, bool, int, int]
else:
_FlagTuple: TypeAlias = tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, bool, int]

# This class is not exposed at runtime. It calls itself sys.flags.
# As a tuple, it can have a length between 15 and 18. We don't model
# the exact length here because that varies by patch version due to
# the backported security fix int_max_str_digits. The exact length shouldn't
# be relied upon. See #13031
# This can be re-visited when typeshed drops support for 3.10,
# at which point all supported versions will include int_max_str_digits
# in all patch versions.
# 3.8 and 3.9 are 15 or 16-tuple
# 3.10 is 16 or 17-tuple
# 3.11+ is an 18-tuple.
@final
class _flags(_UninstantiableStructseq, _FlagTuple):
@type_check_only
class _flags(_UninstantiableStructseq, tuple[int, ...]):
# `safe_path` was added in py311
if sys.version_info >= (3, 11):
tungol marked this conversation as resolved.
Show resolved Hide resolved
__match_args__: Final = (
"debug",
"inspect",
"interactive",
"optimize",
"dont_write_bytecode",
"no_user_site",
"no_site",
"ignore_environment",
"verbose",
"bytes_warning",
"quiet",
"hash_randomization",
"isolated",
"dev_mode",
"utf8_mode",
"warn_default_encoding",
"safe_path",
"int_max_str_digits",
)
elif sys.version_info >= (3, 10):
__match_args__: Final = (
"debug",
"inspect",
"interactive",
"optimize",
"dont_write_bytecode",
"no_user_site",
"no_site",
"ignore_environment",
"verbose",
"bytes_warning",
"quiet",
"hash_randomization",
"isolated",
"dev_mode",
"utf8_mode",
"warn_default_encoding",
"int_max_str_digits",
)

@property
def debug(self) -> int: ...
@property
Expand Down Expand Up @@ -129,15 +179,39 @@ class _flags(_UninstantiableStructseq, _FlagTuple):
def utf8_mode(self) -> int: ...
if sys.version_info >= (3, 10):
@property
def warn_default_encoding(self) -> int: ... # undocumented
def warn_default_encoding(self) -> int: ...
if sys.version_info >= (3, 11):
@property
def safe_path(self) -> bool: ...
# Whether or not this exists on lower versions of Python
# may depend on which patch release you're using
# (it was backported to all Python versions on 3.8+ as a security fix)
# Added in: 3.8.14, 3.9.14, 3.10.7
# and present in all versions of 3.11 and later.
@property
def int_max_str_digits(self) -> int: ...

float_info: _float_info

# This class is not exposed at runtime. It calls itself sys.float_info.
@final
@type_check_only
class _float_info(structseq[float], tuple[float, int, int, float, int, int, int, int, float, int, int]):
if sys.version_info >= (3, 10):
__match_args__: Final = (
"max",
"max_exp",
"max_10_exp",
"min",
"min_exp",
"min_10_exp",
"dig",
"mant_dig",
"epsilon",
"radix",
"rounds",
)

@property
def max(self) -> float: ... # DBL_MAX
@property
Expand All @@ -163,8 +237,13 @@ class _float_info(structseq[float], tuple[float, int, int, float, int, int, int,

hash_info: _hash_info

# This class is not exposed at runtime. It calls itself sys.hash_info.
@final
@type_check_only
class _hash_info(structseq[Any | int], tuple[int, int, int, int, int, str, int, int, int]):
if sys.version_info >= (3, 10):
__match_args__: Final = ("width", "modulus", "inf", "nan", "imag", "algorithm", "hash_bits", "seed_bits", "cutoff")

@property
def width(self) -> int: ...
@property
Expand All @@ -186,6 +265,9 @@ class _hash_info(structseq[Any | int], tuple[int, int, int, int, int, str, int,

implementation: _implementation

# This class isn't really a thing. At runtime, implementation is an instance
# of types.SimpleNamespace. This allows for better typing.
@type_check_only
class _implementation:
name: str
version: _version_info
Expand All @@ -198,8 +280,13 @@ class _implementation:

int_info: _int_info

# This class is not exposed at runtime. It calls itself sys.int_info.
@final
@type_check_only
class _int_info(structseq[int], tuple[int, int, int, int]):
if sys.version_info >= (3, 10):
__match_args__: Final = ("bits_per_digit", "sizeof_digit", "default_max_str_digits", "str_digits_check_threshold")

@property
def bits_per_digit(self) -> int: ...
@property
Expand All @@ -212,8 +299,13 @@ class _int_info(structseq[int], tuple[int, int, int, int]):
_ThreadInfoName: TypeAlias = Literal["nt", "pthread", "pthread-stubs", "solaris"]
_ThreadInfoLock: TypeAlias = Literal["semaphore", "mutex+cond"] | None

# This class is not exposed at runtime. It calls itself sys.thread_info.
@final
@type_check_only
class _thread_info(_UninstantiableStructseq, tuple[_ThreadInfoName, _ThreadInfoLock, str | None]):
if sys.version_info >= (3, 10):
__match_args__: Final = ("name", "lock", "version")

@property
def name(self) -> _ThreadInfoName: ...
@property
Expand All @@ -224,8 +316,13 @@ class _thread_info(_UninstantiableStructseq, tuple[_ThreadInfoName, _ThreadInfoL
thread_info: _thread_info
_ReleaseLevel: TypeAlias = Literal["alpha", "beta", "candidate", "final"]

# This class is not exposed at runtime. It calls itself sys.version_info.
@final
@type_check_only
class _version_info(_UninstantiableStructseq, tuple[int, int, int, _ReleaseLevel, int]):
if sys.version_info >= (3, 10):
__match_args__: Final = ("major", "minor", "micro", "releaselevel", "serial")

@property
def major(self) -> int: ...
@property
Expand Down Expand Up @@ -333,8 +430,13 @@ def audit(event: str, /, *args: Any) -> None: ...

_AsyncgenHook: TypeAlias = Callable[[AsyncGenerator[Any, Any]], None] | None

# This class is not exposed at runtime. It calls itself builtins.asyncgen_hooks.
@final
@type_check_only
class _asyncgen_hooks(structseq[_AsyncgenHook], tuple[_AsyncgenHook, _AsyncgenHook]):
if sys.version_info >= (3, 10):
__match_args__: Final = ("firstiter", "finalizer")

@property
def firstiter(self) -> _AsyncgenHook: ...
@property
Expand Down