[Python-checkins] [3.9] bpo-45083: Include the exception class qualname when formatting an exception (GH-28119) (GH-28135)

Fri Sep 3 12:56:13 EDT 2021

https://github.com/python/cpython/commit/41c23740243cc3a0699bc4d5dcfd47a0007ff039
commit: 41c23740243cc3a0699bc4d5dcfd47a0007ff039
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2021年09月03日T18:56:05+02:00
summary:
[3.9] bpo-45083: Include the exception class qualname when formatting an exception (GH-28119) (GH-28135)
* bpo-45083: Include the exception class qualname when formatting an exception (GH-28119)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland at innova.no>
(cherry picked from commit b4b6342848ec0459182a992151099252434cc619)
Co-authored-by: Irit Katriel <1055913+iritkatriel at users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz at langa.pl>
files:
A Misc/NEWS.d/next/Core and Builtins/2021-09-01-23-55-49.bpo-45083.cLi9G3.rst
M Include/internal/pycore_object.h
M Lib/test/test_sys.py
M Lib/test/test_traceback.py
M Objects/typeobject.c
M Python/errors.c
M Python/pythonrun.c

diff --git a/Include/internal/pycore_object.h b/Include/internal/pycore_object.h
index 32e86d06db5b4..c66ff12d7ec5a 100644
--- a/Include/internal/pycore_object.h
+++ b/Include/internal/pycore_object.h
@@ -15,6 +15,9 @@ extern "C" {
 PyAPI_FUNC(int) _PyType_CheckConsistency(PyTypeObject *type);
 PyAPI_FUNC(int) _PyDict_CheckConsistency(PyObject *mp, int check_content);
 
+/* Only private in Python 3.10 and 3.9.8+; public in 3.11 */
+extern PyObject *_PyType_GetQualName(PyTypeObject *type);
+
 /* Tell the GC to track this object.
 *
 * NB: While the object is tracked by the collector, it must be safe to call the
diff --git a/Lib/test/test_sys.py b/Lib/test/test_sys.py
index ed9b1770ab55f..f277c92c408d5 100644
--- a/Lib/test/test_sys.py
+++ b/Lib/test/test_sys.py
@@ -1005,6 +1005,20 @@ def __del__(self):
 self.assertIn("del is broken", report)
 self.assertTrue(report.endswith("\n"))
 
+ def test_original_unraisablehook_exception_qualname(self):
+ class A:
+ class B:
+ class X(Exception):
+ pass
+
+ with test.support.captured_stderr() as stderr, \
+ test.support.swap_attr(sys, 'unraisablehook',
+ sys.__unraisablehook__):
+ expected = self.write_unraisable_exc(
+ A.B.X(), "msg", "obj");
+ report = stderr.getvalue()
+ testName = 'test_original_unraisablehook_exception_qualname'
+ self.assertIn(f"{testName}.<locals>.A.B.X", report)
 
 def test_original_unraisablehook_wrong_type(self):
 exc = ValueError(42)
diff --git a/Lib/test/test_traceback.py b/Lib/test/test_traceback.py
index 987fcb955087e..8d9d514d8deaa 100644
--- a/Lib/test/test_traceback.py
+++ b/Lib/test/test_traceback.py
@@ -759,6 +759,19 @@ def test_syntax_error_various_offsets(self):
 exp = "\n".join(expected)
 self.assertEqual(exp, err)
 
+ def test_format_exception_only_qualname(self):
+ class A:
+ class B:
+ class X(Exception):
+ def __str__(self):
+ return "I am X"
+ pass
+ err = self.get_report(A.B.X())
+ str_value = 'I am X'
+ str_name = '.'.join([A.B.X.__module__, A.B.X.__qualname__])
+ exp = "%s: %s\n" % (str_name, str_value)
+ self.assertEqual(exp, err)
+
 
 class PyExcReportingTests(BaseExceptionReportingTests, unittest.TestCase):
 #
diff --git a/Misc/NEWS.d/next/Core and Builtins/2021-09-01-23-55-49.bpo-45083.cLi9G3.rst b/Misc/NEWS.d/next/Core and Builtins/2021-09-01-23-55-49.bpo-45083.cLi9G3.rst
new file mode 100644
index 0000000000000..7bfd87b942059
--- /dev/null
+++ b/Misc/NEWS.d/next/Core and Builtins/2021-09-01-23-55-49.bpo-45083.cLi9G3.rst	
@@ -0,0 +1,3 @@
+When the interpreter renders an exception, its name now has a complete qualname. Previously only the class name was concatenated to the module name, which sometimes resulted in an incorrect full name being displayed.
+
+(This issue impacted only the C code exception rendering, the :mod:`traceback` module was using qualname already).
\ No newline at end of file
diff --git a/Objects/typeobject.c b/Objects/typeobject.c
index f201515d7db33..feae25f2eb367 100644
--- a/Objects/typeobject.c
+++ b/Objects/typeobject.c
@@ -3119,6 +3119,14 @@ PyType_FromSpec(PyType_Spec *spec)
 return PyType_FromSpecWithBases(spec, NULL);
 }
 
+/* private in 3.10 and 3.9.8+; public in 3.11 */
+PyObject *
+_PyType_GetQualName(PyTypeObject *type)
+{
+ return type_qualname(type, NULL);
+}
+
+
 void *
 PyType_GetSlot(PyTypeObject *type, int slot)
 {
diff --git a/Python/errors.c b/Python/errors.c
index 8a2ba8f9d7163..40d8e68bde783 100644
--- a/Python/errors.c
+++ b/Python/errors.c
@@ -3,6 +3,7 @@
 
 #include "Python.h"
 #include "pycore_initconfig.h"
+#include "pycore_object.h" // _PyType_GetQualName
 #include "pycore_pyerrors.h"
 #include "pycore_pystate.h" // _PyThreadState_GET()
 #include "pycore_sysmodule.h"
@@ -1321,46 +1322,45 @@ write_unraisable_exc_file(PyThreadState *tstate, PyObject *exc_type,
 }
 
 assert(PyExceptionClass_Check(exc_type));
- const char *className = PyExceptionClass_Name(exc_type);
- if (className != NULL) {
- const char *dot = strrchr(className, '.');
- if (dot != NULL) {
- className = dot+1;
- }
- }
 
- PyObject *moduleName = _PyObject_GetAttrId(exc_type, &PyId___module__);
- if (moduleName == NULL || !PyUnicode_Check(moduleName)) {
- Py_XDECREF(moduleName);
+ PyObject *modulename = _PyObject_GetAttrId(exc_type, &PyId___module__);
+ if (modulename == NULL || !PyUnicode_Check(modulename)) {
+ Py_XDECREF(modulename);
 _PyErr_Clear(tstate);
 if (PyFile_WriteString("<unknown>", file) < 0) {
 return -1;
 }
 }
 else {
- if (!_PyUnicode_EqualToASCIIId(moduleName, &PyId_builtins)) {
- if (PyFile_WriteObject(moduleName, file, Py_PRINT_RAW) < 0) {
- Py_DECREF(moduleName);
+ if (!_PyUnicode_EqualToASCIIId(modulename, &PyId_builtins)) {
+ if (PyFile_WriteObject(modulename, file, Py_PRINT_RAW) < 0) {
+ Py_DECREF(modulename);
 return -1;
 }
- Py_DECREF(moduleName);
+ Py_DECREF(modulename);
 if (PyFile_WriteString(".", file) < 0) {
 return -1;
 }
 }
 else {
- Py_DECREF(moduleName);
+ Py_DECREF(modulename);
 }
 }
- if (className == NULL) {
+
+ PyObject *qualname = _PyType_GetQualName((PyTypeObject *)exc_type);
+ if (qualname == NULL || !PyUnicode_Check(qualname)) {
+ Py_XDECREF(qualname);
+ _PyErr_Clear(tstate);
 if (PyFile_WriteString("<unknown>", file) < 0) {
 return -1;
 }
 }
 else {
- if (PyFile_WriteString(className, file) < 0) {
+ if (PyFile_WriteObject(qualname, file, Py_PRINT_RAW) < 0) {
+ Py_DECREF(qualname);
 return -1;
 }
+ Py_DECREF(qualname);
 }
 
 if (exc_value && exc_value != Py_None) {
diff --git a/Python/pythonrun.c b/Python/pythonrun.c
index 34cfb7f4b4fd7..8cdbb3790fbcf 100644
--- a/Python/pythonrun.c
+++ b/Python/pythonrun.c
@@ -14,7 +14,8 @@
 #undef Yield /* undefine macro conflicting with <winbase.h> */
 
 #include "pycore_interp.h" // PyInterpreterState.importlib
-#include "pycore_object.h" // _PyDebug_PrintTotalRefs()
+#include "pycore_object.h" // _PyDebug_PrintTotalRefs(),
+ // _PyType_GetQualName()
 #include "pycore_pyerrors.h" // _PyErr_Fetch
 #include "pycore_pylifecycle.h" // _Py_UnhandledKeyboardInterrupt
 #include "pycore_pystate.h" // _PyInterpreterState_GET()
@@ -892,36 +893,37 @@ print_exception(PyObject *f, PyObject *value)
 /* Don't do anything else */
 }
 else {
- PyObject* moduleName;
- const char *className;
+ PyObject* modulename;
+
 _Py_IDENTIFIER(__module__);
 assert(PyExceptionClass_Check(type));
- className = PyExceptionClass_Name(type);
- if (className != NULL) {
- const char *dot = strrchr(className, '.');
- if (dot != NULL)
- className = dot+1;
- }
 
- moduleName = _PyObject_GetAttrId(type, &PyId___module__);
- if (moduleName == NULL || !PyUnicode_Check(moduleName))
+ modulename = _PyObject_GetAttrId(type, &PyId___module__);
+ if (modulename == NULL || !PyUnicode_Check(modulename))
 {
- Py_XDECREF(moduleName);
+ Py_XDECREF(modulename);
+ PyErr_Clear();
 err = PyFile_WriteString("<unknown>", f);
 }
 else {
- if (!_PyUnicode_EqualToASCIIId(moduleName, &PyId_builtins))
+ if (!_PyUnicode_EqualToASCIIId(modulename, &PyId_builtins))
 {
- err = PyFile_WriteObject(moduleName, f, Py_PRINT_RAW);
+ err = PyFile_WriteObject(modulename, f, Py_PRINT_RAW);
 err += PyFile_WriteString(".", f);
 }
- Py_DECREF(moduleName);
+ Py_DECREF(modulename);
 }
 if (err == 0) {
- if (className == NULL)
- err = PyFile_WriteString("<unknown>", f);
- else
- err = PyFile_WriteString(className, f);
+ PyObject* qualname = _PyType_GetQualName((PyTypeObject *)type);
+ if (qualname == NULL || !PyUnicode_Check(qualname)) {
+ Py_XDECREF(qualname);
+ PyErr_Clear();
+ err = PyFile_WriteString("<unknown>", f);
+ }
+ else {
+ err = PyFile_WriteObject(qualname, f, Py_PRINT_RAW);
+ Py_DECREF(qualname);
+ }
 }
 }
 if (err == 0 && (value != Py_None)) {
