The most common questions and issues users face are aggregated to this FAQ.
:local:
:backlinks: none
Not yet. Black is fundamentally a command line tool. Many integrations are provided, but a Python interface is not one of them. A simple API is being planned though.
Yes, for the most part. Black is strictly about formatting, nothing else. But because Black is still in beta, some edges are still a bit rough. To combat issues, the equivalence of code after formatting is checked with limited special cases where the code is allowed to differ. If issues are found, an error is raised and the file is left untouched.
Quite stable. Black aims to enforce one style and one style only, with some room for pragmatism. However, Black is still in beta so style changes are both planned and still proposed on the issue tracker. See The Black Code Style for more details.
Most likely because it is ignored in .gitignore
or excluded with configuration. See
file collection and discovery
for details.
Because they go against PEP 8. E203 falsely triggers on list slices, and adhering to W503 hinders readability because operators are misaligned. Disable W503 and enable the disabled-by-default counterpart W504. E203 should be disabled while changes are still discussed.
For formatting, yes! Install with the python2
extra
to format Python 2 files too! There are no current plans to drop support, but most
likely it is bound to happen. Sometime. Eventually. In terms of running Black though,
Python 3.6 or newer is required.