Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 9 additions & 6 deletions Lib/_py_warnings.py
Original file line number Diff line number Diff line change
Expand Up @@ -620,30 +620,33 @@ def warn_explicit(message, category, filename, lineno,
linecache.getlines(filename, module_globals)

# Print message and context
msg = _wm.WarningMessage(message, category, filename, lineno, source=source)
msg = _wm.WarningMessage(message, category, filename, lineno,
module=module, source=source)
_wm._showwarnmsg(msg)


class WarningMessage(object):

_WARNING_DETAILS = ("message", "category", "filename", "lineno", "file",
"line", "source")
"line", "source", "module")

def __init__(self, message, category, filename, lineno, file=None,
line=None, source=None):
line=None, source=None, module=None):
self.message = message
self.category = category
self.filename = filename
self.lineno = lineno
self.file = file
self.line = line
self.source = source
self.module = module
self._category_name = category.__name__ if category else None

def __str__(self):
return ("{message : %r, category : %r, filename : %r, lineno : %s, "
"line : %r}" % (self.message, self._category_name,
self.filename, self.lineno, self.line))
return ("{message : %r, category : %r, module : %r, "
"filename : %r, lineno : %s, line : %r}" % (
self.message, self._category_name, self.module,
self.filename, self.lineno, self.line))

def __repr__(self):
return f'<{type(self).__qualname__} {self}>'
Expand Down
33 changes: 31 additions & 2 deletions Lib/test/test_warnings/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -582,15 +582,19 @@ def test_warn_nonstandard_types(self):
# ``Warning() != Warning()``.
self.assertEqual(str(w[-1].message), str(UserWarning(ob)))

def test_filename(self):
def test_filename_module(self):
with warnings_state(self.module):
with self.module.catch_warnings(record=True) as w:
warning_tests.inner("spam1")
self.assertEqual(os.path.basename(w[-1].filename),
"stacklevel.py")
self.assertEqual(w[-1].module,
"test.test_warnings.data.stacklevel")
warning_tests.outer("spam2")
self.assertEqual(os.path.basename(w[-1].filename),
"stacklevel.py")
self.assertEqual(w[-1].module,
"test.test_warnings.data.stacklevel")

def test_stacklevel(self):
# Test stacklevel argument
Expand All @@ -600,23 +604,32 @@ def test_stacklevel(self):
warning_tests.inner("spam3", stacklevel=1)
self.assertEqual(os.path.basename(w[-1].filename),
"stacklevel.py")
self.assertEqual(w[-1].module,
"test.test_warnings.data.stacklevel")
warning_tests.outer("spam4", stacklevel=1)
self.assertEqual(os.path.basename(w[-1].filename),
"stacklevel.py")
self.assertEqual(w[-1].module,
"test.test_warnings.data.stacklevel")

warning_tests.inner("spam5", stacklevel=2)
self.assertEqual(os.path.basename(w[-1].filename),
"__init__.py")
self.assertEqual(w[-1].module, __name__)
warning_tests.outer("spam6", stacklevel=2)
self.assertEqual(os.path.basename(w[-1].filename),
"stacklevel.py")
self.assertEqual(w[-1].module,
"test.test_warnings.data.stacklevel")
warning_tests.outer("spam6.5", stacklevel=3)
self.assertEqual(os.path.basename(w[-1].filename),
"__init__.py")
self.assertEqual(w[-1].module, __name__)

warning_tests.inner("spam7", stacklevel=9999)
self.assertEqual(os.path.basename(w[-1].filename),
"<sys>")
self.assertEqual(w[-1].module, "sys")

def test_stacklevel_import(self):
# Issue #24305: With stacklevel=2, module-level warnings should work.
Expand All @@ -627,6 +640,7 @@ def test_stacklevel_import(self):
import test.test_warnings.data.import_warning # noqa: F401
self.assertEqual(len(w), 1)
self.assertEqual(w[0].filename, __file__)
self.assertEqual(w[0].module, __name__)

def test_skip_file_prefixes(self):
with warnings_state(self.module):
Expand All @@ -638,20 +652,27 @@ def test_skip_file_prefixes(self):
"inner_api", stacklevel=2,
warnings_module=warning_tests.warnings)
self.assertEqual(w[-1].filename, __file__)
self.assertEqual(w[-1].module, __name__)
warning_tests.package("package api", stacklevel=2)
self.assertEqual(w[-1].filename, __file__)
self.assertEqual(w[-1].module, __name__)
self.assertEqual(w[-2].filename, w[-1].filename)
self.assertEqual(w[-2].module, w[-1].module)
# Low stacklevels are overridden to 2 behavior.
warning_tests.package("package api 1", stacklevel=1)
self.assertEqual(w[-1].filename, __file__)
self.assertEqual(w[-1].module, __name__)
warning_tests.package("package api 0", stacklevel=0)
self.assertEqual(w[-1].filename, __file__)
self.assertEqual(w[-1].module, __name__)
warning_tests.package("package api -99", stacklevel=-99)
self.assertEqual(w[-1].filename, __file__)
self.assertEqual(w[-1].module, __name__)

# The stacklevel still goes up out of the package.
warning_tests.package("prefix02", stacklevel=3)
self.assertIn("unittest", w[-1].filename)
self.assertStartsWith(w[-1].module, "unittest")

def test_skip_file_prefixes_file_path(self):
# see: gh-126209
Expand All @@ -662,6 +683,8 @@ def test_skip_file_prefixes_file_path(self):

self.assertEqual(len(w), 1)
self.assertNotEqual(w[-1].filename, skipped)
self.assertEqual(w[-1].filename, __file__)
self.assertEqual(w[-1].module, __name__)

def test_skip_file_prefixes_type_errors(self):
with warnings_state(self.module):
Expand All @@ -673,7 +696,7 @@ def test_skip_file_prefixes_type_errors(self):
with self.assertRaises(TypeError):
warn("msg", skip_file_prefixes="a sequence of strs")

def test_exec_filename(self):
def test_exec_filename_module(self):
filename = "<warnings-test>"
codeobj = compile(("import warnings\n"
"warnings.warn('hello', UserWarning)"),
Expand All @@ -682,6 +705,12 @@ def test_exec_filename(self):
self.module.simplefilter("always", category=UserWarning)
exec(codeobj)
self.assertEqual(w[0].filename, filename)
self.assertEqual(w[0].module, __name__)
with self.module.catch_warnings(record=True) as w:
self.module.simplefilter("always", category=UserWarning)
exec(codeobj, {})
self.assertEqual(w[0].filename, filename)
self.assertEqual(w[0].module, '<string>')

def test_warn_explicit_non_ascii_filename(self):
with self.module.catch_warnings(record=True) as w:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A *module* attribute has been added to :class:`!warnings.WarningMessage`.
7 changes: 4 additions & 3 deletions Python/_warnings.c
Original file line number Diff line number Diff line change
Expand Up @@ -716,7 +716,7 @@ static int
call_show_warning(PyThreadState *tstate, PyObject *category,
PyObject *text, PyObject *message,
PyObject *filename, int lineno, PyObject *lineno_obj,
PyObject *sourceline, PyObject *source)
PyObject *sourceline, PyObject *source, PyObject *module)
{
PyObject *show_fn, *msg, *res, *warnmsg_cls = NULL;
PyInterpreterState *interp = tstate->interp;
Expand Down Expand Up @@ -747,7 +747,8 @@ call_show_warning(PyThreadState *tstate, PyObject *category,
}

msg = PyObject_CallFunctionObjArgs(warnmsg_cls, message, category,
filename, lineno_obj, Py_None, Py_None, source,
filename, lineno_obj, Py_None, Py_None,
source ? source : Py_None, module,
NULL);
Py_DECREF(warnmsg_cls);
if (msg == NULL)
Expand Down Expand Up @@ -878,7 +879,7 @@ warn_explicit(PyThreadState *tstate, PyObject *category, PyObject *message,
goto return_none;
if (rc == 0) {
if (call_show_warning(tstate, category, text, message, filename,
lineno, lineno_obj, sourceline, source) < 0)
lineno, lineno_obj, sourceline, source, module) < 0)
goto cleanup;
}
else /* if (rc == -1) */
Expand Down
Loading