Black is "the uncompromising Python code formatter." It can be configured to automatically format your code whenever you save a file in VSCode.
Install Black in your virtual environment:
$ pip install black
Install Microsoft's Python extension in VSCode:
Open your VSCode settings, by going 'Code -> Preferences -> Settings'.
Search for "python formatting provider" and select "black" from the dropdown menu:
In the settings, search for "format on save" and enable the "Editor: Format on Save" option:
Black will now format your code whenever you save a *.py
file.
Was this helpful? Did I save you some time? For $1 you can...
🫖 Buy Me A Tea! ☕️
More: How to set Black line lengths in VSCode
Images from VSCode using Hyper Term Theme.
Top comments (9)
I generally need to pass in the
black
path as well. This might be compatibility issues with wsl.settings.json
additionally you can turn on automatic formatting on save
if you don't want automatic formatting on save for every language
Thanks
What if I want to override
(88)
the default chars per line?You can add this to your
pyproject.toml
,~/.black
,$XDG_CONFIG_HOME/black
, or~/.config/black
black.readthedocs.io/en/stable/usa...
I'm a fan of using
pyproject.toml
, but as an alternative to Waylon's comment regarding config files, you can also configure the line length in VSCode.I am just doing a code review and this post was perfect for me to link it inside a comment about an illformted code. Thank you.
Thanks for the quick write up Adam. I was recently referred to start using Black and was curious about getting it running with VSC. This is exactly what I was looking for!
Glad it was helpful! :)
good :D
can I use it with *.rpy Ren'Py files?