All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
1 [![Black Logo](https://raw.githubusercontent.com/psf/black/main/docs/_static/logo2-readme.png)](https://black.readthedocs.io/en/stable/)
3 <h2 align="center">The Uncompromising Code Formatter</h2>
6 <a href="https://github.com/psf/black/actions"><img alt="Actions Status" src="https://github.com/psf/black/workflows/Test/badge.svg"></a>
7 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
8 <a href="https://coveralls.io/github/psf/black?branch=main"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=main"></a>
9 <a href="https://github.com/psf/black/blob/main/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
10 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://img.shields.io/pypi/v/black"></a>
11 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
12 <a href="https://anaconda.org/conda-forge/black/"><img alt="conda-forge" src="https://img.shields.io/conda/dn/conda-forge/black.svg?label=conda-forge"></a>
13 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
16 > “Any color you like.”
18 _Black_ is the uncompromising Python code formatter. By using it, you agree to cede
19 control over minutiae of hand-formatting. In return, _Black_ gives you speed,
20 determinism, and freedom from `pycodestyle` nagging about formatting. You will save time
21 and mental energy for more important matters.
23 Blackened code looks the same regardless of the project you're reading. Formatting
24 becomes transparent after a while and you can focus on the content instead.
26 _Black_ makes code review faster by producing the smallest diffs possible.
28 Try it out now using the [Black Playground](https://black.vercel.app). Watch the
29 [PyCon 2019 talk](https://youtu.be/esZLCuWs_2Y) to learn more.
33 **[Read the documentation on ReadTheDocs!](https://black.readthedocs.io/en/stable)**
37 ## Installation and usage
41 _Black_ can be installed by running `pip install black`. It requires Python 3.7+ to run.
42 If you want to format Jupyter Notebooks, install with `pip install 'black[jupyter]'`.
44 If you can't wait for the latest _hotness_ and want to install from GitHub, use:
46 `pip install git+https://github.com/psf/black`
50 To get started right away with sensible defaults:
53 black {source_file_or_directory}
56 You can run _Black_ as a package if running it as a script doesn't work:
59 python -m black {source_file_or_directory}
62 Further information can be found in our docs:
64 - [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html)
66 _Black_ is already [successfully used](https://github.com/psf/black#used-by) by many
67 projects, small and big. _Black_ has a comprehensive test suite, with efficient parallel
68 tests, and our own auto formatting and parallel Continuous Integration runner. Now that
69 we have become stable, you should not expect large formatting to changes in the future.
70 Stylistic changes will mostly be responses to bug reports and support for new Python
71 syntax. For more information please refer to the
72 [The Black Code Style](https://black.readthedocs.io/en/stable/the_black_code_style/index.html).
74 Also, as a safety measure which slows down processing, _Black_ will check that the
75 reformatted code still produces a valid AST that is effectively equivalent to the
77 [Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#ast-before-and-after-formatting)
78 section for details). If you're feeling confident, use `--fast`.
80 ## The _Black_ code style
82 _Black_ is a PEP 8 compliant opinionated formatter. _Black_ reformats entire files in
83 place. Style configuration options are deliberately limited and rarely added. It doesn't
84 take previous formatting into account (see
85 [Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#pragmatism)
88 Our documentation covers the current _Black_ code style, but planned changes to it are
89 also documented. They're both worth taking a look:
91 - [The _Black_ Code Style: Current style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
92 - [The _Black_ Code Style: Future style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html)
94 Changes to the _Black_ code style are bound by the Stability Policy:
96 - [The _Black_ Code Style: Stability Policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy)
98 Please refer to this document before submitting an issue. What seems like a bug might be
103 Early versions of _Black_ used to be absolutist in some respects. They took after its
104 initial author. This was fine at the time as it made the implementation simpler and
105 there were not many users anyway. Not many edge cases were reported. As a mature tool,
106 _Black_ does make some exceptions to rules it otherwise holds.
108 - [The _Black_ code style: Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#pragmatism)
110 Please refer to this document before submitting an issue just like with the document
111 above. What seems like a bug might be intended behaviour.
115 _Black_ is able to read project-specific default values for its command line options
116 from a `pyproject.toml` file. This is especially useful for specifying custom
117 `--include` and `--exclude`/`--force-exclude`/`--extend-exclude` patterns for your
120 You can find more details in our documentation:
122 - [The basics: Configuration via a file](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file)
124 And if you're looking for more general configuration documentation:
126 - [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html)
128 **Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
129 "No". _Black_ is all about sensible defaults. Applying those defaults will have your
130 code in compliance with many other _Black_ formatted projects.
134 The following notable open-source projects trust _Black_ with enforcing a consistent
135 code style: pytest, tox, Pyramid, Django, Django Channels, Hypothesis, attrs,
136 SQLAlchemy, Poetry, PyPA applications (Warehouse, Bandersnatch, Pipenv, virtualenv),
137 pandas, Pillow, Twisted, LocalStack, every Datadog Agent Integration, Home Assistant,
138 Zulip, Kedro, OpenOA, FLORIS, ORBIT, WOMBAT, and many more.
140 The following organizations use _Black_: Facebook, Dropbox, KeepTruckin, Mozilla, Quora,
141 Duolingo, QuantumBlack, Tesla.
143 Are we missing anyone? Let us know.
147 **Mike Bayer**, [author of `SQLAlchemy`](https://www.sqlalchemy.org/):
149 > I can't think of any single tool in my entire programming career that has given me a
150 > bigger productivity increase by its introduction. I can now do refactorings in about
151 > 1% of the keystrokes that it would have taken me previously when we had no way for
152 > code to format itself.
155 [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
157 > _Black_ is opinionated so you don't have to be.
159 **Hynek Schlawack**, [creator of `attrs`](https://www.attrs.org/), core developer of
162 > An auto-formatter that doesn't suck is all I want for Xmas!
164 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
166 > At least the name is good.
168 **Kenneth Reitz**, creator of [`requests`](https://requests.readthedocs.io/en/latest/)
169 and [`pipenv`](https://readthedocs.org/projects/pipenv/):
171 > This vastly improves the formatting of our code. Thanks a ton!
175 Use the badge in your project's README.md:
178 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
181 Using the badge in README.rst:
184 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
185 :target: https://github.com/psf/black
189 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
197 Welcome! Happy to see you willing to make the project better. You can get started by
200 - [Contributing: The basics](https://black.readthedocs.io/en/latest/contributing/the_basics.html)
202 You can also take a look at the rest of the contributing docs or talk with the
205 - [Contributing documentation](https://black.readthedocs.io/en/latest/contributing/index.html)
206 - [Chat on Discord](https://discord.gg/RtVdv86PrH)
210 The log has become rather long. It moved to its own file.
212 See [CHANGES](https://black.readthedocs.io/en/latest/change_log.html).
216 The author list is quite long nowadays, so it lives in its own file.
218 See [AUTHORS.md](./AUTHORS.md)
222 Everyone participating in the _Black_ project, and in particular in the issue tracker,
223 pull requests, and social media activity, is expected to treat other people with respect
224 and more generally to follow the guidelines articulated in the
225 [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
227 At the same time, humor is encouraged. In fact, basic familiarity with Monty Python's
228 Flying Circus is expected. We are not savages.
230 And if you _really_ need to slap somebody, do it with a fish while dancing.