Skip to content

bpo-45759: Re: Better error messages for non-matching 'elif'/'else' statements #29775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Grammar/python.gram
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ simple_stmt[stmt_ty] (memo):
| &'nonlocal' nonlocal_stmt

compound_stmt[stmt_ty]:
| invalid_compound_stmt
| &('def' | '@' | ASYNC) function_def
| &'if' if_stmt
| &('class' | '@') class_def
Expand Down Expand Up @@ -1179,6 +1180,10 @@ invalid_import_from_targets:
| import_from_as_names ',' NEWLINE {
RAISE_SYNTAX_ERROR("trailing comma not allowed without surrounding parentheses") }

invalid_compound_stmt:
| a='elif' named_expression ':' { RAISE_SYNTAX_ERROR_STARTING_FROM(a, "'elif' must match an if-statement here") }
| a='else' ':' { RAISE_SYNTAX_ERROR_STARTING_FROM(a, "'else' must match a valid statement here") }

invalid_with_stmt:
| [ASYNC] 'with' ','.(expression ['as' star_target])+ &&':'
| [ASYNC] 'with' '(' ','.(expressions ['as' star_target])+ ','? ')' &&':'
Expand Down
58 changes: 57 additions & 1 deletion Lib/test/test_syntax.py
Original file line number Diff line number Diff line change
Expand Up @@ -1318,6 +1318,28 @@
... ...
Traceback (most recent call last):
SyntaxError: positional patterns follow keyword patterns

Non-matching 'elif'/'else' statements:

>>> if a == b:
... ...
... elif a == c:
Traceback (most recent call last):
SyntaxError: 'elif' must match an if-statement here

>>> if x == y:
... ...
... else:
Traceback (most recent call last):
SyntaxError: 'else' must match a valid statement here

>>> elif m == n:
Traceback (most recent call last):
SyntaxError: 'elif' must match an if-statement here

>>> else:
Traceback (most recent call last):
SyntaxError: 'else' must match a valid statement here
"""

import re
Expand All @@ -1334,7 +1356,7 @@ def _check_error(self, code, errtext,
"""Check that compiling code raises SyntaxError with errtext.

errtest is a regular expression that must be present in the
test of the exception raised. If subclass is specified it
test of the exception raised. If subclass is specified, it
is the expected subclass of SyntaxError (e.g. IndentationError).
"""
try:
Expand All @@ -1358,6 +1380,21 @@ def _check_error(self, code, errtext,
else:
self.fail("compile() did not raise SyntaxError")

def _check_noerror(self, code,
errtext="compile() raised unexpected SyntaxError",
filename="<testcase>", mode="exec", subclass=None):
"""Check that compiling code does not raise a SyntaxError.
errtext is the message passed to self.fail if there is
a SyntaxError. If the subclass parameter is specified,
it is the subclass of SyntaxError (e.g. IndentationError)
that the raised error is checked against.
"""
try:
compile(code, filename, mode)
except SyntaxError as err:
if (not subclass) or isinstance(err, subclass):
self.fail(errtext)

def test_expression_with_assignment(self):
self._check_error(
"print(end1 + end2 = ' ')",
Expand Down Expand Up @@ -1629,6 +1666,25 @@ def test_syntax_error_on_deeply_nested_blocks(self):
"""
self._check_error(source, "too many statically nested blocks")

def test_syntax_error_non_matching_elif_else_statements(self):
# Check bpo-45759: 'elif' statements that doesn't match an
# if-statement or 'else' statements that doesn't match any
# valid else-able statement (e.g. 'while')
self._check_error(
"elif m == n:\n ...",
"'elif' must match an if-statement here")
self._check_error(
"else:\n ...",
"'else' must match a valid statement here")
self._check_noerror("if a == b:\n ...\nelif a == c:\n ...")
self._check_noerror("if x == y:\n ...\nelse:\n ...")
self._check_error(
"else = 123",
"invalid syntax")
self._check_error(
"elif 55 = 123",
"invalid syntax")


def load_tests(loader, tests, pattern):
tests.addTest(doctest.DocTestSuite())
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improved error messages for ``elif``/``else`` statements not matching any valid statements. Patch by Jeremiah Vivian.
Loading