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.
7 - Cell magics are now only processed if they are known Python cell magics. Earlier, all
8 cell magics were tokenized, leading to possible indentation errors e.g. with
10 - Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
11 - Remove dependency on `regex` (#2644) (#2663)
12 - Fix `match` statements with open sequence subjects, like `match a, b:` or
13 `match a, *b:` (#2639) (#2659)
14 - Fix `match`/`case` statements that contain `match`/`case` soft keywords multiple
15 times, like `match re.match()` (#2661)
16 - Fix `case` statements with an inline body (#2665)
17 - Fix styling of starred expressions inside `match` subject (#2667)
18 - Fix assignment to environment variables in Jupyter Notebooks (#2642)
19 - Add `flake8-simplify` and `flake8-comprehensions` plugins (#2653)
20 - Fix determination of f-string expression spans (#2654)
21 - Fix parser error location on invalid syntax in a `match` statement (#2649)
22 - Fix bad formatting of error messages about EOF in multi-line statements (#2343)
23 - Functions and classes in blocks now have more consistent surrounding spacing (#2472)
29 - Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
35 - Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
37 - Add experimental PyPy support (#2559)
38 - Add partial support for the match statement. As it's experimental, it's only enabled
39 when `--target-version py310` is explicitly specified (#2586)
40 - Add support for parenthesized with (#2586)
41 - Declare support for Python 3.10 for running Black (#2562)
45 - Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
46 - The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (#2613)
52 - Document stability policy, that will apply for non-beta releases (#2529)
53 - Add new `--workers` parameter (#2514)
54 - Fixed feature detection for positional-only arguments in lambdas (#2532)
55 - Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
56 - Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
57 even though it has been removed (#2580)
58 - Deprecate Python 2 formatting support (#2523)
62 - Remove dependency on aiohttp-cors (#2500)
63 - Bump required aiohttp version to 3.7.4 (#2509)
67 - Add primer support for --projects (#2555)
68 - Print primer summary after individual failures (#2570)
72 - Allow to pass `target_version` in the vim plugin (#1319)
73 - Install build tools in docker file and use multi-stage build to keep the image size
80 - Fix missing modules in self-contained binaries (#2466)
81 - Fix missing toml extra used during installation (#2475)
87 - Add support for formatting Jupyter Notebook files (#2357)
88 - Move from `appdirs` dependency to `platformdirs` (#2375)
89 - Present a more user-friendly error if .gitignore is invalid (#2414)
90 - The failsafe for accidentally added backslashes in f-string expressions has been
91 hardened to handle more edge cases during quote normalization (#2437)
92 - Avoid changing a function return type annotation's type to a tuple by adding a
93 trailing comma (#2384)
94 - Parsing support has been added for unparenthesized walruses in set literals, set
95 comprehensions, and indices (#2447).
96 - Pin `setuptools-scm` build-time dependency version (#2457)
97 - Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10
102 - Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that
103 scan installed packages (#2440)
107 - The provided pre-commit hooks no longer specify `language_version` to avoid overriding
108 `default_language_version` (#2430)
114 - Configuration files using TOML features higher than spec v0.5.0 are now supported
116 - Add primer support and test for code piped into black via STDIN (#2315)
117 - Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (#2332)
118 - Accept empty stdin (#2346)
119 - Provide a more useful error when parsing fails during AST safety checks (#2304)
123 - Add new `latest_release` tag automation to follow latest black release on docker
128 - The vim plugin now searches upwards from the directory containing the current buffer
129 instead of the current working directory for pyproject.toml. (#1871)
130 - The vim plugin now reads the correct string normalization option in pyproject.toml
132 - The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
139 - Fix failure caused by `fmt: skip` and indentation (#2281)
140 - Account for += assignment when deciding whether to split string (#2312)
141 - Correct max string length calculation when there are string operators (#2292)
142 - Fixed option usage when using the `--code` flag (#2259)
143 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
144 - Added `--required-version` option to require a specific version to be running (#2300)
145 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
147 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
148 - Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
153 - The official Black action now supports choosing what version to use, and supports the
154 major 3 OSes. (#1940)
160 - A space is no longer inserted into empty docstrings (#2249)
161 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
162 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
163 `.gitignore` rules like `git` does) (#2225)
164 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
165 - Add extra uvloop install + import support if in python env (#2258)
166 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
167 - Make sure to split lines that start with a string operator (#2286)
168 - Fix regular expression that black uses to identify f-expressions (#2287)
172 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
177 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
179 - Always build binaries with the latest available Python (#2260)
183 - Add discussion of magic comments to FAQ page (#2272)
184 - `--experimental-string-processing` will be enabled by default in the future (#2273)
185 - Fix typos discovered by codespell (#2228)
186 - Fix Vim plugin installation instructions. (#2235)
187 - Add new Frequently Asked Questions page (#2247)
188 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
194 - Refactor `src/black/__init__.py` into many files (#2206)
198 - Replaced all remaining references to the
199 [`master`](https://github.com/psf/black/tree/main) branch with the
200 [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
201 the source code were also made. (#2210)
202 - Sigificantly reorganized the documentation to make much more sense. Check them out by
203 heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
210 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
211 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
212 being called but with no arguments (#2182)
216 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
222 - Fix crash if the user configuration directory is inaccessible. (#2158)
225 [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
226 in which _Black_ may change the AST (#2159)
228 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
229 or on the command line. (#2170)
233 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
239 - Fix crash on docstrings ending with "\\ ". (#2142)
241 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
243 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
244 in the name of the cache file. Without this fix, changes in these flags would not take
245 effect if the cache had already been populated. (#2131)
247 - Don't remove necessary parentheses from assignment expression containing assert /
248 return statements. (#2143)
252 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
258 - Fixed a rare but annoying formatting instability created by the combination of
259 optional trailing commas inserted by `Black` and optional parentheses looking at
260 pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
263 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
264 and adding a padding space when needed to break up """". (#1740)
266 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
268 - `Black` now respects `--skip-string-normalization` when normalizing multiline
269 docstring quotes (#1637)
271 - `Black` no longer removes all empty lines between non-function code and decorators
272 when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
274 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
275 in if/while statements (#1655)
277 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
278 to split lines (#1824)
280 - fixed a crash when PWD=/ on POSIX (#1631)
282 - fixed "I/O operation on closed file" when using --diff (#1664)
284 - Prevent coloured diff output being interleaved with multiple files (#1673)
286 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
288 - Added parsing support for unparenthesized tuples and yield expressions in annotated
291 - added `--extend-exclude` argument (PR #2005)
293 - speed up caching by avoiding pathlib (#1950)
295 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
297 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
300 - Lines ending with `fmt: skip` will now be not formatted (#1800)
302 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
304 - PR #2053: Python 2 support is now optional, install with
305 `python3 -m pip install black[python2]` to maintain support.
307 - Exclude `venv` directory by default (#1683)
309 - Fixed "Black produced code that is not equivalent to the source" when formatting
310 Python 2 docstrings (#2037)
314 - Self-contained native _Black_ binaries are now provided for releases via GitHub
321 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
328 - re-implemented support for explicit trailing commas: now it works consistently within
329 any bracket pair, including nested structures (#1288 and duplicates)
331 - `Black` now reindents docstrings when reindenting code around it (#1053)
333 - `Black` now shows colored diffs (#1266)
335 - `Black` is now packaged using 'py3' tagged wheels (#1388)
337 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
340 - `Black` no longer normalizes capital R-string prefixes as those have a
341 community-accepted meaning (#1244)
343 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
345 - `Black` now works on AWS Lambda (#1141)
347 - added `--force-exclude` argument (#1032)
349 - removed deprecated `--py36` option (#1236)
351 - fixed `--diff` output when EOF is encountered (#526)
353 - fixed `# fmt: off` handling around decorators (#560)
355 - fixed unstable formatting with some `# type: ignore` comments (#1113)
357 - fixed invalid removal on organizing brackets followed by indexing (#1575)
359 - introduced `black-primer`, a CI tool that allows us to run regression tests against
360 existing open source users of Black (#1402)
362 - introduced property-based fuzzing to our test suite based on Hypothesis and
363 Hypothersmith (#1566)
365 - implemented experimental and disabled by default long string rewrapping (#1132),
366 hidden under a `--experimental-string-processing` flag while it's being worked on;
367 this is an undocumented and unsupported feature, you lose Internet points for
368 depending on it (#1609)
372 - prefer virtualenv packages over global packages (#1383)
376 - added support for PEP 572 assignment expressions (#711)
378 - added support for PEP 570 positional-only arguments (#943)
380 - added support for async generators (#593)
382 - added support for pre-splitting collections by putting an explicit trailing comma
385 - added `black -c` as a way to format code passed from the command line (#761)
387 - --safe now works with Python 2 code (#840)
389 - fixed grammar selection for Python 2-specific code (#765)
391 - fixed feature detection for trailing commas in function definitions and call sites
394 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
395 code now behave correctly (#1005)
397 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
399 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
401 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
403 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
405 - _Black_ no longer fails on comments in from-imports (#671)
407 - _Black_ no longer fails when the file starts with a backslash (#922)
409 - _Black_ no longer merges regular comments with type comments (#1027)
411 - _Black_ no longer splits long lines that contain type comments (#997)
413 - removed unnecessary parentheses around `yield` expressions (#834)
415 - added parentheses around long tuples in unpacking assignments (#832)
417 - added parentheses around complex powers when they are prefixed by a unary operator
420 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
422 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
425 - if _Black_ puts parenthesis around a single expression, it moves comments to the
426 wrapped expression instead of after the brackets (#872)
428 - `blackd` now returns the version of _Black_ in the response headers (#1013)
430 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
435 - new option `--target-version` to control which Python versions _Black_-formatted code
438 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
440 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
442 - long `del` statements are now split into multiple lines (#698)
444 - type comments are no longer mangled in function signatures
446 - improved performance of formatting deeply nested data structures (#509)
448 - _Black_ now properly formats multiple files in parallel on Windows (#632)
450 - _Black_ now creates cache files atomically which allows it to be used in parallel
451 pipelines (like `xargs -P8`) (#673)
453 - _Black_ now correctly indents comments in files that were previously formatted with
456 - `blackd` now supports CORS (#622)
460 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
462 - numeric literals are normalized to include `_` separators on Python 3.6+ code
464 - added `--skip-numeric-underscore-normalization` to disable the above behavior and
465 leave numeric underscores as they were in the input
467 - code with `_` in numeric literals is recognized as Python 3.6+
469 - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
471 - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
473 - added `blackd`, see
474 [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
477 - adjacent string literals are now correctly split into multiple lines (#463)
479 - trailing comma is now added to single imports that don't fit on a line (#250)
481 - cache is now populated when `--check` is successful for a file which speeds up
482 consecutive checks of properly formatted unmodified files (#448)
484 - whitespace at the beginning of the file is now removed (#399)
486 - fixed mangling [pweave](http://mpastell.com/pweave/) and
487 [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
489 - fixed unstable formatting when unpacking big tuples (#267)
491 - fixed parsing of `__future__` imports with renames (#389)
493 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
495 - fixed formatting of lambda expressions with default arguments (#468)
497 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
499 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
504 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
508 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
510 - `# fmt: off` and `# fmt: on` are now much more dependable:
512 - they now work also within bracket pairs (#329)
514 - they now correctly work across function/class boundaries (#335)
516 - they now work when an indentation block starts with empty lines or misaligned
519 - made Click not fail on invalid environments; note that Click is right but the
520 likelihood we'll need to access non-ASCII file paths when dealing with Python source
523 - fixed improper formatting of f-strings with quotes inside interpolated expressions
526 - fixed unnecessary slowdown when long list literals where found in a file
528 - fixed unnecessary slowdown on AST nodes with very many siblings
530 - fixed cannibalizing backslashes during string normalization
532 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
536 - added `--config` (#65)
538 - added `-h` equivalent to `--help` (#316)
540 - fixed improper unmodified file caching when `-S` was used
542 - fixed extra space in string unpacking (#305)
544 - fixed formatting of empty triple quoted strings (#313)
546 - fixed unnecessary slowdown in comment placement calculation on lines without comments
550 - hotfix: don't output human-facing information on stdout (#299)
552 - hotfix: don't output cake emoji on non-zero return code (#300)
556 - added `--include` and `--exclude` (#270)
558 - added `--skip-string-normalization` (#118)
560 - added `--verbose` (#283)
562 - the header output in `--diff` now actually conforms to the unified diff spec
564 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
566 - fixed unnecessary parentheses when a line contained multiline strings (#232)
568 - fixed stdin handling not working correctly if an old version of Click was used (#276)
570 - _Black_ now preserves line endings when formatting a file in place (#258)
574 - added `--pyi` (#249)
576 - added `--py36` (#249)
578 - Python grammar pickle caches are stored with the formatting caches, making _Black_
579 work in environments where site-packages is not user-writable (#192)
581 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
582 fields) and the first method
584 - fixed invalid code produced when standalone comments were present in a trailer that
585 was omitted from line splitting on a large expression (#237)
587 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
589 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
590 in optional parentheses (#234)
592 - fixed unstable formatting when inline comments were moved around in a trailer that was
593 omitted from line splitting on a large expression (#238)
595 - fixed extra empty line between a class declaration and the first method if no class
596 docstring or fields are present (#219)
598 - fixed extra empty line between a function signature and an inner function or inner
603 - call chains are now formatted according to the
604 [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
606 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
607 exploded like imports when they don't fit in a single line (#152)
609 - slices are now formatted according to PEP 8 (#178)
611 - parentheses are now also managed automatically on the right-hand side of assignments
612 and return statements (#140)
614 - math operators now use their respective priorities for delimiting multiline
617 - optional parentheses are now omitted on expressions that start or end with a bracket
618 and only contain a single operator (#177)
620 - empty parentheses in a class definition are now removed (#145, #180)
622 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
623 only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
626 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
629 - progress when reformatting many files is now reported incrementally
631 - fixed trailers (content with brackets) being unnecessarily exploded into their own
632 lines after a dedented closing bracket (#119)
634 - fixed an invalid trailing comma sometimes left in imports (#185)
636 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
639 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
642 - fixed not splitting long from-imports with only a single name
644 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
645 This fixed non-deterministic formatting if trailing commas where used both in function
646 signatures with stars and function calls with stars but the former would be
647 reformatted to a single line.
649 - fixed crash on dealing with optional parentheses (#193)
651 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
654 - fixed crash when dead symlinks where encountered
658 - don't populate the cache on `--check` (#175)
662 - added a "cache"; files already reformatted that haven't changed on disk won't be
663 reformatted again (#109)
665 - `--check` and `--diff` are no longer mutually exclusive (#149)
667 - generalized star expression handling, including double stars; this fixes
668 multiplication making expressions "unsafe" for trailing commas (#132)
670 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
672 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
674 - fixed comment indentation when a standalone comment closes a block (#16, #32)
676 - fixed standalone comments receiving extra empty lines if immediately preceding a
677 class, def, or decorator (#56, #154)
679 - fixed `--diff` not showing entire path (#130)
681 - fixed parsing of complex expressions after star and double stars in function calls
684 - fixed invalid splitting on comma in lambda arguments (#133)
686 - fixed missing splits of ternary expressions (#141)
690 - fixed parsing of unaligned standalone comments (#99, #112)
692 - fixed placement of dictionary unpacking inside dictionary literals (#111)
694 - Vim plugin now works on Windows, too
696 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
701 - added `--quiet` (#78)
703 - added automatic parentheses management (#4)
705 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
707 - fixed reporting on `--check` with multiple files (#101, #102)
709 - fixed removing backslash escapes from raw strings (#100, #105)
713 - added `--diff` (#87)
715 - add line breaks before all delimiters, except in cases like commas, to better comply
718 - standardize string literals to use double quotes (almost) everywhere (#75)
720 - fixed handling of standalone comments within nested bracketed expressions; _Black_
721 will no longer produce super long lines or put all standalone comments at the end of
724 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
727 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
728 _Black_ to not emit the rest of the file (#95)
730 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
731 a flurry of asyncio-related exceptions
733 - only allow up to two empty lines on module level and only single empty lines within
738 - `# fmt: off` and `# fmt: on` are implemented (#5)
740 - automatic detection of deprecated Python 2 forms of print statements and exec
741 statements in the formatted file (#49)
743 - use proper spaces for complex expressions in default values of typed function
746 - only return exit code 1 when --check is used (#50)
748 - don't remove single trailing commas from square bracket indexing (#59)
750 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
752 - omit extra space in kwarg unpacking if it's the first argument (#46)
754 - omit extra space in
755 [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
760 - don't remove single empty lines outside of bracketed expressions (#19)
762 - added ability to pipe formatting from stdin to stdin (#25)
764 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
766 - even better handling of numpy-style array indexing (#33, again)
770 - changed positioning of binary operators to occur at beginning of lines instead of at
772 [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
775 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
776 formattings (#34, #35)
778 - remove a trailing comma if there is a single argument to a call
780 - if top level functions were separated by a comment, don't put four empty lines after
783 - fixed unstable formatting of newlines with imports
785 - fixed unintentional folding of post scriptum standalone comments into last statement
786 if it was a simple statement (#18, #28)
788 - fixed missing space in numpy-style array indexing (#33)
790 - fixed spurious space after star-based unary expressions (#31)
796 - only put trailing commas in function signatures and calls if it's safe to do so. If
797 the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
798 or `**kwargs` used in the signature or call. (#8)
800 - fixed invalid spacing of dots in relative imports (#6, #13)
802 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
804 - fixed spurious space in parenthesized set expressions (#7)
806 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
808 - fixed spurious space after unary operators when the operand was a complex expression
813 - first published version, Happy 🍰 Day 2018!
817 - date-versioned (see: <https://calver.org/>)