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

Changes from 1 commit
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
11 changes: 11 additions & 0 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 @@ -92,6 +93,16 @@ def lib2to3_parse(src_txt: str, target_versions: Iterable[TargetVersion] = ()) -
except IndexError:
faulty_line = "<line number missing in source>"
exc = InvalidInput(f"Cannot parse: {lineno}:{column}: {faulty_line}")

except TokenError as te:
lineno, column = te.args[1]
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}")

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 have tried to keep the format consistent with ParseError above but still need to correct the values for lineno,column and faulty_line (which are currently wrong)

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we can do without the duplication of code by conditionalizing (made that up right now :p) the lineno. and col. information extraction code. So in the end it would look something like this (warning: untested):

        try:
            result = drv.parse_string(src_txt, True)
            break

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

            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}")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks I will try this. I had initially thought of making changes here https://github.com/psf/black/blob/main/src/blib2to3/pgen2/tokenize.py#L177

else:
raise exc from None

Expand Down