VSCode: Using Black to automatically format Python

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.

Before saving:

After saving:

---

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.

Comments

[Attila Molnar]

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.

[Eugene Kuzmenko]

can I use it with *.rpy Ren'Py files?

[Marc Anthony Card]

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!

[Adam Lombard]

Glad it was helpful! :)

[Waylon Walker]

I generally need to pass in the black path as well. This might be compatibility issues with wsl.

pipx install black

settings.json

  "python.formatting.provider": "black",
  "python.formatting.blackPath": "/home/<user>/.local/bin/black",

---

additionally you can turn on automatic formatting on save

"editor.formatOnSave": true,

---

if you don't want automatic formatting on save for every language

  "editor.formatOnSave": false,
  "[python]": {
    "editor.formatOnSave": true,
   },

[Luqman Jr]

Thanks
What if I want to override (88) the default chars per line?

[Adam Lombard]

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.

[Waylon Walker]

You can add this to your pyproject.toml, ~/.black, $XDG_CONFIG_HOME/black, or ~/.config/black

[tool.black]
line-length = 88

black.readthedocs.io/en/stable/usa...

[Nguyễn Minh Tuấn]

good :D