Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-39912: Raise appropriate exceptions in filterwarnings() and simplefilter() #18878

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
merged 6 commits into from
Dec 1, 2023
Merged

bpo-39912: Raise appropriate exceptions in filterwarnings() and simplefilter() #18878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
82fe7b3
Raise appropriate exceptions in filterwarnings() and simplefilter()
remilapeyre Mar 9, 2020
22e475c
Merge category tests
Apr 8, 2020
f42eea5
Improve exception message
Apr 8, 2020
e0c105c
Merge branch 'main' into bpo-39912
serhiy-storchaka Dec 1, 2023
c90c08e
Apply suggestions from code review
serhiy-storchaka Dec 1, 2023
5a8a254
Update Lib/warnings.py
serhiy-storchaka Dec 1, 2023
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
22 changes: 22 additions & 0 deletions Lib/test/test_warnings/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,28 @@ def test_append_duplicate(self):
"appended duplicate changed order of filters"
)

def test_argument_validation(self):
with self.assertRaises(ValueError):
self.module.filterwarnings(action='foo')
with self.assertRaises(TypeError):
self.module.filterwarnings('ignore', message=0)
with self.assertRaises(TypeError):
self.module.filterwarnings('ignore', category=0)
with self.assertRaises(TypeError):
self.module.filterwarnings('ignore', category=int)
with self.assertRaises(TypeError):
self.module.filterwarnings('ignore', module=0)
with self.assertRaises(TypeError):
self.module.filterwarnings('ignore', lineno=int)
with self.assertRaises(ValueError):
self.module.filterwarnings('ignore', lineno=-1)
with self.assertRaises(ValueError):
self.module.simplefilter(action='foo')
with self.assertRaises(TypeError):
self.module.simplefilter('ignore', lineno=int)
with self.assertRaises(ValueError):
self.module.simplefilter('ignore', lineno=-1)

def test_catchwarnings_with_simplefilter_ignore(self):
with original_warnings.catch_warnings(module=self.module):
self.module.resetwarnings()
Expand Down
30 changes: 18 additions & 12 deletions Lib/warnings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,14 +139,18 @@ def filterwarnings(action, message="", category=Warning, module="", lineno=0,
'lineno' -- an integer line number, 0 matches all warnings
'append' -- if true, append to the list of filters
"""
assert action in ("error", "ignore", "always", "default", "module",
"once"), "invalid action: %r" % (action,)
assert isinstance(message, str), "message must be a string"
assert isinstance(category, type), "category must be a class"
assert issubclass(category, Warning), "category must be a Warning subclass"
assert isinstance(module, str), "module must be a string"
assert isinstance(lineno, int) and lineno >= 0, \
"lineno must be an int >= 0"
if action not in {"error", "ignore", "always", "default", "module", "once"}:
raise ValueError(f"invalid action: {action!r}")
if not isinstance(message, str):
raise TypeError("message must be a string")
if not isinstance(category, type) or not issubclass(category, Warning):
raise TypeError("category must be a Warning subclass")
if not isinstance(module, str):
raise TypeError("module must be a string")
if not isinstance(lineno, int):
raise TypeError("lineno must be an int")
if lineno < 0:
raise ValueError("lineno must be an int >= 0")

if message or module:
import re
Expand All @@ -172,10 +176,12 @@ def simplefilter(action, category=Warning, lineno=0, append=False):
'lineno' -- an integer line number, 0 matches all warnings
'append' -- if true, append to the list of filters
"""
assert action in ("error", "ignore", "always", "default", "module",
"once"), "invalid action: %r" % (action,)
assert isinstance(lineno, int) and lineno >= 0, \
"lineno must be an int >= 0"
if action not in {"error", "ignore", "always", "default", "module", "once"}:
raise ValueError(f"invalid action: {action!r}")
if not isinstance(lineno, int):
raise TypeError("lineno must be an int")
if lineno < 0:
raise ValueError("lineno must be an int >= 0")
_add_filter(action, None, category, None, lineno, append=append)

def _add_filter(*item, append):
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2020-03-09-15-08-29.bpo-39912.xPOBBY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:func:`warnings.filterwarnings()` and :func:`warnings.simplefilter()` now raise
appropriate exceptions instead of ``AssertionError``. Patch contributed by
Rémi Lapeyre.