mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

Browse source 
* bpo-45083: Include the exception class qualname when formatting an exception (GH-28119)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
(cherry picked from commit b4b6342848)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
This commit is contained in:
Miss Islington (bot) 2021-09-03 09:56:05 -07:00 • committed by GitHub
parent 98eb40828a
commit 41c2374024
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 79 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Include/internal/pycore_object.h
View file

@ -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

14
Lib/test/test_sys.py
View file

@ -1005,6 +1005,20 @@ class UnraisableHookTest(unittest.TestCase):
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)

13
Lib/test/test_traceback.py
View file

@ -759,6 +759,19 @@ class BaseExceptionReportingTests:
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):
#

3
Misc/NEWS.d/next/Core and Builtins/2021-09-01-23-55-49.bpo-45083.cLi9G3.rst Normal file
View file

@ -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).

8
Objects/typeobject.c
View file

@ -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)
{

34
Python/errors.c
View file

@ -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) {

38
Python/pythonrun.c
View file

@ -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)
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_WriteString(className, f);
}
else {
err = PyFile_WriteObject(qualname, f, Py_PRINT_RAW);
Py_DECREF(qualname);
}
}
}
if (err == 0 && (value != Py_None)) {