Mar 16, 2023 · Mar 13, 2023 · Mar 14, 2023 · Mar 14, 2023 · Mar 14, 2023 · Mar 14, 2023
diff --git a/Include/cpython/pyerrors.h b/Include/cpython/pyerrors.h

 /* In exceptions.c */

 PyAPI_FUNC(PyObject*) _PyException_AddNote(
     PyBaseExceptionObject *exc,
     PyObject *note);

 /* Helper that attempts to replace the current exception with one of the
 * same type but with a prefix added to the exception text. The resulting
 * exception description looks like:
diff --git a/Lib/test/test_capi/test_exceptions.py b/Lib/test/test_capi/test_exceptions.py
        with self.assertRaises(ZeroDivisionError) as e:
            _testcapi.exc_set_object(Broken, Broken())

    def test_set_object_and_fetch(self):
        class Broken(Exception):
            def __init__(self, *arg):
                 raise ValueError("Broken __init__")

        exc = _testcapi.exc_set_object_fetch(Broken, ('abcd'))
        self.assertIsInstance(exc, ValueError)
        self.assertEqual(exc.__notes__[0],
                         "Normalization failed: type=Broken args='abcd'")

        class BadArg:
            def __repr__(self):
                raise TypeError('Broken arg type')

        exc = _testcapi.exc_set_object_fetch(Broken, (BadArg()))
        self.assertIsInstance(exc, ValueError)
        self.assertEqual(exc.__notes__[0],
                         'Normalization failed: type=Broken args=<unknown>')


 if __name__ == "__main__":
    unittest.main()
diff --git a/Misc/NEWS.d/next/Core and Builtins/2023-03-14-00-11-46.gh-issue-102594.BjU-m2.rst b/Misc/NEWS.d/next/Core and Builtins/2023-03-14-00-11-46.gh-issue-102594.BjU-m2.rst
 Add note to exception raised in ``PyErr_SetObject`` when normalization fails.
diff --git a/Modules/_testcapi/exceptions.c b/Modules/_testcapi/exceptions.c
 returnNULL;
 }

 staticPyObject*
 exc_set_object_fetch(PyObject*self,PyObject*args)
 {
 PyObject*exc;
 PyObject*obj;
 PyObject*type;
 PyObject*value;
 PyObject*tb;

 if (!PyArg_ParseTuple(args,"OO:exc_set_object",&exc,&obj)) {
 returnNULL;
    }

 PyErr_SetObject(exc,obj);
 PyErr_Fetch(&type,&value,&tb);
 Py_XDECREF(type);
 Py_XDECREF(tb);
 returnvalue;
 }

 staticPyObject*
 raise_exception(PyObject*self,PyObject*args)
 {
    {"make_exception_with_doc",_PyCFunction_CAST(make_exception_with_doc),
 METH_VARARGS |METH_KEYWORDS},
    {"exc_set_object",exc_set_object,METH_VARARGS},
    {"exc_set_object_fetch",exc_set_object_fetch,METH_VARARGS},
    {"raise_exception",raise_exception,METH_VARARGS},
    {"raise_memoryerror",raise_memoryerror,METH_NOARGS},
    {"set_exc_info",test_set_exc_info,METH_VARARGS},
diff --git a/Objects/exceptions.c b/Objects/exceptions.c
    _PyExc_FiniTypes(interp);
 }

 PyObject *
 _PyException_AddNote(PyBaseExceptionObject *exc, PyObject *note)
 {
    return BaseException_add_note((PyObject *)exc, note);
 }

 /* Helper to do the equivalent of "raise X from Y" in C, but always using
 * the current exception rather than passing one in.
 *
diff --git a/Python/errors.c b/Python/errors.c
    return exc_info;
 }

 static PyObject *
 get_normalization_failure_note(PyThreadState *tstate, PyObject *exception, PyObject *value)
 {
    PyObject *args = PyObject_Repr(value);
    if (args == NULL) {
        _PyErr_Clear(tstate);
        args = PyUnicode_FromFormat("<unknown>");
    }
    PyObject *note;
    const char *tpname = ((PyTypeObject*)exception)->tp_name;
    if (args == NULL) {
        _PyErr_Clear(tstate);
        note = PyUnicode_FromFormat("Normalization failed: type=%s", tpname);
    }
    else {
        note = PyUnicode_FromFormat("Normalization failed: type=%s args=%S",
                                    tpname, args);
        Py_DECREF(args);
    }
    return note;
 }

 void
 _PyErr_SetObject(PyThreadState *tstate, PyObject *exception, PyObject *value)
 {
        fixed_value = _PyErr_CreateException(exception, value);
        Py_XDECREF(value);
        if (fixed_value == NULL) {
            PyObject *exc = _PyErr_GetRaisedException(tstate);
            assert(PyExceptionInstance_Check(exc));

            PyObject *note = get_normalization_failure_note(tstate, exception, value);
            if (note != NULL) {
                PyObject *res = _PyException_AddNote((PyBaseExceptionObject*)exc, note);
                Py_DECREF(note);
                Py_XDECREF(res);
            }
            _PyErr_SetRaisedException(tstate, exc);
            return;
        }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -112,6 +112,10 @@ PyAPI_FUNC(PyObject *) _PyErr_FormatFromCause(

		/* In exceptions.c */

		PyAPI_FUNC(PyObject*) _PyException_AddNote(
		PyBaseExceptionObject *exc,
		PyObject *note);

		/* Helper that attempts to replace the current exception with one of the
		* same type but with a prefix added to the exception text. The resulting
		* exception description looks like:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -169,5 +169,25 @@ class Broken(Exception, metaclass=Meta):
		with self.assertRaises(ZeroDivisionError) as e:
		_testcapi.exc_set_object(Broken, Broken())

		def test_set_object_and_fetch(self):
		class Broken(Exception):
		def __init__(self, *arg):
		raise ValueError("Broken __init__")

		exc = _testcapi.exc_set_object_fetch(Broken, ('abcd'))
iritkatriel marked this conversation as resolved. OutdatedShow resolvedHide resolved
		self.assertIsInstance(exc, ValueError)
		self.assertEqual(exc.__notes__[0],
		"Normalization failed: type=Broken args='abcd'")

		class BadArg:
		def __repr__(self):
		raise TypeError('Broken arg type')

		exc = _testcapi.exc_set_object_fetch(Broken, (BadArg()))
iritkatriel marked this conversation as resolved. OutdatedShow resolvedHide resolved
		self.assertIsInstance(exc, ValueError)
		self.assertEqual(exc.__notes__[0],
		'Normalization failed: type=Broken args=<unknown>')


		if __name__ == "__main__":
		unittest.main()
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add note to exception raised in ``PyErr_SetObject`` when normalization fails.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -92,6 +92,26 @@ exc_set_object(PyObject self, PyObject args)
		returnNULL;
		}

		staticPyObject*
		exc_set_object_fetch(PyObjectself,PyObjectargs)
		{
		PyObject*exc;
		PyObject*obj;
		PyObject*type;
		PyObject*value;
		PyObject*tb;

		if (!PyArg_ParseTuple(args,"OO:exc_set_object",&exc,&obj)) {
		returnNULL;
		}

		PyErr_SetObject(exc,obj);
		PyErr_Fetch(&type,&value,&tb);
		Py_XDECREF(type);
		Py_XDECREF(tb);
		returnvalue;
		}

		staticPyObject*
		raise_exception(PyObjectself,PyObjectargs)
		{
Expand DownExpand Up		@@ -262,6 +282,7 @@ static PyMethodDef test_methods[] = {
		{"make_exception_with_doc",_PyCFunction_CAST(make_exception_with_doc),
		METH_VARARGS \|METH_KEYWORDS},
		{"exc_set_object",exc_set_object,METH_VARARGS},
		{"exc_set_object_fetch",exc_set_object_fetch,METH_VARARGS},
		{"raise_exception",raise_exception,METH_VARARGS},
		{"raise_memoryerror",raise_memoryerror,METH_NOARGS},
		{"set_exc_info",test_set_exc_info,METH_VARARGS},
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3749,6 +3749,12 @@ _PyExc_Fini(PyInterpreterState *interp)
		_PyExc_FiniTypes(interp);
		}

		PyObject *
		_PyException_AddNote(PyBaseExceptionObject exc, PyObject note)
		{
		return BaseException_add_note((PyObject *)exc, note);
		}

		/* Helper to do the equivalent of "raise X from Y" in C, but always using
		* the current exception rather than passing one in.
		*
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -135,6 +135,28 @@ _PyErr_GetTopmostException(PyThreadState *tstate)
		return exc_info;
		}

		static PyObject *
		get_normalization_failure_note(PyThreadState tstate, PyObject exception, PyObject *value)
		{
		PyObject *args = PyObject_Repr(value);
		if (args == NULL) {
		_PyErr_Clear(tstate);
		args = PyUnicode_FromFormat("<unknown>");
		}
		PyObject *note;
		const char tpname = ((PyTypeObject)exception)->tp_name;
		if (args == NULL) {
		_PyErr_Clear(tstate);
		note = PyUnicode_FromFormat("Normalization failed: type=%s", tpname);
		}
		else {
		note = PyUnicode_FromFormat("Normalization failed: type=%s args=%S",
		tpname, args);
		Py_DECREF(args);
		}
		return note;
		}

		void
		_PyErr_SetObject(PyThreadState tstate, PyObject exception, PyObject *value)
		{
Expand DownExpand Up		@@ -169,6 +191,16 @@ _PyErr_SetObject(PyThreadState tstate, PyObject exception, PyObject *value)
		fixed_value = _PyErr_CreateException(exception, value);
		Py_XDECREF(value);
		if (fixed_value == NULL) {
		PyObject *exc = _PyErr_GetRaisedException(tstate);
		assert(PyExceptionInstance_Check(exc));

		PyObject *note = get_normalization_failure_note(tstate, exception, value);
		if (note != NULL) {
		PyObject res = _PyException_AddNote((PyBaseExceptionObject)exc, note);
		Py_DECREF(note);
		Py_XDECREF(res);
		}
		_PyErr_SetRaisedException(tstate, exc);
iritkatriel marked this conversation as resolved. Show resolvedHide resolved
		return;
		}

Expand Down