Skip to content

covariant warnings.catch_warnings type-parameter with default #13675

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

Merged
srittau merged 2 commits into from
Mar 20, 2025
Merged

covariant warnings.catch_warnings type-parameter with default #13675

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72df055
use a covariant generic type parameter for `warnings.catch_warnings`
jorenham Mar 19, 2025
91e7793
set a default for the type-parameter of `warnings.catch_warnings`
jorenham Mar 19, 2025
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
17 changes: 8 additions & 9 deletions stdlib/warnings.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import sys
from _warnings import warn as warn, warn_explicit as warn_explicit
from collections.abc import Sequence
from types import ModuleType, TracebackType
from typing import Any, Generic, Literal, TextIO, TypeVar, overload
from typing_extensions import LiteralString, TypeAlias
from typing import Any, Generic, Literal, TextIO, overload
from typing_extensions import LiteralString, TypeAlias, TypeVar

__all__ = [
"warn",
Expand All @@ -21,7 +21,8 @@ if sys.version_info >= (3, 13):
__all__ += ["deprecated"]

_T = TypeVar("_T")
_W = TypeVar("_W", bound=list[WarningMessage] | None)
_W_co = TypeVar("_W_co", bound=list[WarningMessage] | None, default=list[WarningMessage] | None, covariant=True)

if sys.version_info >= (3, 14):
_ActionKind: TypeAlias = Literal["default", "error", "ignore", "always", "module", "once"]
else:
Expand Down Expand Up @@ -66,7 +67,7 @@ class WarningMessage:
source: Any | None = None,
) -> None: ...

class catch_warnings(Generic[_W]):
class catch_warnings(Generic[_W_co]):
if sys.version_info >= (3, 11):
@overload
def __init__(
Expand All @@ -92,7 +93,7 @@ class catch_warnings(Generic[_W]):
) -> None: ...
@overload
def __init__(
self: catch_warnings[list[WarningMessage] | None],
self,
*,
record: bool,
module: ModuleType | None = None,
Expand All @@ -109,11 +110,9 @@ class catch_warnings(Generic[_W]):
self: catch_warnings[list[WarningMessage]], *, record: Literal[True], module: ModuleType | None = None
) -> None: ...
@overload
def __init__(
self: catch_warnings[list[WarningMessage] | None], *, record: bool, module: ModuleType | None = None
) -> None: ...
def __init__(self, *, record: bool, module: ModuleType | None = None) -> None: ...

def __enter__(self) -> _W: ...
def __enter__(self) -> _W_co: ...
def __exit__(
self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None
) -> None: ...
Expand Down