Skip to content

gh-125893: Add type check for category argument in warnings.simplefilter and warnings.filterwarning #136305

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

gh-125893: Add type check for category argument in warnings.simplefilter and warnings.filterwarning #136305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4edb4c7
Fix: Add type check for category in warning.simplefilter & warning.fi…
hasrat17 Jul 4, 2025
022e4b3
Added testcase and refactored warning logic for debug
hasrat17 Jul 10, 2025
de55c4f
Merge branch 'main' into fix-warnings-simplefilter-filterwarnings
hasrat17 Jul 10, 2025
e51c00e
Merge branch 'main' into fix-warnings-simplefilter-filterwarnings
hasrat17 Jul 24, 2025
e8e6b31
Update Misc/NEWS.d/next/Windows/2025-07-10-19-28-11.gh-issue-125893.l…
hasrat17 Aug 13, 2025
656ec39
Merge branch 'main' into fix-warnings-simplefilter-filterwarnings
hasrat17 Aug 13, 2025
00eb17c
Update _valid_warning_category and test for debug mode
hasrat17 Aug 13, 2025
2a28591
Update 2025-07-10-19-28-11.gh-issue-125893.lD8Nyd.rst
hasrat17 Aug 13, 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
21 changes: 19 additions & 2 deletions Lib/_py_warnings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,19 @@ def _formatwarnmsg(msg):
msg.filename, msg.lineno, msg.line)
return _wm._formatwarnmsg_impl(msg)

def _valid_warning_category(category):
"""
Return True if category is a Warning subclass or tuple of such.
Always perform class checks; only perform tuple iteration in debug mode.
"""
if not __debug__:
return True
if isinstance(category, type) and issubclass(category, Warning):
return True
if isinstance(category, tuple):
return all(isinstance(c, type) and issubclass(c, Warning)
for c in category)
return False

def filterwarnings(action, message="", category=Warning, module="", lineno=0,
append=False):
Expand All @@ -267,8 +280,9 @@ def filterwarnings(action, message="", category=Warning, module="", lineno=0,
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 _valid_warning_category(category):
raise TypeError("category must be a Warning subclass, "
"not '{:s}'".format(type(category).__name__))
if not isinstance(module, str):
raise TypeError("module must be a string")
if not isinstance(lineno, int):
Expand Down Expand Up @@ -303,6 +317,9 @@ def simplefilter(action, category=Warning, lineno=0, append=False):
"""
if action not in {"error", "ignore", "always", "all", "default", "module", "once"}:
raise ValueError(f"invalid action: {action!r}")
if not _valid_warning_category(category):
raise TypeError("category must be a Warning subclass, "
"not '{:s}'".format(type(category).__name__))
if not isinstance(lineno, int):
raise TypeError("lineno must be an int")
if lineno < 0:
Expand Down
29 changes: 29 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 @@ -398,6 +398,35 @@ def test_argument_validation(self):
with self.assertRaises(ValueError):
self.module.simplefilter('ignore', lineno=-1)

# these tests fail if python is run with -O, so check __debug__
@unittest.skipUnless(__debug__, "Won't work if __debug__ is False")
def test_invalid_category_types(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably need to skip this if we're not in debug mode, so add something like @unittest.skipUnless(__debug__, ...).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated accordingly

with self.assertRaises(TypeError):
self.module.filterwarnings("ignore", category="notawarning")
with self.assertRaises(TypeError):
self.module.filterwarnings("ignore", category=123)
with self.assertRaises(TypeError):
self.module.filterwarnings("ignore", category=17.02)
with self.assertRaises(TypeError):
self.module.filterwarnings("ignore", category=True)
with self.assertRaises(TypeError):
self.module.filterwarnings(
"ignore", category=(UserWarning, 17)
)

with self.assertRaises(TypeError):
self.module.simplefilter("ignore", category="notawarning")
with self.assertRaises(TypeError):
self.module.simplefilter("ignore", category=123)
with self.assertRaises(TypeError):
self.module.filterwarnings("ignore", category=17.02)
with self.assertRaises(TypeError):
self.module.filterwarnings("ignore", category=True)
with self.assertRaises(TypeError):
self.module.simplefilter(
"ignore", category=(UserWarning, 'abc')
)

def test_catchwarnings_with_simplefilter_ignore(self):
with self.module.catch_warnings(module=self.module):
self.module.resetwarnings()
Expand Down
1 change: 1 addition & 0 deletions Misc/ACKS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ Emmanuel Arias
Alicia Arlen
Jeffrey Armstrong
Justin Turner Arthur
Hasrat Ali Arzoo
Jason Asbahr
David Ascher
Ammar Askar
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Windows/2025-07-10-19-28-11.gh-issue-125893.lD8Nyd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added validation for the ``category`` argument in
:func:`warnings.filterwarnings` and :func:`warnings.simplefilter`.
Loading