From 67dfa6f2a508c325715625fe442f2ce20270a8b3 Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Sun, 6 Jun 2021 21:42:31 -0400 Subject: 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. --- Doc/library/exceptions.rst | 11 +++++++++-- .../Documentation/2021-06-06-14-12-00.bpo-44322.K0PHfE.rst | 2 ++ 2 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 Misc/NEWS.d/next/Documentation/2021-06-06-14-12-00.bpo-44322.K0PHfE.rst 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 @@ The following exceptions are the exceptions that are usually raised. .. 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 following exceptions are the exceptions that are usually raised. 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. diff --git a/Misc/NEWS.d/next/Documentation/2021-06-06-14-12-00.bpo-44322.K0PHfE.rst b/Misc/NEWS.d/next/Documentation/2021-06-06-14-12-00.bpo-44322.K0PHfE.rst new file mode 100644 index 0000000..48dd7e6 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-06-06-14-12-00.bpo-44322.K0PHfE.rst @@ -0,0 +1,2 @@ +Document that SyntaxError args have a details tuple and that details are +adjusted for errors in f-string field replacement expressions. -- cgit v0.12