Rooba
/
cpython
mirror of https://github.com/python/cpython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

gh-128016: Improved invalid escape sequence warning message (#128020)

This commit is contained in:
Umar Butler 2025-01-16 04:00:54 +11:00 committed by GitHub
parent 40a4d88a14
commit 8d8b854824
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 63 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Lib/test/test_cmd_line_script.py
View File

@ -659,7 +659,8 @@ def test_syntaxerror_invalid_escape_sequence_multi_line(self):
stderr.splitlines()[-3:],
[ b' foo = """\\q"""',
b' ^^^^^^^^',
b'SyntaxError: invalid escape sequence \'\\q\''
b'SyntaxError: "\\q" is an invalid escape sequence. '
b'Did you mean "\\\\q"? A raw string is also an option.'
],
)

2
Lib/test/test_codeop.py
View File

@ -282,7 +282,7 @@ def test_warning(self):
# Test that the warning is only returned once.
with warnings_helper.check_warnings(
('"is" with \'str\' literal', SyntaxWarning),
("invalid escape sequence", SyntaxWarning),
('"\\\\e" is an invalid escape sequence', SyntaxWarning),
) as w:
compile_command(r"'\e' is 0")
self.assertEqual(len(w.warnings), 2)

29
Lib/test/test_string_literals.py
View File

@ -116,7 +116,9 @@ def test_eval_str_invalid_escape(self):
warnings.simplefilter('always', category=SyntaxWarning)
eval("'''\n\\z'''")
self.assertEqual(len(w), 1)
self.assertEqual(str(w[0].message), r"invalid escape sequence '\z'")
self.assertEqual(str(w[0].message), r'"\z" is an invalid escape sequence. '
r'Such sequences will not work in the future. '
r'Did you mean "\\z"? A raw string is also an option.')
self.assertEqual(w[0].filename, '<string>')
self.assertEqual(w[0].lineno, 1)
@ -126,7 +128,8 @@ def test_eval_str_invalid_escape(self):
eval("'''\n\\z'''")
exc = cm.exception
self.assertEqual(w, [])
self.assertEqual(exc.msg, r"invalid escape sequence '\z'")
self.assertEqual(exc.msg, r'"\z" is an invalid escape sequence. '
r'Did you mean "\\z"? A raw string is also an option.')
self.assertEqual(exc.filename, '<string>')
self.assertEqual(exc.lineno, 1)
self.assertEqual(exc.offset, 1)
@ -153,7 +156,9 @@ def test_eval_str_invalid_octal_escape(self):
eval("'''\n\\407'''")
self.assertEqual(len(w), 1)
self.assertEqual(str(w[0].message),
r"invalid octal escape sequence '\407'")
r'"\407" is an invalid octal escape sequence. '
r'Such sequences will not work in the future. '
r'Did you mean "\\407"? A raw string is also an option.')
self.assertEqual(w[0].filename, '<string>')
self.assertEqual(w[0].lineno, 1)
@ -163,7 +168,8 @@ def test_eval_str_invalid_octal_escape(self):
eval("'''\n\\407'''")
exc = cm.exception
self.assertEqual(w, [])
self.assertEqual(exc.msg, r"invalid octal escape sequence '\407'")
self.assertEqual(exc.msg, r'"\407" is an invalid octal escape sequence. '
r'Did you mean "\\407"? A raw string is also an option.')
self.assertEqual(exc.filename, '<string>')
self.assertEqual(exc.lineno, 1)
self.assertEqual(exc.offset, 1)
@ -205,7 +211,9 @@ def test_eval_bytes_invalid_escape(self):
warnings.simplefilter('always', category=SyntaxWarning)
eval("b'''\n\\z'''")
self.assertEqual(len(w), 1)
self.assertEqual(str(w[0].message), r"invalid escape sequence '\z'")
self.assertEqual(str(w[0].message), r'"\z" is an invalid escape sequence. '
r'Such sequences will not work in the future. '
r'Did you mean "\\z"? A raw string is also an option.')
self.assertEqual(w[0].filename, '<string>')
self.assertEqual(w[0].lineno, 1)
@ -215,7 +223,8 @@ def test_eval_bytes_invalid_escape(self):
eval("b'''\n\\z'''")
exc = cm.exception
self.assertEqual(w, [])
self.assertEqual(exc.msg, r"invalid escape sequence '\z'")
self.assertEqual(exc.msg, r'"\z" is an invalid escape sequence. '
r'Did you mean "\\z"? A raw string is also an option.')
self.assertEqual(exc.filename, '<string>')
self.assertEqual(exc.lineno, 1)
@ -228,8 +237,9 @@ def test_eval_bytes_invalid_octal_escape(self):
warnings.simplefilter('always', category=SyntaxWarning)
eval("b'''\n\\407'''")
self.assertEqual(len(w), 1)
self.assertEqual(str(w[0].message),
r"invalid octal escape sequence '\407'")
self.assertEqual(str(w[0].message), r'"\407" is an invalid octal escape sequence. '
r'Such sequences will not work in the future. '
r'Did you mean "\\407"? A raw string is also an option.')
self.assertEqual(w[0].filename, '<string>')
self.assertEqual(w[0].lineno, 1)
@ -239,7 +249,8 @@ def test_eval_bytes_invalid_octal_escape(self):
eval("b'''\n\\407'''")
exc = cm.exception
self.assertEqual(w, [])
self.assertEqual(exc.msg, r"invalid octal escape sequence '\407'")
self.assertEqual(exc.msg, r'"\407" is an invalid octal escape sequence. '
r'Did you mean "\\407"? A raw string is also an option.')
self.assertEqual(exc.filename, '<string>')
self.assertEqual(exc.lineno, 1)

4
Lib/test/test_unparse.py
View File

@ -651,7 +651,9 @@ def test_multiquote_joined_string(self):
def test_backslash_in_format_spec(self):
import re
msg = re.escape("invalid escape sequence '\\ '")
msg = re.escape('"\\ " is an invalid escape sequence. '
'Such sequences will not work in the future. '
'Did you mean "\\\\ "? A raw string is also an option.')
with self.assertWarnsRegex(SyntaxWarning, msg):
self.check_ast_roundtrip("""f"{x:\\ }" """)
self.check_ast_roundtrip("""f"{x:\\n}" """)

1
Misc/NEWS.d/next/Core_and_Builtins/2024-12-17-09-28-17.gh-issue-128016.DPqhah.rst Normal file
View File

@ -0,0 +1 @@
Improved the ``SyntaxWarning`` message for invalid escape sequences to clarify that such sequences will raise a ``SyntaxError`` in future Python releases. The new message also suggests a potential fix, i.e., ``Did you mean "\\e"?``.

7
Objects/bytesobject.c
View File

@ -1205,7 +1205,8 @@ PyObject *PyBytes_DecodeEscape(const char *s,
unsigned char c = *first_invalid_escape;
if ('4' <= c && c <= '7') {
if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
"invalid octal escape sequence '\\%.3s'",
"b\"\\%.3s\" is an invalid octal escape sequence. "
"Such sequences will not work in the future. ",
first_invalid_escape) < 0)
{
Py_DECREF(result);
@ -1214,7 +1215,8 @@ PyObject *PyBytes_DecodeEscape(const char *s,
}
else {
if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
"invalid escape sequence '\\%c'",
"b\"\\%c\" is an invalid escape sequence. "
"Such sequences will not work in the future. ",
c) < 0)
{
Py_DECREF(result);
@ -1223,7 +1225,6 @@ PyObject *PyBytes_DecodeEscape(const char *s,
}
}
return result;
}
/* -------------------------------------------------------------------- */
/* object api */

6
Objects/unicodeobject.c
View File

@ -6853,7 +6853,8 @@ _PyUnicode_DecodeUnicodeEscapeStateful(const char *s,
unsigned char c = *first_invalid_escape;
if ('4' <= c && c <= '7') {
if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
"invalid octal escape sequence '\\%.3s'",
"\"\\%.3s\" is an invalid octal escape sequence. "
"Such sequences will not work in the future. ",
first_invalid_escape) < 0)
{
Py_DECREF(result);
@ -6862,7 +6863,8 @@ _PyUnicode_DecodeUnicodeEscapeStateful(const char *s,
}
else {
if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
"invalid escape sequence '\\%c'",
"\"\\%c\" is an invalid escape sequence. "
"Such sequences will not work in the future. ",
c) < 0)
{
Py_DECREF(result);

24
Parser/string_parser.c
View File

@ -28,9 +28,16 @@ warn_invalid_escape_sequence(Parser *p, const char *first_invalid_escape, Token
int octal = ('4' <= c && c <= '7');
PyObject *msg =
octal
? PyUnicode_FromFormat("invalid octal escape sequence '\\%.3s'",
first_invalid_escape)
: PyUnicode_FromFormat("invalid escape sequence '\\%c'", c);
? PyUnicode_FromFormat(
"\"\\%.3s\" is an invalid octal escape sequence. "
"Such sequences will not work in the future. "
"Did you mean \"\\\\%.3s\"? A raw string is also an option.",
first_invalid_escape, first_invalid_escape)
: PyUnicode_FromFormat(
"\"\\%c\" is an invalid escape sequence. "
"Such sequences will not work in the future. "
"Did you mean \"\\\\%c\"? A raw string is also an option.",
c, c);
if (msg == NULL) {
return -1;
}
@ -53,11 +60,16 @@ warn_invalid_escape_sequence(Parser *p, const char *first_invalid_escape, Token
error location, if p->known_err_token is not set. */
p->known_err_token = t;
if (octal) {
RAISE_SYNTAX_ERROR("invalid octal escape sequence '\\%.3s'",
first_invalid_escape);
RAISE_SYNTAX_ERROR(
"\"\\%.3s\" is an invalid octal escape sequence. "
"Did you mean \"\\\\%.3s\"? A raw string is also an option.",
first_invalid_escape, first_invalid_escape);
}
else {
RAISE_SYNTAX_ERROR("invalid escape sequence '\\%c'", c);
RAISE_SYNTAX_ERROR(
"\"\\%c\" is an invalid escape sequence. "
"Did you mean \"\\\\%c\"? A raw string is also an option.",
c, c);
}
}
Py_DECREF(msg);

12
Parser/tokenizer/helpers.c
View File

@ -113,7 +113,10 @@ _PyTokenizer_warn_invalid_escape_sequence(struct tok_state *tok, int first_inval
}
PyObject *msg = PyUnicode_FromFormat(
"invalid escape sequence '\\%c'",
"\"\\%c\" is an invalid escape sequence. "
"Such sequences will not work in the future. "
"Did you mean \"\\\\%c\"? A raw string is also an option.",
(char) first_invalid_escape_char,
(char) first_invalid_escape_char
);
@ -129,7 +132,12 @@ _PyTokenizer_warn_invalid_escape_sequence(struct tok_state *tok, int first_inval
/* Replace the SyntaxWarning exception with a SyntaxError
to get a more accurate error report */
PyErr_Clear();
return _PyTokenizer_syntaxerror(tok, "invalid escape sequence '\\%c'", (char) first_invalid_escape_char);
return _PyTokenizer_syntaxerror(tok,
"\"\\%c\" is an invalid escape sequence. "
"Did you mean \"\\\\%c\"? A raw string is also an option.",
(char) first_invalid_escape_char,
(char) first_invalid_escape_char);
}
return -1;