Handle when black times out formatting on save

[fredrikaverpil]

Environment data

• VS Code version: 1.28.2
• Extension version (available under the Extensions sidebar): 2018.9.2
• OS and version: Windows 10
• Python version (& distribution if applicable, e.g. Anaconda): Miniconda Python 3.7
• Type of virtual environment used (N/A | venv | virtualenv | conda | ...): venv
• Relevant/affected Python packages and their versions: black 18.9b0

Actual behavior

When black fails to format on save due to timeout, there is no message in the output window, indicating this is the reason for not formatting the document.

Expected behavior

When black fails to format on save due to timeout, it would be useful to see some kind of warning about this in the output window. Not only in the developer tools console.

Steps to reproduce:

1. Set "python.formatting.provider": "black", "editor.formatOnSave": true and save a large Python script (mine was 712 pep8-compliant rows).
2. Save

Logs

Output for Python in the Output panel (View→Output, change the drop-down the upper-right of the Output panel to Python)

Starting Jedi Python language engine.

Output from Console under the Developer Tools panel (toggle Developer Tools on under Help)

WARN Aborted format on save after 750ms

Extra note

As a solution to the fact that black doesn't format a big file, increase the default "editor.formatOnSaveTimeout": 750 to a larger value in settings.json.

However, this issue is not about that, but rather the fact that it took me hours 🤕 to figure out WHY black was not formatting on save, as I was unaware of the developer tools console.

[brettcannon]

Sorry about the time it took to diagnose. 😞 We know we need to add more debugging information in the extension.

[fredrikaverpil]

Hey @brettcannon no worries. I failed to explain "it took me hours" to figure this one out but also get set up with black as a whole in a large project. So, to be fair, it sounded worse than it was from that sentence. Sorry about that. But I anticipate that if black will timeout this easily, lots of users may start thinking something's wrong and spam you with issues here in github (like I do). 😉

Thanks again for your tremendous work on vscode-python!

[brettcannon]

We are going to consider this a feature request for VS Code to generically prompt when formatting times out to provide a notification.

We have opened #3642 , though, to look at our default value to potentially increase it.

[amiantos]

Came to Github to file an issue for this! I assumed format on save was buggy due to the silent failure and was just dealing with it for about a week or two before I realized I should say something, and the process of filing an issue made me learn the timeout setting was the cause. Doubling the timeout from 750 to 1500 solved the problem for me.