bpo-44322: Document more SyntaxError details. (GH-26562)
1. SyntaxError args have a tuple of other attributes.
2. Attributes are adjusted for errors in f-string field expressions.
3. Compile() can raise SyntaxErrors.
(cherry picked from commit 67dfa6f2a508c325715625fe442f2ce20270a8b3)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 173c1c2..d5d81df 100644
--- a/Doc/library/exceptions.rst
+++ b/Doc/library/exceptions.rst
@@ -409,14 +409,16 @@
.. versionadded:: 3.5
-.. exception:: SyntaxError
+.. exception:: SyntaxError(message, details)
Raised when the parser encounters a syntax error. This may occur in an
- :keyword:`import` statement, in a call to the built-in functions :func:`exec`
+ :keyword:`import` statement, in a call to the built-in functions
+ :func:`compile`, :func:`exec`,
or :func:`eval`, or when reading the initial script or standard input
(also interactively).
The :func:`str` of the exception instance returns only the error message.
+ Details is a tuple whose members are also available as separate attributes.
.. attribute:: filename
@@ -446,6 +448,11 @@
The column in the end line where the error occurred finishes. This is
1-indexed: the first character in the line has an ``offset`` of 1.
+ For errors in f-string fields, the message is prefixed by "f-string: "
+ and the offsets are offsets in a text constructed from the replacement
+ expression. For example, compiling f'Bad {a b} field' results in this
+ args attribute: ('f-string: ...', ('', 1, 2, '(a b)\n', 1, 5)).
+
.. versionchanged:: 3.10
Added the :attr:`end_lineno` and :attr:`end_offset` attributes.