Black¶

https://black.readthedocs.io/

Formatting the code with black: black <filepath>. e.g., black .

vscode black formatter extension¶

Format the file on save

option 1 (works)

• install black-formatter extension

• In user settings, add

  "black-formatter.args": ["-S"]
  "python.formatting.provider": "none",
  "[python]": {
      "editor.defaultFormatter": "ms-python.black-formatter",
      "editor.formatOnSave": true
  }
  

option 2: works but slow

• install black in python env

• In user settings, add

  "python.formatting.provider": "black",
  "editor.formatOnSave": true,
  

config¶

https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file

pyproject.toml

[tool.black]
line-length = 88
target-version = ['py39']
skip-string-normalization = true #disable string double quotes normalization
include = '\.pyi?$'
--force-exclude = '''versioneer.py''' #exclide this file either from saving or cli
preview = false

ignore line/lines¶

# fmt: skip
# fmt: off/on