Bad formatting of error messages about EOF in multi-line statements

[Jackenmen]

Describe the bug

"EOF in multi-line statement" error is shown to the user as the raw tuple it was returned as, rather than in a nicely formatted message.

To Reproduce

For example:

1. Take this (invalid) file:

print(

2. Run Black on it with no arguments
3. See a message with the EOF error being shown as a raw tuple representation:

error: cannot format test_black.py: ('EOF in multi-line statement', (2, 0))
Oh no! 💥 💔 💥
1 file failed to reformat.

Expected behavior

A bit more nicely formatted error message.

Environment (please complete the following information):

• Version:
• OS and Python version:

Does this bug also happen on main?

Yes.

Additional context

For comparison, here's how I'm assuming the error should look like:

error: cannot format test_black.py: Cannot parse: 1:7: print([)
Oh no! 💥 💔 💥
1 file failed to reformat.

which is what you get in output when you try to format:

print([)

[felix-hilden]

Many thanks for reporting!

[Jackenmen]

It appears to be about TokenError (and potentially also IndentationError) exception leaking out from lib2to3_parse() call. Should the lib2to3_parse() function just be updated to handle these 2 errors or is there some other solution that would be preferred here?

[ichard26]

Eh, it seems to be just easier to add those two exceptions to the except definition than come up withe something more complicated.

[tanvimoharir]

Hi,
I would like to work on this. (I'm new to this).
Thanks

[felix-hilden]

Hi, thanks for considering contributing! And welcome 😄 I don't think anyone's currently working on it so feel free to attempt a fix 👍 Jack's messages above should get you in the right direction.

[avishmehta68710]

Hi
Is this issue open or is it solved
Thanks

[surfaceowl]

This EOF in multi-line statement error is also triggered if you are using a jupyter notebook and have a cell with sample terminal command set as a code cell rather than Markdown or Raw NBConvert.

[Last-Winner]

Error compiling contract, Error message:
tokenize.TokenError: ('EOF in multi-line statement', (230, 0))

The above exception was the direct cause of the following exception:

vyper.exceptions.SyntaxException: EOF in multi-line statement
line 230:0
229 227 ],
---> 230
---------^

[amarvin]

I still get this error EOF in multi-line statement when trying to format using black a Jupyter Notebook cell that contains an incorrectly formatted f-string. Here's a minimal example cell:

print(f"{"#"}")

It took me a while to find which of the cells caused the error, as the error doesn't say. Running the problematic cell in a Python terminal shows that it still expected additional input to complete the statement, hence why an error was thrown by black when the cell unexpectedly ended. The correct cell contents should be:

print(f"{'#'}")

I posted about it in Stack Overflow on a similar question https://stackoverflow.com/a/77622709/6068036

[JelleZijlstra]

@amarvin that's #3746.

[amarvin]

@amarvin that's #3746.

Good point! That should cover this.