Scroll to navigation

(1) uncompromising Python code formatter (1)

NAME

black - uncompromising Python code formatter

SUMMARY

black is the uncompromising Python code formatter. By using it, you agree to cede control over minutiae of hand-formatting. In return, Black gives you speed, determinism, and freedom from pycodestyle nagging about formatting. You will save time and mental energy for more important matters.

USAGE

black [OPTIONS] [SRC]...

COMMON OPTIONS

Format the code passed in as a string.
How many characters per line to allow. [default: 88]

Python versions that should be supported by Black's output. [default: per-file auto- detection]

Format all input files like typing stubs regardless of file extension (useful when piping source on standard input).
Don't normalize string quotes or prefixes.
Don't use trailing commas as a reason to split lines.
Don't write the files back, just return the status. Return code 0 means nothing would change. Return code 1 means some files would be reformatted. Return code 123 means there was an internal error.
Don't write the files back, just output a diff for each file on stdout.

--diff is given.
checks. [default: --safe]

A regular expression that matches files and directories that should be included on recursive searches. An empty value means all files are included regardless of the name. Use forward slashes for directories on all platforms (Windows, too). Exclusions are calculated first, inclusions later. [default: .pyi?$]
A regular expression that matches files and directories that should be excluded on recursive searches. An empty value means no paths are excluded. Use forward slashes for directories on all platforms (Windows, too). Exclusions are calculated first, inclusions later. [default: /(.git|.hg|.mypy_cache| .tox|.venv|_build|buck-out|build|dist)/]
Like --exclude, but adds additional files and directories on top of the excluded ones. (Useful if you simply want to add to the default)
Like --exclude, but files and directories matching this regex will be excluded even when they are passed explicitly as arguments.
The name of the file when passing it through stdin. Useful to make sure Black will respect --force-exclude option on some editors that rely on using stdin.
Don't emit non-error messages to stderr. Errors are still emitted, silence those with 2>/dev/null.
Also emit messages to stderr about files that were not changed or were ignored due to --exclude=.
Show the version and exit.
Read configuration from PATH.
Show this message and exit.


COPYRIGHT

2018 Łukasz Langa

2021-10-10 21.4b2