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