Black

The uncompromising Python code formatter.

• black.readthedocs.io/en/stable
• github.com/psf/black

Installation

pip install black

Jupyter Notebooks

pip install 'black[jupyter]'

Comment

It doesn't reformat blocks that start with # fmt: off and end with # fmt: on, or lines that ends with # fmt: skip. # fmt: on/off have to be on the same level of indentation.

# fmt: off

j = [1,
     2,
     3
]

# fmt: on

Integration with visual studio code

settings.json

{
    "python.formatting.provider": "black",
    "python.formatting.blackArgs": ["--line-length", "88"],

    "[python]": {
        "editor.defaultFormatter": "ms-python.python",
        "editor.tabSize": 4,
        "editor.formatOnSave": true,
    },
}

Provider for formatting. Possible options include ‘autopep8', ‘black', and ‘yapf'.

{
    "python.formatting.provider": "black",
}

Arguments passed in. Each argument is as separate item in the array.

{
    "python.formatting.blackArgs": ["--line-length", "88"],
}

Configure settings to be overridden for the python language.

{
    "[python]": {
        "editor.defaultFormatter": "ms-python.python",
        "editor.tabSize": 4,
        "editor.formatOnSave": true,
    },
}

Integration with Git Hooks

To use Python, you need to install the pre-commit package.

repos:
  - repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
      - id: black
        language_version: python3.9
        args: ["--line-length=88"]