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 parser error location on invalid syntax in a `match` statement (#2649)
24 - Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
30 - Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
32 - Add experimental PyPy support (#2559)
33 - Add partial support for the match statement. As it's experimental, it's only enabled
34 when `--target-version py310` is explicitly specified (#2586)
35 - Add support for parenthesized with (#2586)
36 - Declare support for Python 3.10 for running Black (#2562)
40 - Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
41 - The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (#2613)
47 - Document stability policy, that will apply for non-beta releases (#2529)
48 - Add new `--workers` parameter (#2514)
49 - Fixed feature detection for positional-only arguments in lambdas (#2532)
50 - Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
51 - Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
52 even though it has been removed (#2580)
53 - Deprecate Python 2 formatting support (#2523)
57 - Remove dependency on aiohttp-cors (#2500)
58 - Bump required aiohttp version to 3.7.4 (#2509)
62 - Add primer support for --projects (#2555)
63 - Print primer summary after individual failures (#2570)
67 - Allow to pass `target_version` in the vim plugin (#1319)
68 - Install build tools in docker file and use multi-stage build to keep the image size
75 - Fix missing modules in self-contained binaries (#2466)
76 - Fix missing toml extra used during installation (#2475)
82 - Add support for formatting Jupyter Notebook files (#2357)
83 - Move from `appdirs` dependency to `platformdirs` (#2375)
84 - Present a more user-friendly error if .gitignore is invalid (#2414)
85 - The failsafe for accidentally added backslashes in f-string expressions has been
86 hardened to handle more edge cases during quote normalization (#2437)
87 - Avoid changing a function return type annotation's type to a tuple by adding a
88 trailing comma (#2384)
89 - Parsing support has been added for unparenthesized walruses in set literals, set
90 comprehensions, and indices (#2447).
91 - Pin `setuptools-scm` build-time dependency version (#2457)
92 - Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10
97 - Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that
98 scan installed packages (#2440)
102 - The provided pre-commit hooks no longer specify `language_version` to avoid overriding
103 `default_language_version` (#2430)
109 - Configuration files using TOML features higher than spec v0.5.0 are now supported
111 - Add primer support and test for code piped into black via STDIN (#2315)
112 - Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (#2332)
113 - Accept empty stdin (#2346)
114 - Provide a more useful error when parsing fails during AST safety checks (#2304)
118 - Add new `latest_release` tag automation to follow latest black release on docker
123 - The vim plugin now searches upwards from the directory containing the current buffer
124 instead of the current working directory for pyproject.toml. (#1871)
125 - The vim plugin now reads the correct string normalization option in pyproject.toml
127 - The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
134 - Fix failure caused by `fmt: skip` and indentation (#2281)
135 - Account for += assignment when deciding whether to split string (#2312)
136 - Correct max string length calculation when there are string operators (#2292)
137 - Fixed option usage when using the `--code` flag (#2259)
138 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
139 - Added `--required-version` option to require a specific version to be running (#2300)
140 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
142 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
143 - Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
148 - The official Black action now supports choosing what version to use, and supports the
149 major 3 OSes. (#1940)
155 - A space is no longer inserted into empty docstrings (#2249)
156 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
157 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
158 `.gitignore` rules like `git` does) (#2225)
159 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
160 - Add extra uvloop install + import support if in python env (#2258)
161 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
162 - Make sure to split lines that start with a string operator (#2286)
163 - Fix regular expression that black uses to identify f-expressions (#2287)
167 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
172 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
174 - Always build binaries with the latest available Python (#2260)
178 - Add discussion of magic comments to FAQ page (#2272)
179 - `--experimental-string-processing` will be enabled by default in the future (#2273)
180 - Fix typos discovered by codespell (#2228)
181 - Fix Vim plugin installation instructions. (#2235)
182 - Add new Frequently Asked Questions page (#2247)
183 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
189 - Refactor `src/black/__init__.py` into many files (#2206)
193 - Replaced all remaining references to the
194 [`master`](https://github.com/psf/black/tree/main) branch with the
195 [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
196 the source code were also made. (#2210)
197 - Sigificantly reorganized the documentation to make much more sense. Check them out by
198 heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
205 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
206 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
207 being called but with no arguments (#2182)
211 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
217 - Fix crash if the user configuration directory is inaccessible. (#2158)
220 [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
221 in which _Black_ may change the AST (#2159)
223 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
224 or on the command line. (#2170)
228 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
234 - Fix crash on docstrings ending with "\\ ". (#2142)
236 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
238 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
239 in the name of the cache file. Without this fix, changes in these flags would not take
240 effect if the cache had already been populated. (#2131)
242 - Don't remove necessary parentheses from assignment expression containing assert /
243 return statements. (#2143)
247 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
253 - Fixed a rare but annoying formatting instability created by the combination of
254 optional trailing commas inserted by `Black` and optional parentheses looking at
255 pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
258 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
259 and adding a padding space when needed to break up """". (#1740)
261 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
263 - `Black` now respects `--skip-string-normalization` when normalizing multiline
264 docstring quotes (#1637)
266 - `Black` no longer removes all empty lines between non-function code and decorators
267 when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
269 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
270 in if/while statements (#1655)
272 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
273 to split lines (#1824)
275 - fixed a crash when PWD=/ on POSIX (#1631)
277 - fixed "I/O operation on closed file" when using --diff (#1664)
279 - Prevent coloured diff output being interleaved with multiple files (#1673)
281 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
283 - Added parsing support for unparenthesized tuples and yield expressions in annotated
286 - added `--extend-exclude` argument (PR #2005)
288 - speed up caching by avoiding pathlib (#1950)
290 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
292 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
295 - Lines ending with `fmt: skip` will now be not formatted (#1800)
297 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
299 - PR #2053: Python 2 support is now optional, install with
300 `python3 -m pip install black[python2]` to maintain support.
302 - Exclude `venv` directory by default (#1683)
304 - Fixed "Black produced code that is not equivalent to the source" when formatting
305 Python 2 docstrings (#2037)
309 - Self-contained native _Black_ binaries are now provided for releases via GitHub
316 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
323 - re-implemented support for explicit trailing commas: now it works consistently within
324 any bracket pair, including nested structures (#1288 and duplicates)
326 - `Black` now reindents docstrings when reindenting code around it (#1053)
328 - `Black` now shows colored diffs (#1266)
330 - `Black` is now packaged using 'py3' tagged wheels (#1388)
332 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
335 - `Black` no longer normalizes capital R-string prefixes as those have a
336 community-accepted meaning (#1244)
338 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
340 - `Black` now works on AWS Lambda (#1141)
342 - added `--force-exclude` argument (#1032)
344 - removed deprecated `--py36` option (#1236)
346 - fixed `--diff` output when EOF is encountered (#526)
348 - fixed `# fmt: off` handling around decorators (#560)
350 - fixed unstable formatting with some `# type: ignore` comments (#1113)
352 - fixed invalid removal on organizing brackets followed by indexing (#1575)
354 - introduced `black-primer`, a CI tool that allows us to run regression tests against
355 existing open source users of Black (#1402)
357 - introduced property-based fuzzing to our test suite based on Hypothesis and
358 Hypothersmith (#1566)
360 - implemented experimental and disabled by default long string rewrapping (#1132),
361 hidden under a `--experimental-string-processing` flag while it's being worked on;
362 this is an undocumented and unsupported feature, you lose Internet points for
363 depending on it (#1609)
367 - prefer virtualenv packages over global packages (#1383)
371 - added support for PEP 572 assignment expressions (#711)
373 - added support for PEP 570 positional-only arguments (#943)
375 - added support for async generators (#593)
377 - added support for pre-splitting collections by putting an explicit trailing comma
380 - added `black -c` as a way to format code passed from the command line (#761)
382 - --safe now works with Python 2 code (#840)
384 - fixed grammar selection for Python 2-specific code (#765)
386 - fixed feature detection for trailing commas in function definitions and call sites
389 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
390 code now behave correctly (#1005)
392 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
394 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
396 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
398 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
400 - _Black_ no longer fails on comments in from-imports (#671)
402 - _Black_ no longer fails when the file starts with a backslash (#922)
404 - _Black_ no longer merges regular comments with type comments (#1027)
406 - _Black_ no longer splits long lines that contain type comments (#997)
408 - removed unnecessary parentheses around `yield` expressions (#834)
410 - added parentheses around long tuples in unpacking assignments (#832)
412 - added parentheses around complex powers when they are prefixed by a unary operator
415 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
417 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
420 - if _Black_ puts parenthesis around a single expression, it moves comments to the
421 wrapped expression instead of after the brackets (#872)
423 - `blackd` now returns the version of _Black_ in the response headers (#1013)
425 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
430 - new option `--target-version` to control which Python versions _Black_-formatted code
433 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
435 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
437 - long `del` statements are now split into multiple lines (#698)
439 - type comments are no longer mangled in function signatures
441 - improved performance of formatting deeply nested data structures (#509)
443 - _Black_ now properly formats multiple files in parallel on Windows (#632)
445 - _Black_ now creates cache files atomically which allows it to be used in parallel
446 pipelines (like `xargs -P8`) (#673)
448 - _Black_ now correctly indents comments in files that were previously formatted with
451 - `blackd` now supports CORS (#622)
455 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
457 - numeric literals are normalized to include `_` separators on Python 3.6+ code
459 - added `--skip-numeric-underscore-normalization` to disable the above behavior and
460 leave numeric underscores as they were in the input
462 - code with `_` in numeric literals is recognized as Python 3.6+
464 - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
466 - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
468 - added `blackd`, see
469 [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
472 - adjacent string literals are now correctly split into multiple lines (#463)
474 - trailing comma is now added to single imports that don't fit on a line (#250)
476 - cache is now populated when `--check` is successful for a file which speeds up
477 consecutive checks of properly formatted unmodified files (#448)
479 - whitespace at the beginning of the file is now removed (#399)
481 - fixed mangling [pweave](http://mpastell.com/pweave/) and
482 [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
484 - fixed unstable formatting when unpacking big tuples (#267)
486 - fixed parsing of `__future__` imports with renames (#389)
488 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
490 - fixed formatting of lambda expressions with default arguments (#468)
492 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
494 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
499 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
503 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
505 - `# fmt: off` and `# fmt: on` are now much more dependable:
507 - they now work also within bracket pairs (#329)
509 - they now correctly work across function/class boundaries (#335)
511 - they now work when an indentation block starts with empty lines or misaligned
514 - made Click not fail on invalid environments; note that Click is right but the
515 likelihood we'll need to access non-ASCII file paths when dealing with Python source
518 - fixed improper formatting of f-strings with quotes inside interpolated expressions
521 - fixed unnecessary slowdown when long list literals where found in a file
523 - fixed unnecessary slowdown on AST nodes with very many siblings
525 - fixed cannibalizing backslashes during string normalization
527 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
531 - added `--config` (#65)
533 - added `-h` equivalent to `--help` (#316)
535 - fixed improper unmodified file caching when `-S` was used
537 - fixed extra space in string unpacking (#305)
539 - fixed formatting of empty triple quoted strings (#313)
541 - fixed unnecessary slowdown in comment placement calculation on lines without comments
545 - hotfix: don't output human-facing information on stdout (#299)
547 - hotfix: don't output cake emoji on non-zero return code (#300)
551 - added `--include` and `--exclude` (#270)
553 - added `--skip-string-normalization` (#118)
555 - added `--verbose` (#283)
557 - the header output in `--diff` now actually conforms to the unified diff spec
559 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
561 - fixed unnecessary parentheses when a line contained multiline strings (#232)
563 - fixed stdin handling not working correctly if an old version of Click was used (#276)
565 - _Black_ now preserves line endings when formatting a file in place (#258)
569 - added `--pyi` (#249)
571 - added `--py36` (#249)
573 - Python grammar pickle caches are stored with the formatting caches, making _Black_
574 work in environments where site-packages is not user-writable (#192)
576 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
577 fields) and the first method
579 - fixed invalid code produced when standalone comments were present in a trailer that
580 was omitted from line splitting on a large expression (#237)
582 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
584 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
585 in optional parentheses (#234)
587 - fixed unstable formatting when inline comments were moved around in a trailer that was
588 omitted from line splitting on a large expression (#238)
590 - fixed extra empty line between a class declaration and the first method if no class
591 docstring or fields are present (#219)
593 - fixed extra empty line between a function signature and an inner function or inner
598 - call chains are now formatted according to the
599 [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
601 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
602 exploded like imports when they don't fit in a single line (#152)
604 - slices are now formatted according to PEP 8 (#178)
606 - parentheses are now also managed automatically on the right-hand side of assignments
607 and return statements (#140)
609 - math operators now use their respective priorities for delimiting multiline
612 - optional parentheses are now omitted on expressions that start or end with a bracket
613 and only contain a single operator (#177)
615 - empty parentheses in a class definition are now removed (#145, #180)
617 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
618 only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
621 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
624 - progress when reformatting many files is now reported incrementally
626 - fixed trailers (content with brackets) being unnecessarily exploded into their own
627 lines after a dedented closing bracket (#119)
629 - fixed an invalid trailing comma sometimes left in imports (#185)
631 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
634 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
637 - fixed not splitting long from-imports with only a single name
639 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
640 This fixed non-deterministic formatting if trailing commas where used both in function
641 signatures with stars and function calls with stars but the former would be
642 reformatted to a single line.
644 - fixed crash on dealing with optional parentheses (#193)
646 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
649 - fixed crash when dead symlinks where encountered
653 - don't populate the cache on `--check` (#175)
657 - added a "cache"; files already reformatted that haven't changed on disk won't be
658 reformatted again (#109)
660 - `--check` and `--diff` are no longer mutually exclusive (#149)
662 - generalized star expression handling, including double stars; this fixes
663 multiplication making expressions "unsafe" for trailing commas (#132)
665 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
667 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
669 - fixed comment indentation when a standalone comment closes a block (#16, #32)
671 - fixed standalone comments receiving extra empty lines if immediately preceding a
672 class, def, or decorator (#56, #154)
674 - fixed `--diff` not showing entire path (#130)
676 - fixed parsing of complex expressions after star and double stars in function calls
679 - fixed invalid splitting on comma in lambda arguments (#133)
681 - fixed missing splits of ternary expressions (#141)
685 - fixed parsing of unaligned standalone comments (#99, #112)
687 - fixed placement of dictionary unpacking inside dictionary literals (#111)
689 - Vim plugin now works on Windows, too
691 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
696 - added `--quiet` (#78)
698 - added automatic parentheses management (#4)
700 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
702 - fixed reporting on `--check` with multiple files (#101, #102)
704 - fixed removing backslash escapes from raw strings (#100, #105)
708 - added `--diff` (#87)
710 - add line breaks before all delimiters, except in cases like commas, to better comply
713 - standardize string literals to use double quotes (almost) everywhere (#75)
715 - fixed handling of standalone comments within nested bracketed expressions; _Black_
716 will no longer produce super long lines or put all standalone comments at the end of
719 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
722 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
723 _Black_ to not emit the rest of the file (#95)
725 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
726 a flurry of asyncio-related exceptions
728 - only allow up to two empty lines on module level and only single empty lines within
733 - `# fmt: off` and `# fmt: on` are implemented (#5)
735 - automatic detection of deprecated Python 2 forms of print statements and exec
736 statements in the formatted file (#49)
738 - use proper spaces for complex expressions in default values of typed function
741 - only return exit code 1 when --check is used (#50)
743 - don't remove single trailing commas from square bracket indexing (#59)
745 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
747 - omit extra space in kwarg unpacking if it's the first argument (#46)
749 - omit extra space in
750 [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
755 - don't remove single empty lines outside of bracketed expressions (#19)
757 - added ability to pipe formatting from stdin to stdin (#25)
759 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
761 - even better handling of numpy-style array indexing (#33, again)
765 - changed positioning of binary operators to occur at beginning of lines instead of at
767 [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
770 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
771 formattings (#34, #35)
773 - remove a trailing comma if there is a single argument to a call
775 - if top level functions were separated by a comment, don't put four empty lines after
778 - fixed unstable formatting of newlines with imports
780 - fixed unintentional folding of post scriptum standalone comments into last statement
781 if it was a simple statement (#18, #28)
783 - fixed missing space in numpy-style array indexing (#33)
785 - fixed spurious space after star-based unary expressions (#31)
791 - only put trailing commas in function signatures and calls if it's safe to do so. If
792 the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
793 or `**kwargs` used in the signature or call. (#8)
795 - fixed invalid spacing of dots in relative imports (#6, #13)
797 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
799 - fixed spurious space in parenthesized set expressions (#7)
801 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
803 - fixed spurious space after unary operators when the operand was a complex expression
808 - first published version, Happy 🍰 Day 2018!
812 - date-versioned (see: <https://calver.org/>)