closes: 10865 Fix muted exception (#11804)
* feat: 10865 * feat: 10865 refactor code and tests * feat: 10865 add test skip for pypy * feat: 10865 add test with valid warning * feat: 10865 fix v2 for codecov * feat: 10865 fix conflict
This commit is contained in:
parent
101328aba5
commit
9454fc38d3
1
AUTHORS
1
AUTHORS
|
@ -416,6 +416,7 @@ Vivaan Verma
|
||||||
Vlad Dragos
|
Vlad Dragos
|
||||||
Vlad Radziuk
|
Vlad Radziuk
|
||||||
Vladyslav Rachek
|
Vladyslav Rachek
|
||||||
|
Volodymyr Kochetkov
|
||||||
Volodymyr Piskun
|
Volodymyr Piskun
|
||||||
Wei Lin
|
Wei Lin
|
||||||
Wil Cooley
|
Wil Cooley
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
:func:`pytest.warns` now validates that warning object's ``message`` is of type `str` -- currently in Python it is possible to pass other types than `str` when creating `Warning` instances, however this causes an exception when :func:`warnings.filterwarnings` is used to filter those warnings. See `CPython #103577 <https://github.com/python/cpython/issues/103577>`__ for a discussion.
|
||||||
|
While this can be considered a bug in CPython, we decided to put guards in pytest as the error message produced without this check in place is confusing.
|
|
@ -329,3 +329,14 @@ class WarningsChecker(WarningsRecorder):
|
||||||
module=w.__module__,
|
module=w.__module__,
|
||||||
source=w.source,
|
source=w.source,
|
||||||
)
|
)
|
||||||
|
# Check warnings has valid argument type (#10865).
|
||||||
|
wrn: warnings.WarningMessage
|
||||||
|
for wrn in self:
|
||||||
|
self._validate_message(wrn)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _validate_message(wrn: Any) -> None:
|
||||||
|
if not isinstance(msg := wrn.message.args[0], str):
|
||||||
|
raise TypeError(
|
||||||
|
f"Warning message must be str, got {msg!r} (type {type(msg).__name__})"
|
||||||
|
)
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
# mypy: allow-untyped-defs
|
# mypy: allow-untyped-defs
|
||||||
|
import sys
|
||||||
from typing import List
|
from typing import List
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
from typing import Type
|
from typing import Type
|
||||||
|
@ -477,3 +478,29 @@ class TestWarns:
|
||||||
with pytest.raises(ValueError, match="some exception"):
|
with pytest.raises(ValueError, match="some exception"):
|
||||||
warnings.warn("some warning", category=FutureWarning)
|
warnings.warn("some warning", category=FutureWarning)
|
||||||
raise ValueError("some exception")
|
raise ValueError("some exception")
|
||||||
|
|
||||||
|
|
||||||
|
def test_raise_type_error_on_non_string_warning() -> None:
|
||||||
|
"""Check pytest.warns validates warning messages are strings (#10865)."""
|
||||||
|
with pytest.raises(TypeError, match="Warning message must be str"):
|
||||||
|
with pytest.warns(UserWarning):
|
||||||
|
warnings.warn(1) # type: ignore
|
||||||
|
|
||||||
|
|
||||||
|
def test_no_raise_type_error_on_string_warning() -> None:
|
||||||
|
"""Check pytest.warns validates warning messages are strings (#10865)."""
|
||||||
|
with pytest.warns(UserWarning):
|
||||||
|
warnings.warn("Warning")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.skipif(
|
||||||
|
hasattr(sys, "pypy_version_info"),
|
||||||
|
reason="Not for pypy",
|
||||||
|
)
|
||||||
|
def test_raise_type_error_on_non_string_warning_cpython() -> None:
|
||||||
|
# Check that we get the same behavior with the stdlib, at least if filtering
|
||||||
|
# (see https://github.com/python/cpython/issues/103577 for details)
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
with warnings.catch_warnings():
|
||||||
|
warnings.filterwarnings("ignore", "test")
|
||||||
|
warnings.warn(1) # type: ignore
|
||||||
|
|
Loading…
Reference in New Issue