Formatter extension for Visual Studio Code using `black`

A Visual Studio Code extension with support for the black formatter. The extension ships with black=23.3.0.

Note:

This extension is supported for all actively supported versions of the python language (i.e., python >= 3.7).
The bundled black is only used if there is no installed version of black found in the selected python environment.
Minimum supported version of black is 22.3.0.
This extension is experimental. The plan is that it will eventually replace the black formatting functionality of the Python extension.

Usage

Once installed in Visual Studio Code, "Black Formatter" will be available as a formatter for python files. Please select "Black Formatter" (extension id:ms-python.black-formatter) as the default formatter. You can do this either by using the context menu (right click on a open python file in the editor) and select "Format Document With...", or you can add the following to your settings:

  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  }

and change the following, if set:

  "python.formatting.provider": "none"

Format on save

You can enable format on save for python by having the following values in your settings:

  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnSave": true
  }

Disabling formatting with `black`

If you want to disable Black formatter, you can disable this extension per workspace in Visual Studio Code.

Settings

Settings	Default	Description
black-formatter.args	`[]`	Custom arguments passed to `black`. E.g `"black-formatter.args" = ["--config", "<file>"]`
black-formatter.trace	`error`	Sets the tracing level for the extension.
black-formatter.path	`[]`	Setting to provide custom `black` executable. This will slow down formatting, since we will have to run `black` executable every time or file save or open. Example 1: `["~/global_env/black"]` Example 2: `["conda", "run", "-n", "lint_env", "python", "-m", "black"]`
black-formatter.interpreter	`[]`	Path to a python interpreter to use to run the linter server.
black-formatter.importStrategy	`useBundled`	Setting to choose where to load `black` from. `useBundled` picks black bundled with the extension. `fromEnvironment` uses `black` available in the environment.
black-formatter.showNotification	`off`	Setting to control when a notification is shown.

Commands

Command	Description
Black Formatter: Restart	Force re-start the format server.

Black Formatter

Microsoft

Formatter extension for Visual Studio Code using black