commands.sh

black

all

Format Python code automatically. See also: `ruff`.

More info →

Options (3)

-c, --codeboolean

Format the code passed in as a string

Example: black {{[-c|--code]}} "{{code}}"
-q, --quietboolean

Auto-format a file or directory, emitting exclusively error messages to `stderr`

Example: black {{[-q|--quiet]}} {{path/to/file_or_directory}}
-S, --skip-string-normalizationboolean

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

Example: black {{[-S|--skip-string-normalization]}} {{path/to/file_or_directory}}

Examples (6)

Auto-format a file or entire directory

black path/to/file_or_directory

Format the code passed in as a string

black [-c|--code] "code"

Show whether a file or a directory would have changes made to them if they were to be formatted

black --check path/to/file_or_directory

Show changes that would be made to a file or a directory without performing them (dry-run)

black --diff path/to/file_or_directory

Auto-format a file or directory, emitting exclusively error messages to `stderr`

black [-q|--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 [-S|--skip-string-normalization] path/to/file_or_directory
made by @shridhargupta | data from tldr-pages