Files
typeshed/stdlib/warnings.pyi
2022-01-08 16:09:29 +01:00

63 lines
2.3 KiB
Python

from _warnings import warn as warn, warn_explicit as warn_explicit
from types import ModuleType, TracebackType
from typing import Any, Sequence, TextIO, overload
from typing_extensions import Literal
_ActionKind = Literal["default", "error", "ignore", "always", "module", "once"]
filters: Sequence[tuple[str, str | None, type[Warning], str | None, int]] # undocumented, do not mutate
def showwarning(
message: Warning | str, category: type[Warning], filename: str, lineno: int, file: TextIO | None = ..., line: str | None = ...
) -> None: ...
def formatwarning(message: Warning | str, category: type[Warning], filename: str, lineno: int, line: str | None = ...) -> str: ...
def filterwarnings(
action: _ActionKind,
message: str = ...,
category: type[Warning] = ...,
module: str = ...,
lineno: int = ...,
append: bool = ...,
) -> None: ...
def simplefilter(action: _ActionKind, category: type[Warning] = ..., lineno: int = ..., append: bool = ...) -> None: ...
def resetwarnings() -> None: ...
class _OptionError(Exception): ...
class WarningMessage:
message: Warning | str
category: type[Warning]
filename: str
lineno: int
file: TextIO | None
line: str | None
source: Any | None
def __init__(
self,
message: Warning | str,
category: type[Warning],
filename: str,
lineno: int,
file: TextIO | None = ...,
line: str | None = ...,
source: Any | None = ...,
) -> None: ...
class catch_warnings:
@overload
def __new__(cls, *, record: Literal[False] = ..., module: ModuleType | None = ...) -> _catch_warnings_without_records: ...
@overload
def __new__(cls, *, record: Literal[True], module: ModuleType | None = ...) -> _catch_warnings_with_records: ...
@overload
def __new__(cls, *, record: bool, module: ModuleType | None = ...) -> catch_warnings: ...
def __enter__(self) -> list[WarningMessage] | None: ...
def __exit__(
self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None
) -> None: ...
class _catch_warnings_without_records(catch_warnings):
def __enter__(self) -> None: ...
class _catch_warnings_with_records(catch_warnings):
def __enter__(self) -> list[WarningMessage]: ...