“Any color you like.”
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.
Blackened code looks the same regardless of the project you're reading. Formatting becomes transparent after a while and you can focus on the content instead.
Black makes code review faster by producing the smallest diffs possible.
Try it out now using the Black Playground. Watch the PyCon 2019 talk to learn more.
Contents: Installation and usage | Code style | Pragmatism | pyproject.toml | Editor integration | blackd | black-primer | Version control integration | GitHub Actions | Ignoring unmodified files | Used by | Testimonials | Show your style | Contributing | Change log | Authors
Black can be installed by running pip install black. It requires Python 3.6.2+ to
run. If you want to format Python 2 code as well, install with
pip install black[python2].
If you can't wait for the latest hotness and want to install from GitHub, use:
pip install git+git://github.com/psf/black
To get started right away with sensible defaults:
black {source_file_or_directory}You can run Black as a package if running it as a script doesn't work:
python -m black {source_file_or_directory}Black doesn't provide many options. You can list them by running black --help:
Usage: black [OPTIONS] [SRC]...
The uncompromising code formatter.
Options:
-c, --code TEXT Format the code passed in as a string.
-l, --line-length INTEGER How many characters per line to allow.
[default: 88]
-t, --target-version [py27|py33|py34|py35|py36|py37|py38|py39]
Python versions that should be supported by
Black's output. [default: per-file auto-
detection]
--pyi Format all input files like typing stubs
regardless of file extension (useful when
piping source on standard input).
-S, --skip-string-normalization
Don't normalize string quotes or prefixes.
-C, --skip-magic-trailing-comma
Don't use trailing commas as a reason to
split lines.
--check 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.
--diff Don't write the files back, just output a
diff for each file on stdout.
--color / --no-color Show colored diff. Only applies when
`--diff` is given.
--fast / --safe If --fast given, skip temporary sanity
checks. [default: --safe]
--include TEXT 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?$]
--exclude TEXT 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: /(\.direnv|\.eggs|\.git|\.
hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_bu
ild|buck-out|build|dist)/]
--extend-exclude TEXT Like --exclude, but adds additional files
and directories on top of the excluded
ones (useful if you simply want to add to
the default).
--force-exclude TEXT Like --exclude, but files and directories
matching this regex will be excluded even
when they are passed explicitly as
arguments.
--stdin-filename TEXT 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.
-q, --quiet Don't emit non-error messages to stderr.
Errors are still emitted; silence those with
2>/dev/null.
-v, --verbose Also emit messages to stderr about files
that were not changed or were ignored due to
exclusion patterns.
--version Show the version and exit.
--config FILE Read configuration from FILE path.
-h, --help Show this message and exit.
Black is a well-behaved Unix-style command-line tool:
- it does nothing if no sources are passed to it;
- it will read from standard input and write to standard output if
-is used as the filename; - it only outputs messages to users on standard error;
- exits with code 0 unless an internal error occurred (or
--checkwas used).
While Black enforces formatting that conforms to PEP 8, other tools may raise warnings about Black's changes or will overwrite Black's changes. A good example of this is isort. Since Black is barely configurable, these tools should be configured to neither warn about nor overwrite Black's changes.
Actual details on Black compatible configurations for various tools can be found in compatible_configs.
A long-standing argument against moving to automated code formatters like Black is
that the migration will clutter up the output of git blame. This was a valid argument,
but since Git version 2.23, Git natively supports
ignoring revisions in blame
with the --ignore-rev option. You can also pass a file listing the revisions to ignore
using the --ignore-revs-file option. The changes made by the revision will be ignored
when assigning blame. Lines modified by an ignored revision will be blamed on the
previous revision that modified those lines.
So when migrating your project's code style to Black, reformat everything and commit the changes (preferably in one massive commit). Then put the full 40 characters commit identifier(s) into a file.
# Migrate code style to Black
5b4ab991dede475d393e9d69ec388fd6bd949699
Afterwards, you can pass that file to git blame and see clean and meaningful blame
information.
$ git blame important.py --ignore-revs-file .git-blame-ignore-revs
7a1ae265 (John Smith 2019-04-15 15:55:13 -0400 1) def very_important_function(text, file):
abdfd8b0 (Alice Doe 2019-09-23 11:39:32 -0400 2) text = text.lstrip()
7a1ae265 (John Smith 2019-04-15 15:55:13 -0400 3) with open(file, "r+") as f:
7a1ae265 (John Smith 2019-04-15 15:55:13 -0400 4) f.write(formatted)You can even configure git to automatically ignore revisions listed in a file on every
call to git blame.
$ git config blame.ignoreRevsFile .git-blame-ignore-revsThe one caveat is that GitHub and GitLab do not yet support ignoring revisions using their native UI of blame. So blame information will be cluttered with a reformatting commit on those platforms. (If you'd like this feature, there's an open issue for GitLab and please let GitHub know!)
Black is already successfully used by many projects, small and big. It also sports a decent test suite. However, it is still very new. Things will probably be wonky for a while. This is made explicit by the "Beta" trove classifier, as well as by the "b" in the version number. What this means for you is that until the formatter becomes stable, you should expect some formatting to change in the future. That being said, no drastic stylistic changes are planned, mostly responses to bug reports.
Also, as a temporary safety measure, Black will check that the reformatted code still
produces a valid AST that is equivalent to the original. This slows it down. If you're
feeling confident, use --fast.
Black is a PEP 8 compliant opinionated formatter. Black reformats entire files in
place. It is not configurable. It doesn't take previous formatting into account. Your
main option of configuring Black is that it doesn't reformat blocks that start with
# fmt: off and end with # fmt: on, or lines that ends with # fmt: skip. Pay
attention that # fmt: on/off have to be on the same level of indentation. To learn
more about Black's opinions, to go
the_black_code_style.
Please refer to this document before submitting an issue. What seems like a bug might be intended behaviour.
Early versions of Black used to be absolutist in some respects. They took after its
initial author. This was fine at the time as it made the implementation simpler and
there were not many users anyway. Not many edge cases were reported. As a mature tool,
Black does make some exceptions to rules it otherwise holds. This
section
of the_black_code_style describes what those exceptions are and why this is the case.
Please refer to this document before submitting an issue just like with the document above. What seems like a bug might be intended behaviour.
Black is able to read project-specific default values for its command line options
from a pyproject.toml file. This is especially useful for specifying custom
--include and --exclude/--extend-exclude patterns for your project.
Pro-tip: If you're asking yourself "Do I need to configure anything?" the answer is "No". Black is all about sensible defaults.
PEP 518 defines pyproject.toml as a
configuration file to store build system requirements for Python projects. With the help
of tools like Poetry or
Flit it can fully replace the need for
setup.py and setup.cfg files.
By default Black looks for pyproject.toml starting from the common base directory of
all files and directories passed on the command line. If it's not there, it looks in
parent directories. It stops looking when it finds the file, or a .git directory, or a
.hg directory, or the root of the file system, whichever comes first.
If you're formatting standard input, Black will look for configuration starting from the current working directory.
You can use a "global" configuration, stored in a specific location in your home directory. This will be used as a fallback configuration, that is, it will be used if and only if Black doesn't find any configuration as mentioned above. Depending on your operating system, this configuration file should be stored as:
- Windows:
~\.black - Unix-like (Linux, MacOS, etc.):
$XDG_CONFIG_HOME/black(~/.config/blackif theXDG_CONFIG_HOMEenvironment variable is not set)
Note that these are paths to the TOML file itself (meaning that they shouldn't be named
as pyproject.toml), not directories where you store the configuration. Here, ~
refers to the path to your home directory. On Windows, this will be something like
C:\\Users\UserName.
You can also explicitly specify the path to a particular file that you want with
--config. In this situation Black will not look for any other file.
If you're running with --verbose, you will see a blue message if a file was found and
used.
Please note blackd will not use pyproject.toml configuration.
As the file extension suggests, pyproject.toml is a
TOML file. It contains separate sections for
different tools. Black is using the [tool.black] section. The option keys are the
same as long names of options on the command line.
Note that you have to use single-quoted strings in TOML for regular expressions. It's
the equivalent of r-strings in Python. Multiline strings are treated as verbose regular
expressions by Black. Use [ ] to denote a significant space character.
Example pyproject.toml
[tool.black]
line-length = 88
target-version = ['py37']
include = '\.pyi?$'
extend-exclude = '''
# A regex preceded with ^/ will apply only to files and directories
# in the root of the project.
^/foo.py # exclude a file named foo.py in the root of the project (in addition to the defaults)
'''Command-line options have defaults that you can see in --help. A pyproject.toml can
override those defaults. Finally, options provided by the user on the command line
override both.
Black will only ever use one pyproject.toml file during an entire run. It doesn't
look for multiple files, and doesn't compose configuration from different levels of the
file hierarchy.
Black can be integrated into many editors with plugins. They let you run Black on your code with the ease of doing it in your editor. To get started using Black in your editor of choice, please see editor_integration.
Patches are welcome for editors without an editor integration or plugin! More information can be found in editor_integration.
blackd is a small HTTP server that exposes Black's functionality over a simple
protocol. The main benefit of using it is to avoid paying the cost of starting up a new
Black process every time you want to blacken a file. Please refer to
blackd to get the ball
rolling.
black-primer is a tool built for CI (and humans) to have Black --check a number of
(configured in primer.json) Git accessible projects in parallel.
black_primer has more
information regarding its usage and configuration.
(A PR adding Mercurial support will be accepted.)
Use pre-commit. Once you
have it installed, add this to the
.pre-commit-config.yaml in your repository:
repos:
- repo: https://github.com/psf/black
rev: 20.8b1 # Replace by any tag/version: https://github.com/psf/black/tags
hooks:
- id: black
language_version: python3 # Should be a command that runs python3.6+Then run pre-commit install and you're ready to go.
Avoid using args in the hook. Instead, store necessary configuration in
pyproject.toml so that editors and command-line usage of Black all behave consistently
for your project. See Black's own
pyproject.toml for an
example.
If you're already using Python 3.7, switch the language_version accordingly. Finally,
stable is a branch that tracks the latest release on PyPI. If you'd rather run on
master, this is also an option.
Create a file named .github/workflows/black.yml inside your repository with:
name: Lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: psf/black@stable
with:
args: ". --check"optional: Black input arguments. Defaults to . --check --diff.
Black remembers files it has already formatted, unless the --diff flag is used or
code is passed via standard input. This information is stored per-user. The exact
location of the file depends on the Black version and the system on which Black is
run. The file is non-portable. The standard location on common operating systems is:
- Windows:
C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.<file-mode>.pickle - macOS:
/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.<file-mode>.pickle - Linux:
/home/<username>/.cache/black/<version>/cache.<line-length>.<file-mode>.pickle
file-mode is an int flag that determines whether the file was formatted as 3.6+ only,
as .pyi, and whether string normalization was omitted.
To override the location of these files on macOS or Linux, set the environment variable
XDG_CACHE_HOME to your preferred location. For example, if you want to put the cache
in the directory you're running Black from, set XDG_CACHE_HOME=.cache. Black will
then write the above files to .cache/black/<version>/.
The following notable open-source projects trust Black with enforcing a consistent code style: pytest, tox, Pyramid, Django Channels, Hypothesis, attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Bandersnatch, Pipenv, virtualenv), pandas, Pillow, every Datadog Agent Integration, Home Assistant, Zulip.
The following organizations use Black: Facebook, Dropbox, Mozilla, Quora.
Are we missing anyone? Let us know.
Dusty Phillips, writer:
Black is opinionated so you don't have to be.
Hynek Schlawack, creator of attrs, core developer of
Twisted and CPython:
An auto-formatter that doesn't suck is all I want for Xmas!
Carl Meyer, Django core developer:
At least the name is good.
Kenneth Reitz, creator of requests and
pipenv:
This vastly improves the formatting of our code. Thanks a ton!
Use the badge in your project's README.md:
[](https://github.com/psf/black)Using the badge in README.rst:
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
Looks like this:
MIT
In terms of inspiration, Black is about as configurable as gofmt. This is deliberate.
Bug reports and fixes are always welcome! However, before you suggest a new feature or configuration knob, ask yourself why you want it. If it enables better integration with some workflow, fixes an inconsistency, speeds things up, and so on - go for it! On the other hand, if your answer is "because I don't like a particular formatting" then you're not ready to embrace Black yet. Such changes are unlikely to get accepted. You can still try but prepare to be disappointed.
More details can be found in CONTRIBUTING.
The log's become rather long. It moved to its own file.
See CHANGES.
Glued together by Łukasz Langa.
Maintained with Carol Willing, Carl Meyer, Jelle Zijlstra, Mika Naylor, Zsolt Dollenstein, and Cooper Lees.
Multiple contributions by:
- Abdur-Rahmaan Janhangeer
- Adam Johnson
- Adam Williamson
- Alexander Huynh
- Alex Vandiver
- Allan Simon
- Anders-Petter Ljungquist
- Andrew Thorp
- Andrew Zhou
- Andrey
- Andy Freeland
- Anthony Sottile
- Arjaan Buijk
- Arnav Borbornah
- Artem Malyshev
- Asger Hautop Drewsen
- Augie Fackler
- Aviskar KC
- Batuhan Taşkaya
- Benjamin Wohlwend
- Benjamin Woodruff
- Bharat Raghunathan
- Brandt Bucher
- Brett Cannon
- Bryan Bugyi
- Bryan Forbes
- Calum Lind
- Charles
- Charles Reid
- Christian Clauss
- Christian Heimes
- Chuck Wooters
- Chris Rose
- Codey Oxley
- Cong
- Cooper Ry Lees
- Dan Davison
- Daniel Hahler
- Daniel M. Capella
- Daniele Esposti
- David Hotham
- David Lukes
- David Szotten
- Denis Laxalde
- Douglas Thor
- dylanjblack
- Eli Treuherz
- Emil Hessman
- Felix Kohlgrüber
- Florent Thiery
- Francisco
- Giacomo Tagliabue
- Greg Gandenberger
- Gregory P. Smith
- Gustavo Camargo
- hauntsaninja
- Hadi Alqattan
- Heaford
- Hugo Barrera
- Hugo van Kemenade
- Hynek Schlawack
- Ivan Katanić
- Jakub Kadlubiec
- Jakub Warczarek
- Jan Hnátek
- Jason Fried
- Jason Friedland
- jgirardet
- Jim Brännlund
- Jimmy Jia
- Joe Antonakakis
- Jon Dufresne
- Jonas Obrist
- Jonty Wareing
- Jose Nazario
- Joseph Larson
- Josh Bode
- Josh Holland
- Joshua Cannon
- José Padilla
- Juan Luis Cano Rodríguez
- kaiix
- Katie McLaughlin
- Katrin Leinweber
- Keith Smiley
- Kenyon Ralph
- Kevin Kirsche
- Kyle Hausmann
- Kyle Sunden
- Lawrence Chan
- Linus Groh
- Loren Carvalho
- Luka Sterbic
- LukasDrude
- Mahmoud Hossam
- Mariatta
- Matt VanEseltine
- Matthew Clapp
- Matthew Walster
- Max Smolens
- Michael Aquilina
- Michael Flaxman
- Michael J. Sullivan
- Michael McClimon
- Miguel Gaiowski
- Mike
- mikehoyio
- Min ho Kim
- Miroslav Shubernetskiy
- MomIsBestFriend
- Nathan Goldbaum
- Nathan Hunt
- Neraste
- Nikolaus Waxweiler
- Ofek Lev
- Osaetin Daniel
- otstrel
- Pablo Galindo
- Paul Ganssle
- Paul Meinhardt
- Peter Bengtsson
- Peter Grayson
- Peter Stensmyr
- pmacosta
- Quentin Pradet
- Ralf Schmitt
- Ramón Valles
- Richard Fearn
- Richard Si
- Rishikesh Jha
- Rupert Bedford
- Russell Davis
- Rémi Verschelde
- Sami Salonen
- Samuel Cormier-Iijima
- Sanket Dasgupta
- Sergi
- Scott Stevenson
- Shantanu
- shaoran
- Shinya Fujino
- springstan
- Stavros Korokithakis
- Stephen Rosen
- Steven M. Vascellaro
- Sunil Kapil
- Sébastien Eustace
- Tal Amuyal
- Terrance
- Thom Lu
- Thomas Grainger
- Tim Gates
- Tim Swast
- Timo
- Toby Fleming
- Tom Christie
- Tony Narlock
- Tsuyoshi Hombashi
- Tushar Chandra
- Tzu-ping Chung
- Utsav Shah
- utsav-dbx
- vezeli
- Ville Skyttä
- Vishwas B Sharma
- Vlad Emelianov
- williamfzc
- wouter bolsterlee
- Yazdan
- Yngve Høiseth
- Yurii Karabas
- Zac Hatfield-Dodds