tldr/pages/common/black.md

black

A Python auto code formatter. More information: https://github.com/psf/black.

• Auto-format a file or entire directory:

black {{path/to/file_or_directory}}

• Format the code passed in as a string:

black -c {{path/to/file_or_directory}}

• Output a diff for each file on stdout:

black --diff {{path/to/file_or_directory}}

• Return the status without writing the files back:

black --check {{path/to/file_or_directory}}

• Auto-format a file or directory emitting exclusively error messages to stderr:

black --quiet {{path/to/file_or_directory}}

• Auto-format a file or directory without replacing single quotes with double quotes (adoption helper, avoid using this for new projects):

black --skip-string-normalization {{path/to/file_or_directory}}