4 Summary: The uncompromising code formatter.
5 Project-URL: Changelog, https://github.com/psf/black/blob/main/CHANGES.md
6 Project-URL: Homepage, https://github.com/psf/black
7 Author-email: Łukasz Langa <lukasz@langa.pl>
9 License-File: AUTHORS.md
11 Keywords: automation,autopep8,formatter,gofmt,pyfmt,rustfmt,yapf
12 Classifier: Development Status :: 5 - Production/Stable
13 Classifier: Environment :: Console
14 Classifier: Intended Audience :: Developers
15 Classifier: License :: OSI Approved :: MIT License
16 Classifier: Operating System :: OS Independent
17 Classifier: Programming Language :: Python
18 Classifier: Programming Language :: Python :: 3 :: Only
19 Classifier: Programming Language :: Python :: 3.8
20 Classifier: Programming Language :: Python :: 3.9
21 Classifier: Programming Language :: Python :: 3.10
22 Classifier: Programming Language :: Python :: 3.11
23 Classifier: Programming Language :: Python :: 3.12
24 Classifier: Topic :: Software Development :: Libraries :: Python Modules
25 Classifier: Topic :: Software Development :: Quality Assurance
26 Requires-Python: >=3.8
27 Requires-Dist: click>=8.0.0
28 Requires-Dist: mypy-extensions>=0.4.3
29 Requires-Dist: packaging>=22.0
30 Requires-Dist: pathspec>=0.9.0
31 Requires-Dist: platformdirs>=2
32 Requires-Dist: tomli>=1.1.0; python_version < '3.11'
33 Requires-Dist: typing-extensions>=4.0.1; python_version < '3.11'
34 Provides-Extra: colorama
35 Requires-Dist: colorama>=0.4.3; extra == 'colorama'
37 Requires-Dist: aiohttp>=3.7.4; extra == 'd'
38 Provides-Extra: jupyter
39 Requires-Dist: ipython>=7.8.0; extra == 'jupyter'
40 Requires-Dist: tokenize-rt>=3.2.0; extra == 'jupyter'
41 Provides-Extra: uvloop
42 Requires-Dist: uvloop>=0.15.2; extra == 'uvloop'
43 Description-Content-Type: text/markdown
45 [![Black Logo](https://raw.githubusercontent.com/psf/black/main/docs/_static/logo2-readme.png)](https://black.readthedocs.io/en/stable/)
47 <h2 align="center">The Uncompromising Code Formatter</h2>
50 <a href="https://github.com/psf/black/actions"><img alt="Actions Status" src="https://github.com/psf/black/workflows/Test/badge.svg"></a>
51 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
52 <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>
53 <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>
54 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://img.shields.io/pypi/v/black"></a>
55 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://static.pepy.tech/badge/black"></a>
56 <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>
57 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
60 > “Any color you like.”
62 _Black_ is the uncompromising Python code formatter. By using it, you agree to cede
63 control over minutiae of hand-formatting. In return, _Black_ gives you speed,
64 determinism, and freedom from `pycodestyle` nagging about formatting. You will save time
65 and mental energy for more important matters.
67 Blackened code looks the same regardless of the project you're reading. Formatting
68 becomes transparent after a while and you can focus on the content instead.
70 _Black_ makes code review faster by producing the smallest diffs possible.
72 Try it out now using the [Black Playground](https://black.vercel.app). Watch the
73 [PyCon 2019 talk](https://youtu.be/esZLCuWs_2Y) to learn more.
77 **[Read the documentation on ReadTheDocs!](https://black.readthedocs.io/en/stable)**
81 ## Installation and usage
85 _Black_ can be installed by running `pip install black`. It requires Python 3.7+ to run.
86 If you want to format Jupyter Notebooks, install with `pip install "black[jupyter]"`.
88 If you can't wait for the latest _hotness_ and want to install from GitHub, use:
90 `pip install git+https://github.com/psf/black`
94 To get started right away with sensible defaults:
97 black {source_file_or_directory}
100 You can run _Black_ as a package if running it as a script doesn't work:
103 python -m black {source_file_or_directory}
106 Further information can be found in our docs:
108 - [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html)
110 _Black_ is already [successfully used](https://github.com/psf/black#used-by) by many
111 projects, small and big. _Black_ has a comprehensive test suite, with efficient parallel
112 tests, and our own auto formatting and parallel Continuous Integration runner. Now that
113 we have become stable, you should not expect large formatting changes in the future.
114 Stylistic changes will mostly be responses to bug reports and support for new Python
115 syntax. For more information please refer to the
116 [The Black Code Style](https://black.readthedocs.io/en/stable/the_black_code_style/index.html).
118 Also, as a safety measure which slows down processing, _Black_ will check that the
119 reformatted code still produces a valid AST that is effectively equivalent to the
121 [Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#ast-before-and-after-formatting)
122 section for details). If you're feeling confident, use `--fast`.
124 ## The _Black_ code style
126 _Black_ is a PEP 8 compliant opinionated formatter. _Black_ reformats entire files in
127 place. Style configuration options are deliberately limited and rarely added. It doesn't
128 take previous formatting into account (see
129 [Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#pragmatism)
132 Our documentation covers the current _Black_ code style, but planned changes to it are
133 also documented. They're both worth taking a look:
135 - [The _Black_ Code Style: Current style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
136 - [The _Black_ Code Style: Future style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html)
138 Changes to the _Black_ code style are bound by the Stability Policy:
140 - [The _Black_ Code Style: Stability Policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy)
142 Please refer to this document before submitting an issue. What seems like a bug might be
147 Early versions of _Black_ used to be absolutist in some respects. They took after its
148 initial author. This was fine at the time as it made the implementation simpler and
149 there were not many users anyway. Not many edge cases were reported. As a mature tool,
150 _Black_ does make some exceptions to rules it otherwise holds.
152 - [The _Black_ code style: Pragmatism](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#pragmatism)
154 Please refer to this document before submitting an issue just like with the document
155 above. What seems like a bug might be intended behaviour.
159 _Black_ is able to read project-specific default values for its command line options
160 from a `pyproject.toml` file. This is especially useful for specifying custom
161 `--include` and `--exclude`/`--force-exclude`/`--extend-exclude` patterns for your
164 You can find more details in our documentation:
166 - [The basics: Configuration via a file](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file)
168 And if you're looking for more general configuration documentation:
170 - [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html)
172 **Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
173 "No". _Black_ is all about sensible defaults. Applying those defaults will have your
174 code in compliance with many other _Black_ formatted projects.
178 The following notable open-source projects trust _Black_ with enforcing a consistent
179 code style: pytest, tox, Pyramid, Django, Django Channels, Hypothesis, attrs,
180 SQLAlchemy, Poetry, PyPA applications (Warehouse, Bandersnatch, Pipenv, virtualenv),
181 pandas, Pillow, Twisted, LocalStack, every Datadog Agent Integration, Home Assistant,
182 Zulip, Kedro, OpenOA, FLORIS, ORBIT, WOMBAT, and many more.
184 The following organizations use _Black_: Facebook, Dropbox, KeepTruckin, Lyft, Mozilla,
185 Quora, Duolingo, QuantumBlack, Tesla, Archer Aviation.
187 Are we missing anyone? Let us know.
191 **Mike Bayer**, [author of `SQLAlchemy`](https://www.sqlalchemy.org/):
193 > I can't think of any single tool in my entire programming career that has given me a
194 > bigger productivity increase by its introduction. I can now do refactorings in about
195 > 1% of the keystrokes that it would have taken me previously when we had no way for
196 > code to format itself.
199 [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
201 > _Black_ is opinionated so you don't have to be.
203 **Hynek Schlawack**, [creator of `attrs`](https://www.attrs.org/), core developer of
206 > An auto-formatter that doesn't suck is all I want for Xmas!
208 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
210 > At least the name is good.
212 **Kenneth Reitz**, creator of [`requests`](https://requests.readthedocs.io/en/latest/)
213 and [`pipenv`](https://readthedocs.org/projects/pipenv/):
215 > This vastly improves the formatting of our code. Thanks a ton!
219 Use the badge in your project's README.md:
222 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
225 Using the badge in README.rst:
228 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
229 :target: https://github.com/psf/black
233 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
241 Welcome! Happy to see you willing to make the project better. You can get started by
244 - [Contributing: The basics](https://black.readthedocs.io/en/latest/contributing/the_basics.html)
246 You can also take a look at the rest of the contributing docs or talk with the
249 - [Contributing documentation](https://black.readthedocs.io/en/latest/contributing/index.html)
250 - [Chat on Discord](https://discord.gg/RtVdv86PrH)
254 The log has become rather long. It moved to its own file.
256 See [CHANGES](https://black.readthedocs.io/en/latest/change_log.html).
260 The author list is quite long nowadays, so it lives in its own file.
262 See [AUTHORS.md](./AUTHORS.md)
266 Everyone participating in the _Black_ project, and in particular in the issue tracker,
267 pull requests, and social media activity, is expected to treat other people with respect
268 and more generally to follow the guidelines articulated in the
269 [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
271 At the same time, humor is encouraged. In fact, basic familiarity with Monty Python's
272 Flying Circus is expected. We are not savages.
274 And if you _really_ need to slap somebody, do it with a fish while dancing.
281 <!-- Include any especially major or disruptive changes here -->
285 <!-- Changes that affect Black's stable style -->
289 <!-- Changes that affect Black's preview style -->
293 <!-- Changes to how Black can be configured -->
297 <!-- Changes to how Black is packaged, such as dependency requirements -->
301 <!-- Changes to the parser or to version autodetection -->
305 <!-- Changes that improve Black's performance. -->
309 <!-- Changes to Black's terminal output and error messages -->
313 <!-- Changes to blackd -->
317 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
321 <!-- Major changes to documentation and policies. Small docs changes
322 don't need a changelog entry. -->
326 Due to various issues, the previous release (23.9.0) did not include compiled mypyc
327 wheels, which make Black significantly faster. These issues have now been fixed, and
328 this release should come with compiled wheels once again.
330 There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12
331 wheels in a future release as soon as the mypyc bug is fixed.
335 - Upgrade to mypy 1.5.1 (#3864)
339 - Store raw tuples instead of NamedTuples in Black's cache, improving performance and
340 decreasing the size of the cache (#3877)
346 - More concise formatting for dummy implementations (#3796)
347 - In stub files, add a blank line between a statement with a body (e.g an
348 `if sys.version_info > (3, x):`) and a function definition on the same level (#3862)
349 - Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
353 - Black now applies exclusion and ignore logic before resolving symlinks (#3846)
357 - Avoid importing `IPython` if notebook cells do not contain magics (#3782)
358 - Improve caching by comparing file hashes as fallback for mtime and size (#3821)
362 - Fix an issue in `blackd` with single character input (#3558)
367 [official pre-commit mirror](https://github.com/psf/black-pre-commit-mirror). Swapping
368 `https://github.com/psf/black` to `https://github.com/psf/black-pre-commit-mirror` in
369 your `.pre-commit-config.yaml` will make Black about 2x faster (#3828)
370 - The `.black.env` folder specified by `ENV_PATH` will now be removed on the completion
371 of the GitHub Action (#3759)
377 - Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
378 supported until further notice (#3765)
382 - Fix a bug where an illegal trailing comma was added to return type annotations using
383 PEP 604 unions (#3735)
384 - Fix several bugs and crashes where comments in stub files were removed or mishandled
385 under some circumstances (#3745)
386 - Fix a crash with multi-line magic comments like `type: ignore` within parentheses
388 - Fix error in AST validation when _Black_ removes trailing whitespace in a type comment
393 - Implicitly concatenated strings used as function args are no longer wrapped inside
395 - Remove blank lines between a class definition and its docstring (#3692)
399 - The `--workers` argument to _Black_ can now be specified via the `BLACK_NUM_WORKERS`
400 environment variable (#3743)
401 - `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (#3691)
402 - Fix _Black_ not honouring `pyproject.toml` settings when running `--stdin-filename`
403 and the `pyproject.toml` found isn't in the current working directory (#3719)
404 - _Black_ will now error if `exclude` and `extend-exclude` have invalid data types in
405 `pyproject.toml`, instead of silently doing the wrong thing (#3764)
409 - Upgrade mypyc from 0.991 to 1.3 (#3697)
410 - Remove patching of Click that mitigated errors on Python 3.6 with `LANG=C` (#3768)
414 - Add support for the new PEP 695 syntax in Python 3.12 (#3703)
418 - Speed up _Black_ significantly when the cache is full (#3751)
419 - Avoid importing `IPython` in a case where we wouldn't need it (#3748)
423 - Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728)
424 - Change verbose logging to exactly mirror _Black_'s logic for source discovery (#3749)
428 - The `blackd` argument parser now shows the default values for options in their help
433 - Black is now tested with
434 [`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning)
436 - Update GitHub Action to display black output in the job summary (#3688)
440 - Add a CITATION.cff file to the root of the repository, containing metadata on how to
441 cite this software (#3723)
442 - Update the _classes_ and _exceptions_ documentation in Developer reference to match
443 the latest code base (#3755)
449 This release fixes a longstanding confusing behavior in Black's GitHub action, where the
450 version of the action did not determine the version of Black being run (issue #3382). In
451 addition, there is a small bug fix around imports and a number of improvements to the
455 [preview style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html#preview-style)
456 with `black --preview` and tell us your feedback. All changes in the preview style are
457 expected to become part of Black's stable style in January 2024.
461 - Import lines with `# fmt: skip` and `# fmt: off` no longer have an extra blank line
462 added when they are right after another import line (#3610)
466 - Add trailing commas to collection literals even if there's a comment after the last
468 - `async def`, `async for`, and `async with` statements are now formatted consistently
469 compared to their non-async version. (#3609)
470 - `with` statements that contain two context managers will be consistently wrapped in
472 - Let string splitters respect [East Asian Width](https://www.unicode.org/reports/tr11/)
474 - Now long string literals can be split after East Asian commas and periods (`、` U+3001
475 IDEOGRAPHIC COMMA, `。` U+3002 IDEOGRAPHIC FULL STOP, & `,` U+FF0C FULLWIDTH COMMA)
476 besides before spaces (#3445)
477 - For stubs, enforce one blank line after a nested class with a body other than just
479 - Improve handling of multiline strings by changing line split behavior (#1879)
483 - Added support for formatting files with invalid type comments (#3594)
487 - Update GitHub Action to use the version of Black equivalent to action's version if
488 version input is not specified (#3543)
489 - Fix missing Python binary path in autoload script for vim (#3508)
493 - Document that only the most recent release is supported for security issues;
494 vulnerabilities should be reported through Tidelift (#3612)
500 This is the first release of 2023, and following our
501 [stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy),
502 it comes with a number of improvements to our stable style, including improvements to
503 empty line handling, removal of redundant parentheses in several contexts, and output
504 that highlights implicitly concatenated strings better.
506 There are also many changes to the preview style; try out `black --preview` and give us
507 feedback to help us set the stable style for next year.
509 In addition to style changes, Black now automatically infers the supported Python
510 versions from your `pyproject.toml` file, removing the need to set Black's target
515 <!-- Changes that affect Black's stable style -->
517 - Introduce the 2023 stable style, which incorporates most aspects of last year's
518 preview style (#3418). Specific changes:
519 - Enforce empty lines before classes and functions with sticky leading comments
521 - Reformat empty and whitespace-only files as either an empty file (if no newline is
522 present) or as a single newline character (if a newline is present) (#3348)
524 - Implicitly concatenated strings used as function args are now wrapped inside
525 parentheses (#3307) (22.12.0)
526 - Correctly handle trailing commas that are inside a line's leading non-nested parens
528 - `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
529 normalized as expected (#3168) (since 22.8.0)
530 - When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
531 subscript expressions with more than 1 element (#3209) (22.8.0)
532 - Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
533 parentheses (#3162) (22.8.0)
534 - Fix a string merging/split issue when a comment is present in the middle of
535 implicitly concatenated strings on its own line (#3227) (22.8.0)
536 - Docstring quotes are no longer moved if it would violate the line length limit
537 (#3044, #3430) (22.6.0)
538 - Parentheses around return annotations are now managed (#2990) (22.6.0)
539 - Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
540 - Remove unnecessary parentheses in `with` statements (#2926) (22.6.0)
541 - Remove trailing newlines after code block open (#3035) (22.6.0)
542 - Code cell separators `#%%` are now standardised to `# %%` (#2919) (22.3.0)
543 - Remove unnecessary parentheses from `except` statements (#2939) (22.3.0)
544 - Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945) (22.3.0)
545 - Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
546 - Fix a crash when a colon line is marked between `# fmt: off` and `# fmt: on` (#3439)
550 <!-- Changes that affect Black's preview style -->
552 - Format hex codes in unicode escape sequences in string literals (#2916)
553 - Add parentheses around `if`-`else` expressions (#2278)
554 - Improve performance on large expressions that contain many strings (#3467)
555 - Fix a crash in preview style with assert + parenthesized string (#3415)
556 - Fix crashes in preview style with walrus operators used in function return annotations
557 and except clauses (#3423)
558 - Fix a crash in preview advanced string processing where mixed implicitly concatenated
559 regular and f-strings start with an empty span (#3463)
560 - Fix a crash in preview advanced string processing where a standalone comment is placed
561 before a dict's value (#3469)
562 - Fix an issue where extra empty lines are added when a decorator has `# fmt: skip`
563 applied or there is a standalone comment between decorators (#3470)
564 - Do not put the closing quotes in a docstring on a separate line, even if the line is
566 - Long values in dict literals are now wrapped in parentheses; correspondingly
567 unnecessary parentheses around short values in dict literals are now removed; long
568 string lambda values are now wrapped in parentheses (#3440)
569 - Fix two crashes in preview style involving edge cases with docstrings (#3451)
570 - Exclude string type annotations from improved string processing; fix crash when the
571 return type annotation is stringified and spans across multiple lines (#3462)
572 - Wrap multiple context managers in parentheses when targeting Python 3.9+ (#3489)
573 - Fix several crashes in preview style with walrus operators used in `with` statements
575 - Fix an invalid quote escaping bug in f-string expressions where it produced invalid
576 code. Implicitly concatenated f-strings with different quotes can now be merged or
577 quote-normalized by changing the quotes used in expressions. (#3509)
578 - Fix crash on `await (yield)` when Black is compiled with mypyc (#3533)
582 <!-- Changes to how Black can be configured -->
584 - Black now tries to infer its `--target-version` from the project metadata specified in
585 `pyproject.toml` (#3219)
589 <!-- Changes to how Black is packaged, such as dependency requirements -->
591 - Upgrade mypyc from `0.971` to `0.991` so mypycified _Black_ can be built on armv7
593 - This also fixes some crashes while using compiled Black with a debug build of
595 - Drop specific support for the `tomli` requirement on 3.11 alpha releases, working
596 around a bug that would cause the requirement not to be installed on any non-final
597 Python releases (#3448)
598 - Black now depends on `packaging` version `22.0` or later. This is required for new
599 functionality that needs to parse part of the project metadata (#3219)
603 <!-- Changes to Black's terminal output and error messages -->
605 - Calling `black --help` multiple times will return the same help contents each time
607 - Verbose logging now shows the values of `pyproject.toml` configuration variables
609 - Fix false symlink detection messages in verbose output due to using an incorrect
610 relative path to the project root (#3385)
614 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
616 - Move 3.11 CI to normal flow now that all dependencies support 3.11 (#3446)
617 - Docker: Add new `latest_prerelease` tag automation to follow latest black alpha
618 release on docker images (#3465)
622 <!-- Major changes to documentation and policies. Small docs changes
623 don't need a changelog entry. -->
625 - Expand `vim-plug` installation instructions to offer more explicit options (#3468)
631 <!-- Changes that affect Black's preview style -->
633 - Enforce empty lines before classes and functions with sticky leading comments (#3302)
634 - Reformat empty and whitespace-only files as either an empty file (if no newline is
635 present) or as a single newline character (if a newline is present) (#3348)
636 - Implicitly concatenated strings used as function args are now wrapped inside
638 - For assignment statements, prefer splitting the right hand side if the left hand side
639 fits on a single line (#3368)
640 - Correctly handle trailing commas that are inside a line's leading non-nested parens
645 <!-- Changes to how Black can be configured -->
647 - Fix incorrectly applied `.gitignore` rules by considering the `.gitignore` location
648 and the relative path to the target file (#3338)
649 - Fix incorrectly ignoring `.gitignore` presence when more than one source directory is
654 <!-- Changes to the parser or to version autodetection -->
656 - Parsing support has been added for walruses inside generator expression that are
657 passed as function args (for example,
658 `any(match := my_re.match(text) for text in texts)`) (#3327).
662 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
664 - Vim plugin: Optionally allow using the system installation of Black via
665 `let g:black_use_virtualenv = 0`(#3309)
671 - Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
672 supported until further notice.
676 - Fix a crash when `# fmt: on` is used on a different block level than `# fmt: off`
681 - Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
686 - `.ipynb_checkpoints` directories are now excluded by default (#3293)
687 - Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
688 while formatting (#3299)
692 - Executables made with PyInstaller will no longer crash when formatting several files
693 at once on macOS. Native x86-64 executables for macOS are available once again.
695 - Hatchling is now used as the build backend. This will not have any effect for users
696 who install Black with its wheels from PyPI. (#3233)
697 - Faster compiled wheels are now available for CPython 3.11 (#3276)
701 - Windows style (CRLF) newlines will be preserved (#3257).
705 - Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (#3246)
706 - Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
708 - Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
715 - Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as
716 of publishing (#3234)
717 - This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6
718 code will continue to be supported until further notice)
719 - Reword the stability policy to say that we may, in rare cases, make changes that
720 affect code that was not previously formatted by _Black_ (#3155)
724 - Fix an infinite loop when using `# fmt: on/off` in the middle of an expression or code
726 - Fix incorrect handling of `# fmt: skip` on colon (`:`) lines (#3148)
727 - Comments are no longer deleted when a line had spaces removed around power operators
732 - Single-character closing docstring quotes are no longer moved to their own line as
733 this is invalid. This was a bug introduced in version 22.6.0. (#3166)
734 - `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
735 normalized as expected (#3168)
736 - When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
737 subscript expressions with more than 1 element (#3209)
738 - Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
740 - Fix a string merging/split issue when a comment is present in the middle of implicitly
741 concatenated strings on its own line (#3227)
745 - `blackd` now supports enabling the preview style via the `X-Preview` header (#3217)
749 - Black now uses the presence of debug f-strings to detect target version (#3215)
750 - Fix misdetection of project root and verbose logging of sources in cases involving
751 `--stdin-filename` (#3216)
752 - Immediate `.gitignore` files in source directories given on the command line are now
753 also respected, previously only `.gitignore` files in the project root and
754 automatically discovered directories were respected (#3237)
758 - Recommend using BlackConnect in IntelliJ IDEs (#3150)
762 - Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
763 - Docker: changed to a /opt/venv installation + added to PATH to be available to
764 non-root users (#3202)
768 - Change from deprecated `asyncio.get_event_loop()` to create our event loop which
769 removes DeprecationWarning (#3164)
770 - Remove logging from internal `blib2to3` library since it regularly emits error logs
771 about failed caching that can and should be ignored (#3193)
775 - Type comments are now included in the AST equivalence check consistently so accidental
776 deletion raises an error. Though type comments can't be tracked when running on PyPy
777 3.7 due to standard library limitations. (#2874)
781 - Reduce Black's startup time when formatting a single file by 15-30% (#3211)
787 - Fix unstable formatting involving `#fmt: skip` and `# fmt:skip` comments (notice the
788 lack of spaces) (#2970)
792 - Docstring quotes are no longer moved if it would violate the line length limit (#3044)
793 - Parentheses around return annotations are now managed (#2990)
794 - Remove unnecessary parentheses around awaited objects (#2991)
795 - Remove unnecessary parentheses in `with` statements (#2926)
796 - Remove trailing newlines after code block open (#3035)
800 - Add `scripts/migrate-black.py` script to ease introduction of Black to a Git project
805 - Output Python version and implementation as part of `--version` flag (#2997)
809 - Use `tomli` instead of `tomllib` on Python 3.11 builds where `tomllib` is not
814 - [PEP 654](https://peps.python.org/pep-0654/#except) syntax (for example,
815 `except *ExceptionGroup:`) is now supported (#3016)
816 - [PEP 646](https://peps.python.org/pep-0646) syntax (for example,
817 `Array[Batch, *Shape]` or `def fn(*args: *T) -> None`) is now supported (#3071)
821 - Fix `strtobool` function. It didn't parse true/on/false/off. (#3025)
827 - Code cell separators `#%%` are now standardised to `# %%` (#2919)
828 - Remove unnecessary parentheses from `except` statements (#2939)
829 - Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945)
830 - Avoid magic-trailing-comma in single-element subscripts (#2942)
834 - Do not format `__pypackages__` directories by default (#2836)
835 - Add support for specifying stable version with `--required-version` (#2832).
836 - Avoid crashing when the user has no homedir (#2814)
837 - Avoid crashing when md5 is not available (#2905)
838 - Fix handling of directory junctions on Windows (#2904)
842 - Update pylint config documentation (#2931)
846 - Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
850 - In verbose mode, log when _Black_ is using user-level config (#2861)
854 - Fix Black to work with Click 8.1.0 (#2966)
855 - On Python 3.11 and newer, use the standard library's `tomllib` instead of `tomli`
857 - `black-primer`, the deprecated internal devtool, has been removed and copied to a
858 [separate repository](https://github.com/cooperlees/black-primer) (#2924)
862 - Black can now parse starred expressions in the target of `for` and `async for`
863 statements, e.g `for item in *items_1, *items_2: pass` (#2879).
867 At long last, _Black_ is no longer a beta product! This is the first non-beta release
868 and the first release covered by our new
869 [stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy).
873 - **Remove Python 2 support** (#2740)
874 - Introduce the `--preview` flag (#2752)
878 - Deprecate `--experimental-string-processing` and move the functionality under
880 - For stubs, one blank line between class attributes and methods is now kept if there's
881 at least one pre-existing blank line (#2736)
882 - Black now normalizes string prefix order (#2297)
883 - Remove spaces around power operators if both operands are simple (#2726)
884 - Work around bug that causes unstable formatting in some cases in the presence of the
885 magic trailing comma (#2807)
886 - Use parentheses for attribute access on decimal float and int literals (#2799)
887 - Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex
889 - Treat blank lines in stubs the same inside top-level `if` statements (#2820)
890 - Fix unstable formatting with semicolons and arithmetic expressions (#2817)
891 - Fix unstable formatting around magic trailing comma (#2572)
895 - Fix mapping cases that contain as-expressions, like `case {"key": 1 | 2 as password}`
897 - Fix cases that contain multiple top-level as-expressions, like `case 1 as a, 2 as b`
899 - Fix call patterns that contain as-expressions with keyword arguments, like
900 `case Foo(bar=baz as quux)` (#2749)
901 - Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (#2700)
902 - Unparenthesized tuples on annotated assignments (e.g
903 `values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (#2708)
904 - Fix handling of standalone `match()` or `case()` when there is a trailing newline or a
905 comment inside of the parentheses. (#2760)
906 - `from __future__ import annotations` statement now implies Python 3.7+ (#2690)
910 - Speed-up the new backtracking parser about 4X in general (enabled when
911 `--target-version` is set to 3.10 and higher). (#2728)
912 - _Black_ is now compiled with [mypyc](https://github.com/mypyc/mypyc) for an overall 2x
913 speed-up. 64-bit Windows, MacOS, and Linux (not including musl) are supported. (#1009,
918 - Do not accept bare carriage return line endings in pyproject.toml (#2408)
919 - Add configuration option (`python-cell-magics`) to format cells with custom magics in
920 Jupyter Notebooks (#2744)
921 - Allow setting custom cache directory on all platforms with environment variable
922 `BLACK_CACHE_DIR` (#2739).
923 - Enable Python 3.10+ by default, without any extra need to specify
924 `--target-version=py310`. (#2758)
925 - Make passing `SRC` or `--code` mandatory and mutually exclusive (#2804)
929 - Improve error message for invalid regular expression (#2678)
930 - Improve error message when parsing fails during AST safety check by embedding the
931 underlying SyntaxError (#2693)
932 - No longer color diff headers white as it's unreadable in light themed terminals
934 - Text coloring added in the final statistics (#2712)
935 - Verbose mode also now describes how a project root was discovered and which paths will
936 be formatted. (#2526)
940 - All upper version bounds on dependencies have been removed (#2718)
941 - `typing-extensions` is no longer a required dependency in Python 3.10+ (#2772)
942 - Set `click` lower bound to `8.0.0` (#2791)
946 - Update GitHub action to support containerized runs (#2748)
950 - Change protocol in pip installation instructions to `https://` (#2761)
951 - Change HTML theme to Furo primarily for its responsive design and mobile support
953 - Deprecate the `black-primer` tool (#2809)
954 - Document Python support policy (#2819)
960 - Fix determination of f-string expression spans (#2654)
961 - Fix bad formatting of error messages about EOF in multi-line statements (#2343)
962 - Functions and classes in blocks now have more consistent surrounding spacing (#2472)
964 #### Jupyter Notebook support
966 - Cell magics are now only processed if they are known Python cell magics. Earlier, all
967 cell magics were tokenized, leading to possible indentation errors e.g. with
968 `%%writefile`. (#2630)
969 - Fix assignment to environment variables in Jupyter Notebooks (#2642)
971 #### Python 3.10 support
973 - Point users to using `--target-version py310` if we detect 3.10-only syntax (#2668)
974 - Fix `match` statements with open sequence subjects, like `match a, b:` or
975 `match a, *b:` (#2639) (#2659)
976 - Fix `match`/`case` statements that contain `match`/`case` soft keywords multiple
977 times, like `match re.match()` (#2661)
978 - Fix `case` statements with an inline body (#2665)
979 - Fix styling of starred expressions inside `match` subject (#2667)
980 - Fix parser error location on invalid syntax in a `match` statement (#2649)
981 - Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
982 - Improve parsing performance on code that uses `match` under `--target-version py310`
987 - Remove dependency on `regex` (#2644) (#2663)
993 - Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
999 - Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
1001 - Add experimental PyPy support (#2559)
1002 - Add partial support for the match statement. As it's experimental, it's only enabled
1003 when `--target-version py310` is explicitly specified (#2586)
1004 - Add support for parenthesized with (#2586)
1005 - Declare support for Python 3.10 for running Black (#2562)
1009 - Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
1010 - The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (#2613)
1016 - Document stability policy, that will apply for non-beta releases (#2529)
1017 - Add new `--workers` parameter (#2514)
1018 - Fixed feature detection for positional-only arguments in lambdas (#2532)
1019 - Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
1020 - Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
1021 even though it has been removed (#2580)
1022 - Deprecate Python 2 formatting support (#2523)
1026 - Remove dependency on aiohttp-cors (#2500)
1027 - Bump required aiohttp version to 3.7.4 (#2509)
1031 - Add primer support for --projects (#2555)
1032 - Print primer summary after individual failures (#2570)
1036 - Allow to pass `target_version` in the vim plugin (#1319)
1037 - Install build tools in docker file and use multi-stage build to keep the image size
1044 - Fix missing modules in self-contained binaries (#2466)
1045 - Fix missing toml extra used during installation (#2475)
1051 - Add support for formatting Jupyter Notebook files (#2357)
1052 - Move from `appdirs` dependency to `platformdirs` (#2375)
1053 - Present a more user-friendly error if .gitignore is invalid (#2414)
1054 - The failsafe for accidentally added backslashes in f-string expressions has been
1055 hardened to handle more edge cases during quote normalization (#2437)
1056 - Avoid changing a function return type annotation's type to a tuple by adding a
1057 trailing comma (#2384)
1058 - Parsing support has been added for unparenthesized walruses in set literals, set
1059 comprehensions, and indices (#2447).
1060 - Pin `setuptools-scm` build-time dependency version (#2457)
1061 - Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10
1066 - Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that
1067 scan installed packages (#2440)
1071 - The provided pre-commit hooks no longer specify `language_version` to avoid overriding
1072 `default_language_version` (#2430)
1078 - Configuration files using TOML features higher than spec v0.5.0 are now supported
1080 - Add primer support and test for code piped into black via STDIN (#2315)
1081 - Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (#2332)
1082 - Accept empty stdin (#2346)
1083 - Provide a more useful error when parsing fails during AST safety checks (#2304)
1087 - Add new `latest_release` tag automation to follow latest black release on docker
1092 - The vim plugin now searches upwards from the directory containing the current buffer
1093 instead of the current working directory for pyproject.toml. (#1871)
1094 - The vim plugin now reads the correct string normalization option in pyproject.toml
1096 - The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
1103 - Fix failure caused by `fmt: skip` and indentation (#2281)
1104 - Account for += assignment when deciding whether to split string (#2312)
1105 - Correct max string length calculation when there are string operators (#2292)
1106 - Fixed option usage when using the `--code` flag (#2259)
1107 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
1108 - Added `--required-version` option to require a specific version to be running (#2300)
1109 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
1111 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
1112 - Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
1117 - The official Black action now supports choosing what version to use, and supports the
1118 major 3 OSes. (#1940)
1124 - A space is no longer inserted into empty docstrings (#2249)
1125 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
1126 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
1127 `.gitignore` rules like `git` does) (#2225)
1128 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
1129 - Add extra uvloop install + import support if in python env (#2258)
1130 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
1131 - Make sure to split lines that start with a string operator (#2286)
1132 - Fix regular expression that black uses to identify f-expressions (#2287)
1136 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
1141 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
1143 - Always build binaries with the latest available Python (#2260)
1147 - Add discussion of magic comments to FAQ page (#2272)
1148 - `--experimental-string-processing` will be enabled by default in the future (#2273)
1149 - Fix typos discovered by codespell (#2228)
1150 - Fix Vim plugin installation instructions. (#2235)
1151 - Add new Frequently Asked Questions page (#2247)
1152 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
1158 - Refactor `src/black/__init__.py` into many files (#2206)
1162 - Replaced all remaining references to the
1163 [`master`](https://github.com/psf/black/tree/main) branch with the
1164 [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
1165 the source code were also made. (#2210)
1166 - Sigificantly reorganized the documentation to make much more sense. Check them out by
1167 heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
1174 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
1175 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
1176 being called but with no arguments (#2182)
1180 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
1186 - Fix crash if the user configuration directory is inaccessible. (#2158)
1189 [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
1190 in which _Black_ may change the AST (#2159)
1192 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
1193 or on the command line. (#2170)
1197 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
1203 - Fix crash on docstrings ending with "\\ ". (#2142)
1205 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
1207 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
1208 in the name of the cache file. Without this fix, changes in these flags would not take
1209 effect if the cache had already been populated. (#2131)
1211 - Don't remove necessary parentheses from assignment expression containing assert /
1212 return statements. (#2143)
1216 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
1222 - Fixed a rare but annoying formatting instability created by the combination of
1223 optional trailing commas inserted by `Black` and optional parentheses looking at
1224 pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
1227 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
1228 and adding a padding space when needed to break up """". (#1740)
1230 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
1232 - `Black` now respects `--skip-string-normalization` when normalizing multiline
1233 docstring quotes (#1637)
1235 - `Black` no longer removes all empty lines between non-function code and decorators
1236 when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
1238 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
1239 in if/while statements (#1655)
1241 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
1242 to split lines (#1824)
1244 - fixed a crash when PWD=/ on POSIX (#1631)
1246 - fixed "I/O operation on closed file" when using --diff (#1664)
1248 - Prevent coloured diff output being interleaved with multiple files (#1673)
1250 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
1252 - Added parsing support for unparenthesized tuples and yield expressions in annotated
1255 - added `--extend-exclude` argument (PR #2005)
1257 - speed up caching by avoiding pathlib (#1950)
1259 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
1261 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
1264 - Lines ending with `fmt: skip` will now be not formatted (#1800)
1266 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
1268 - PR #2053: Python 2 support is now optional, install with
1269 `python3 -m pip install black[python2]` to maintain support.
1271 - Exclude `venv` directory by default (#1683)
1273 - Fixed "Black produced code that is not equivalent to the source" when formatting
1274 Python 2 docstrings (#2037)
1278 - Self-contained native _Black_ binaries are now provided for releases via GitHub
1285 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
1292 - re-implemented support for explicit trailing commas: now it works consistently within
1293 any bracket pair, including nested structures (#1288 and duplicates)
1295 - `Black` now reindents docstrings when reindenting code around it (#1053)
1297 - `Black` now shows colored diffs (#1266)
1299 - `Black` is now packaged using 'py3' tagged wheels (#1388)
1301 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
1304 - `Black` no longer normalizes capital R-string prefixes as those have a
1305 community-accepted meaning (#1244)
1307 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
1309 - `Black` now works on AWS Lambda (#1141)
1311 - added `--force-exclude` argument (#1032)
1313 - removed deprecated `--py36` option (#1236)
1315 - fixed `--diff` output when EOF is encountered (#526)
1317 - fixed `# fmt: off` handling around decorators (#560)
1319 - fixed unstable formatting with some `# type: ignore` comments (#1113)
1321 - fixed invalid removal on organizing brackets followed by indexing (#1575)
1323 - introduced `black-primer`, a CI tool that allows us to run regression tests against
1324 existing open source users of Black (#1402)
1326 - introduced property-based fuzzing to our test suite based on Hypothesis and
1327 Hypothersmith (#1566)
1329 - implemented experimental and disabled by default long string rewrapping (#1132),
1330 hidden under a `--experimental-string-processing` flag while it's being worked on;
1331 this is an undocumented and unsupported feature, you lose Internet points for
1332 depending on it (#1609)
1336 - prefer virtualenv packages over global packages (#1383)
1340 - added support for PEP 572 assignment expressions (#711)
1342 - added support for PEP 570 positional-only arguments (#943)
1344 - added support for async generators (#593)
1346 - added support for pre-splitting collections by putting an explicit trailing comma
1349 - added `black -c` as a way to format code passed from the command line (#761)
1351 - --safe now works with Python 2 code (#840)
1353 - fixed grammar selection for Python 2-specific code (#765)
1355 - fixed feature detection for trailing commas in function definitions and call sites
1358 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
1359 code now behave correctly (#1005)
1361 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
1363 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
1365 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
1367 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
1369 - _Black_ no longer fails on comments in from-imports (#671)
1371 - _Black_ no longer fails when the file starts with a backslash (#922)
1373 - _Black_ no longer merges regular comments with type comments (#1027)
1375 - _Black_ no longer splits long lines that contain type comments (#997)
1377 - removed unnecessary parentheses around `yield` expressions (#834)
1379 - added parentheses around long tuples in unpacking assignments (#832)
1381 - added parentheses around complex powers when they are prefixed by a unary operator
1384 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
1386 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
1389 - if _Black_ puts parenthesis around a single expression, it moves comments to the
1390 wrapped expression instead of after the brackets (#872)
1392 - `blackd` now returns the version of _Black_ in the response headers (#1013)
1394 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
1399 - new option `--target-version` to control which Python versions _Black_-formatted code
1400 should target (#618)
1402 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
1404 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
1406 - long `del` statements are now split into multiple lines (#698)
1408 - type comments are no longer mangled in function signatures
1410 - improved performance of formatting deeply nested data structures (#509)
1412 - _Black_ now properly formats multiple files in parallel on Windows (#632)
1414 - _Black_ now creates cache files atomically which allows it to be used in parallel
1415 pipelines (like `xargs -P8`) (#673)
1417 - _Black_ now correctly indents comments in files that were previously formatted with
1420 - `blackd` now supports CORS (#622)
1424 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
1426 - numeric literals are normalized to include `_` separators on Python 3.6+ code
1428 - added `--skip-numeric-underscore-normalization` to disable the above behavior and
1429 leave numeric underscores as they were in the input
1431 - code with `_` in numeric literals is recognized as Python 3.6+
1433 - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
1435 - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
1437 - added `blackd`, see
1438 [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
1441 - adjacent string literals are now correctly split into multiple lines (#463)
1443 - trailing comma is now added to single imports that don't fit on a line (#250)
1445 - cache is now populated when `--check` is successful for a file which speeds up
1446 consecutive checks of properly formatted unmodified files (#448)
1448 - whitespace at the beginning of the file is now removed (#399)
1450 - fixed mangling [pweave](http://mpastell.com/pweave/) and
1451 [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
1453 - fixed unstable formatting when unpacking big tuples (#267)
1455 - fixed parsing of `__future__` imports with renames (#389)
1457 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
1459 - fixed formatting of lambda expressions with default arguments (#468)
1461 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
1463 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
1464 be a bad idea (#415)
1468 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
1472 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
1474 - `# fmt: off` and `# fmt: on` are now much more dependable:
1476 - they now work also within bracket pairs (#329)
1478 - they now correctly work across function/class boundaries (#335)
1480 - they now work when an indentation block starts with empty lines or misaligned
1483 - made Click not fail on invalid environments; note that Click is right but the
1484 likelihood we'll need to access non-ASCII file paths when dealing with Python source
1487 - fixed improper formatting of f-strings with quotes inside interpolated expressions
1490 - fixed unnecessary slowdown when long list literals where found in a file
1492 - fixed unnecessary slowdown on AST nodes with very many siblings
1494 - fixed cannibalizing backslashes during string normalization
1496 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
1500 - added `--config` (#65)
1502 - added `-h` equivalent to `--help` (#316)
1504 - fixed improper unmodified file caching when `-S` was used
1506 - fixed extra space in string unpacking (#305)
1508 - fixed formatting of empty triple quoted strings (#313)
1510 - fixed unnecessary slowdown in comment placement calculation on lines without comments
1514 - hotfix: don't output human-facing information on stdout (#299)
1516 - hotfix: don't output cake emoji on non-zero return code (#300)
1520 - added `--include` and `--exclude` (#270)
1522 - added `--skip-string-normalization` (#118)
1524 - added `--verbose` (#283)
1526 - the header output in `--diff` now actually conforms to the unified diff spec
1528 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
1530 - fixed unnecessary parentheses when a line contained multiline strings (#232)
1532 - fixed stdin handling not working correctly if an old version of Click was used (#276)
1534 - _Black_ now preserves line endings when formatting a file in place (#258)
1538 - added `--pyi` (#249)
1540 - added `--py36` (#249)
1542 - Python grammar pickle caches are stored with the formatting caches, making _Black_
1543 work in environments where site-packages is not user-writable (#192)
1545 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
1546 fields) and the first method
1548 - fixed invalid code produced when standalone comments were present in a trailer that
1549 was omitted from line splitting on a large expression (#237)
1551 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
1553 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
1554 in optional parentheses (#234)
1556 - fixed unstable formatting when inline comments were moved around in a trailer that was
1557 omitted from line splitting on a large expression (#238)
1559 - fixed extra empty line between a class declaration and the first method if no class
1560 docstring or fields are present (#219)
1562 - fixed extra empty line between a function signature and an inner function or inner
1567 - call chains are now formatted according to the
1568 [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
1570 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
1571 exploded like imports when they don't fit in a single line (#152)
1573 - slices are now formatted according to PEP 8 (#178)
1575 - parentheses are now also managed automatically on the right-hand side of assignments
1576 and return statements (#140)
1578 - math operators now use their respective priorities for delimiting multiline
1581 - optional parentheses are now omitted on expressions that start or end with a bracket
1582 and only contain a single operator (#177)
1584 - empty parentheses in a class definition are now removed (#145, #180)
1586 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
1587 only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
1590 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
1593 - progress when reformatting many files is now reported incrementally
1595 - fixed trailers (content with brackets) being unnecessarily exploded into their own
1596 lines after a dedented closing bracket (#119)
1598 - fixed an invalid trailing comma sometimes left in imports (#185)
1600 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
1603 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
1606 - fixed not splitting long from-imports with only a single name
1608 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
1609 This fixed non-deterministic formatting if trailing commas where used both in function
1610 signatures with stars and function calls with stars but the former would be
1611 reformatted to a single line.
1613 - fixed crash on dealing with optional parentheses (#193)
1615 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
1618 - fixed crash when dead symlinks where encountered
1622 - don't populate the cache on `--check` (#175)
1626 - added a "cache"; files already reformatted that haven't changed on disk won't be
1627 reformatted again (#109)
1629 - `--check` and `--diff` are no longer mutually exclusive (#149)
1631 - generalized star expression handling, including double stars; this fixes
1632 multiplication making expressions "unsafe" for trailing commas (#132)
1634 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
1636 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
1638 - fixed comment indentation when a standalone comment closes a block (#16, #32)
1640 - fixed standalone comments receiving extra empty lines if immediately preceding a
1641 class, def, or decorator (#56, #154)
1643 - fixed `--diff` not showing entire path (#130)
1645 - fixed parsing of complex expressions after star and double stars in function calls
1648 - fixed invalid splitting on comma in lambda arguments (#133)
1650 - fixed missing splits of ternary expressions (#141)
1654 - fixed parsing of unaligned standalone comments (#99, #112)
1656 - fixed placement of dictionary unpacking inside dictionary literals (#111)
1658 - Vim plugin now works on Windows, too
1660 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
1665 - added `--quiet` (#78)
1667 - added automatic parentheses management (#4)
1669 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
1671 - fixed reporting on `--check` with multiple files (#101, #102)
1673 - fixed removing backslash escapes from raw strings (#100, #105)
1677 - added `--diff` (#87)
1679 - add line breaks before all delimiters, except in cases like commas, to better comply
1682 - standardize string literals to use double quotes (almost) everywhere (#75)
1684 - fixed handling of standalone comments within nested bracketed expressions; _Black_
1685 will no longer produce super long lines or put all standalone comments at the end of
1686 the expression (#22)
1688 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
1691 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
1692 _Black_ to not emit the rest of the file (#95)
1694 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
1695 a flurry of asyncio-related exceptions
1697 - only allow up to two empty lines on module level and only single empty lines within
1702 - `# fmt: off` and `# fmt: on` are implemented (#5)
1704 - automatic detection of deprecated Python 2 forms of print statements and exec
1705 statements in the formatted file (#49)
1707 - use proper spaces for complex expressions in default values of typed function
1710 - only return exit code 1 when --check is used (#50)
1712 - don't remove single trailing commas from square bracket indexing (#59)
1714 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
1716 - omit extra space in kwarg unpacking if it's the first argument (#46)
1718 - omit extra space in
1719 [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
1724 - don't remove single empty lines outside of bracketed expressions (#19)
1726 - added ability to pipe formatting from stdin to stdin (#25)
1728 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
1730 - even better handling of numpy-style array indexing (#33, again)
1734 - changed positioning of binary operators to occur at beginning of lines instead of at
1736 [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
1739 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
1740 formattings (#34, #35)
1742 - remove a trailing comma if there is a single argument to a call
1744 - if top level functions were separated by a comment, don't put four empty lines after
1747 - fixed unstable formatting of newlines with imports
1749 - fixed unintentional folding of post scriptum standalone comments into last statement
1750 if it was a simple statement (#18, #28)
1752 - fixed missing space in numpy-style array indexing (#33)
1754 - fixed spurious space after star-based unary expressions (#31)
1760 - only put trailing commas in function signatures and calls if it's safe to do so. If
1761 the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
1762 or `**kwargs` used in the signature or call. (#8)
1764 - fixed invalid spacing of dots in relative imports (#6, #13)
1766 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
1768 - fixed spurious space in parenthesized set expressions (#7)
1770 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
1772 - fixed spurious space after unary operators when the operand was a complex expression
1777 - first published version, Happy 🍰 Day 2018!
1781 - date-versioned (see: <https://calver.org/>)