Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix bad formatting of error messages about EOF in multi-line statements #2343

Merged
merged 10 commits into from Dec 4, 2021
Merged

Fix bad formatting of error messages about EOF in multi-line statements #2343

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
05e50d9
Adding TokenError to lib2to3 function
tanvimoharir Jun 20, 2021
07734f0
Merge branch 'psf:main' into bad-format-error-message
tanvimoharir Jun 25, 2021
179f1ec
Removing redundent exception handling for TokenError
tanvimoharir Jun 25, 2021
705e027
Merge branch 'psf:main' into bad-format-error-message
tanvimoharir Jul 21, 2021
fc40194
Changing message for TokenError
tanvimoharir Jul 21, 2021
b5a3a7b
Removing splitlines
tanvimoharir Aug 30, 2021
813c8dd
Adding tests
tanvimoharir Sep 8, 2021
8ded011
Cleanup tests and improve error message
ichard26 Dec 4, 2021
0b3d6db
Merge branch 'main' into bad-format-error-message
ichard26 Dec 4, 2021
339a173
Move changelog to the right spot
ichard26 Dec 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Expand Up @@ -23,6 +23,7 @@
- Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
- Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
used (#2319)
- Fix bad formatting of error messages about EOF in multi-line statements (#2343)

### Integrations

Expand Down
9 changes: 7 additions & 2 deletions src/black/parsing.py
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@
from blib2to3.pgen2 import driver
from blib2to3.pgen2.grammar import Grammar
from blib2to3.pgen2.parse import ParseError
from blib2to3.pgen2.tokenize import TokenError

from black.mode import TargetVersion, Feature, supports_feature
from black.nodes import syms
Expand Down Expand Up @@ -84,14 +85,18 @@ def lib2to3_parse(src_txt: str, target_versions: Iterable[TargetVersion] = ()) -
result = drv.parse_string(src_txt, True)
break

except ParseError as pe:
lineno, column = pe.context[1]
except (TokenError, ParseError) as err:
if isinstance(err, ParseError):
lineno, column = err.context[1]
else:
lineno, column = err.args[1]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying to understand why i'm getting linenumber value as 2 for token error:

(black) bash-3.2$ python -m src.black --check --code "print("
error: cannot format <string>: Cannot parse: 2:0: <line number missing in source>
(black) bash-3.2$ python -m src.black --check --code "print([)" 
error: cannot format <string>: Cannot parse: 1:7: print([)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeahhh that seems to be a bug with the blib2to3 library. We can just ignore that for this PR, it's better if we can just get this landed so while the error message won't be perfect, it should be better than error: cannot format <string>: ('EOF in multi-line statement', (2, 0)) :)

Although a problem is that the source isn't printed at all which is unfortunate since it would be quite useful. Perhaps it would be good to also include that it was an "unexpected EOF" error in the message?

Good catch tho!

lines = src_txt.splitlines()
try:
faulty_line = lines[lineno - 1]
except IndexError:
faulty_line = "<line number missing in source>"
exc = InvalidInput(f"Cannot parse: {lineno}:{column}: {faulty_line}")

else:
raise exc from None

Expand Down