]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-25381: Update explanation of exceptions in C. (GH-26838) (GH-29569)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 15 Nov 2021 23:07:58 +0000 (15:07 -0800)
committerGitHub <noreply@github.com>
Mon, 15 Nov 2021 23:07:58 +0000 (18:07 -0500)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit ad43dc0b54994e7e7d06e3d4896ade188b36ee12)

Doc/extending/extending.rst
Misc/NEWS.d/next/Documentation/2021-06-21-17-51-51.bpo-25381.7Kn-_H.rst [new file with mode: 0644]

index bc85a05ff2f850345fdda1b6f3d3ae7cad8a49af..a7676708c8c8e81c745b83f16e5db2d8b2326a5a 100644 (file)
@@ -127,13 +127,11 @@ Intermezzo: Errors and Exceptions
 
 An important convention throughout the Python interpreter is the following: when
 a function fails, it should set an exception condition and return an error value
-(usually a ``NULL`` pointer).  Exceptions are stored in a static global variable
-inside the interpreter; if this variable is ``NULL`` no exception has occurred.  A
-second global variable stores the "associated value" of the exception (the
-second argument to :keyword:`raise`).  A third variable contains the stack
-traceback in case the error originated in Python code.  These three variables
-are the C equivalents of the result in Python of :meth:`sys.exc_info` (see the
-section on module :mod:`sys` in the Python Library Reference).  It is important
+(usually ``-1`` or a ``NULL`` pointer).  Exception information is stored in
+three members of the interpreter's thread state.  These are ``NULL`` if
+there is no exception.  Otherwise they are the C equivalents of the members
+of the Python tuple returned by :meth:`sys.exc_info`.  These are the
+exception type, exception instance, and a traceback object.  It is important
 to know about them to understand how errors are passed around.
 
 The Python API defines a number of functions to set various types of exceptions.
diff --git a/Misc/NEWS.d/next/Documentation/2021-06-21-17-51-51.bpo-25381.7Kn-_H.rst b/Misc/NEWS.d/next/Documentation/2021-06-21-17-51-51.bpo-25381.7Kn-_H.rst
new file mode 100644 (file)
index 0000000..f009f88
--- /dev/null
@@ -0,0 +1,2 @@
+In the extending chapter of the extending doc, update a paragraph about the
+global variables containing exception information.