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 - Add primer support and test for code piped into black via STDIN (#2315)
13 - Fix failure caused by `fmt: skip` and indentation (#2281)
14 - Account for += assignment when deciding whether to split string (#2312)
15 - Correct max string length calculation when there are string operators (#2292)
16 - Fixed option usage when using the `--code` flag (#2259)
17 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
18 - Added `--required-version` option to require a specific version to be running (#2300)
19 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
21 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
22 - Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
27 - The vim plugin now searches upwards from the directory containing the current buffer
28 instead of the current working directory for pyproject.toml. (#1871)
32 - The vim plugin now reads the correct string normalization option in pyproject.toml
34 - The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
41 - A space is no longer inserted into empty docstrings (#2249)
42 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
43 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
44 `.gitignore` rules like `git` does) (#2225)
45 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
46 - Add extra uvloop install + import support if in python env (#2258)
47 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
48 - Make sure to split lines that start with a string operator (#2286)
49 - Fix regular expression that black uses to identify f-expressions (#2287)
53 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
58 - The official Black action now supports choosing what version to use, and supports the
63 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
65 - Always build binaries with the latest available Python (#2260)
69 - Add discussion of magic comments to FAQ page (#2272)
70 - `--experimental-string-processing` will be enabled by default in the future (#2273)
71 - Fix typos discovered by codespell (#2228)
72 - Fix Vim plugin installation instructions. (#2235)
73 - Add new Frequently Asked Questions page (#2247)
74 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
80 - Refactor `src/black/__init__.py` into many files (#2206)
84 - Replaced all remaining references to the
85 [`master`](https://github.com/psf/black/tree/main) branch with the
86 [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
87 the source code were also made. (#2210)
88 - Sigificantly reorganized the documentation to make much more sense. Check them out by
89 heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
96 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
97 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
98 being called but with no arguments (#2182)
102 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
108 - Fix crash if the user configuration directory is inaccessible. (#2158)
111 [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
112 in which _Black_ may change the AST (#2159)
114 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
115 or on the command line. (#2170)
119 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
125 - Fix crash on docstrings ending with "\\ ". (#2142)
127 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
129 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
130 in the name of the cache file. Without this fix, changes in these flags would not take
131 effect if the cache had already been populated. (#2131)
133 - Don't remove necessary parentheses from assignment expression containing assert /
134 return statements. (#2143)
138 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
144 - Fixed a rare but annoying formatting instability created by the combination of
145 optional trailing commas inserted by `Black` and optional parentheses looking at
146 pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
149 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
150 and adding a padding space when needed to break up """". (#1740)
152 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
154 - `Black` now respects `--skip-string-normalization` when normalizing multiline
155 docstring quotes (#1637)
157 - `Black` no longer removes all empty lines between non-function code and decorators
158 when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
160 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
161 in if/while statements (#1655)
163 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
164 to split lines (#1824)
166 - fixed a crash when PWD=/ on POSIX (#1631)
168 - fixed "I/O operation on closed file" when using --diff (#1664)
170 - Prevent coloured diff output being interleaved with multiple files (#1673)
172 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
174 - Added parsing support for unparenthesized tuples and yield expressions in annotated
177 - added `--extend-exclude` argument (PR #2005)
179 - speed up caching by avoiding pathlib (#1950)
181 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
183 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
186 - Lines ending with `fmt: skip` will now be not formatted (#1800)
188 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
190 - PR #2053: Python 2 support is now optional, install with
191 `python3 -m pip install black[python2]` to maintain support.
193 - Exclude `venv` directory by default (#1683)
195 - Fixed "Black produced code that is not equivalent to the source" when formatting
196 Python 2 docstrings (#2037)
200 - Self-contained native _Black_ binaries are now provided for releases via GitHub
207 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
214 - re-implemented support for explicit trailing commas: now it works consistently within
215 any bracket pair, including nested structures (#1288 and duplicates)
217 - `Black` now reindents docstrings when reindenting code around it (#1053)
219 - `Black` now shows colored diffs (#1266)
221 - `Black` is now packaged using 'py3' tagged wheels (#1388)
223 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
226 - `Black` no longer normalizes capital R-string prefixes as those have a
227 community-accepted meaning (#1244)
229 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
231 - `Black` now works on AWS Lambda (#1141)
233 - added `--force-exclude` argument (#1032)
235 - removed deprecated `--py36` option (#1236)
237 - fixed `--diff` output when EOF is encountered (#526)
239 - fixed `# fmt: off` handling around decorators (#560)
241 - fixed unstable formatting with some `# type: ignore` comments (#1113)
243 - fixed invalid removal on organizing brackets followed by indexing (#1575)
245 - introduced `black-primer`, a CI tool that allows us to run regression tests against
246 existing open source users of Black (#1402)
248 - introduced property-based fuzzing to our test suite based on Hypothesis and
249 Hypothersmith (#1566)
251 - implemented experimental and disabled by default long string rewrapping (#1132),
252 hidden under a `--experimental-string-processing` flag while it's being worked on;
253 this is an undocumented and unsupported feature, you lose Internet points for
254 depending on it (#1609)
258 - prefer virtualenv packages over global packages (#1383)
262 - added support for PEP 572 assignment expressions (#711)
264 - added support for PEP 570 positional-only arguments (#943)
266 - added support for async generators (#593)
268 - added support for pre-splitting collections by putting an explicit trailing comma
271 - added `black -c` as a way to format code passed from the command line (#761)
273 - --safe now works with Python 2 code (#840)
275 - fixed grammar selection for Python 2-specific code (#765)
277 - fixed feature detection for trailing commas in function definitions and call sites
280 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
281 code now behave correctly (#1005)
283 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
285 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
287 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
289 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
291 - _Black_ no longer fails on comments in from-imports (#671)
293 - _Black_ no longer fails when the file starts with a backslash (#922)
295 - _Black_ no longer merges regular comments with type comments (#1027)
297 - _Black_ no longer splits long lines that contain type comments (#997)
299 - removed unnecessary parentheses around `yield` expressions (#834)
301 - added parentheses around long tuples in unpacking assignments (#832)
303 - added parentheses around complex powers when they are prefixed by a unary operator
306 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
308 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
311 - if _Black_ puts parenthesis around a single expression, it moves comments to the
312 wrapped expression instead of after the brackets (#872)
314 - `blackd` now returns the version of _Black_ in the response headers (#1013)
316 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
321 - new option `--target-version` to control which Python versions _Black_-formatted code
324 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
326 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
328 - long `del` statements are now split into multiple lines (#698)
330 - type comments are no longer mangled in function signatures
332 - improved performance of formatting deeply nested data structures (#509)
334 - _Black_ now properly formats multiple files in parallel on Windows (#632)
336 - _Black_ now creates cache files atomically which allows it to be used in parallel
337 pipelines (like `xargs -P8`) (#673)
339 - _Black_ now correctly indents comments in files that were previously formatted with
342 - `blackd` now supports CORS (#622)
346 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
348 - numeric literals are normalized to include `_` separators on Python 3.6+ code
350 - added `--skip-numeric-underscore-normalization` to disable the above behavior and
351 leave numeric underscores as they were in the input
353 - code with `_` in numeric literals is recognized as Python 3.6+
355 - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
357 - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
359 - added `blackd`, see
360 [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
363 - adjacent string literals are now correctly split into multiple lines (#463)
365 - trailing comma is now added to single imports that don't fit on a line (#250)
367 - cache is now populated when `--check` is successful for a file which speeds up
368 consecutive checks of properly formatted unmodified files (#448)
370 - whitespace at the beginning of the file is now removed (#399)
372 - fixed mangling [pweave](http://mpastell.com/pweave/) and
373 [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
375 - fixed unstable formatting when unpacking big tuples (#267)
377 - fixed parsing of `__future__` imports with renames (#389)
379 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
381 - fixed formatting of lambda expressions with default arguments (#468)
383 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
385 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
390 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
394 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
396 - `# fmt: off` and `# fmt: on` are now much more dependable:
398 - they now work also within bracket pairs (#329)
400 - they now correctly work across function/class boundaries (#335)
402 - they now work when an indentation block starts with empty lines or misaligned
405 - made Click not fail on invalid environments; note that Click is right but the
406 likelihood we'll need to access non-ASCII file paths when dealing with Python source
409 - fixed improper formatting of f-strings with quotes inside interpolated expressions
412 - fixed unnecessary slowdown when long list literals where found in a file
414 - fixed unnecessary slowdown on AST nodes with very many siblings
416 - fixed cannibalizing backslashes during string normalization
418 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
422 - added `--config` (#65)
424 - added `-h` equivalent to `--help` (#316)
426 - fixed improper unmodified file caching when `-S` was used
428 - fixed extra space in string unpacking (#305)
430 - fixed formatting of empty triple quoted strings (#313)
432 - fixed unnecessary slowdown in comment placement calculation on lines without comments
436 - hotfix: don't output human-facing information on stdout (#299)
438 - hotfix: don't output cake emoji on non-zero return code (#300)
442 - added `--include` and `--exclude` (#270)
444 - added `--skip-string-normalization` (#118)
446 - added `--verbose` (#283)
448 - the header output in `--diff` now actually conforms to the unified diff spec
450 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
452 - fixed unnecessary parentheses when a line contained multiline strings (#232)
454 - fixed stdin handling not working correctly if an old version of Click was used (#276)
456 - _Black_ now preserves line endings when formatting a file in place (#258)
460 - added `--pyi` (#249)
462 - added `--py36` (#249)
464 - Python grammar pickle caches are stored with the formatting caches, making _Black_
465 work in environments where site-packages is not user-writable (#192)
467 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
468 fields) and the first method
470 - fixed invalid code produced when standalone comments were present in a trailer that
471 was omitted from line splitting on a large expression (#237)
473 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
475 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
476 in optional parentheses (#234)
478 - fixed unstable formatting when inline comments were moved around in a trailer that was
479 omitted from line splitting on a large expression (#238)
481 - fixed extra empty line between a class declaration and the first method if no class
482 docstring or fields are present (#219)
484 - fixed extra empty line between a function signature and an inner function or inner
489 - call chains are now formatted according to the
490 [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
492 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
493 exploded like imports when they don't fit in a single line (#152)
495 - slices are now formatted according to PEP 8 (#178)
497 - parentheses are now also managed automatically on the right-hand side of assignments
498 and return statements (#140)
500 - math operators now use their respective priorities for delimiting multiline
503 - optional parentheses are now omitted on expressions that start or end with a bracket
504 and only contain a single operator (#177)
506 - empty parentheses in a class definition are now removed (#145, #180)
508 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
509 only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
512 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
515 - progress when reformatting many files is now reported incrementally
517 - fixed trailers (content with brackets) being unnecessarily exploded into their own
518 lines after a dedented closing bracket (#119)
520 - fixed an invalid trailing comma sometimes left in imports (#185)
522 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
525 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
528 - fixed not splitting long from-imports with only a single name
530 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
531 This fixed non-deterministic formatting if trailing commas where used both in function
532 signatures with stars and function calls with stars but the former would be
533 reformatted to a single line.
535 - fixed crash on dealing with optional parentheses (#193)
537 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
540 - fixed crash when dead symlinks where encountered
544 - don't populate the cache on `--check` (#175)
548 - added a "cache"; files already reformatted that haven't changed on disk won't be
549 reformatted again (#109)
551 - `--check` and `--diff` are no longer mutually exclusive (#149)
553 - generalized star expression handling, including double stars; this fixes
554 multiplication making expressions "unsafe" for trailing commas (#132)
556 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
558 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
560 - fixed comment indentation when a standalone comment closes a block (#16, #32)
562 - fixed standalone comments receiving extra empty lines if immediately preceding a
563 class, def, or decorator (#56, #154)
565 - fixed `--diff` not showing entire path (#130)
567 - fixed parsing of complex expressions after star and double stars in function calls
570 - fixed invalid splitting on comma in lambda arguments (#133)
572 - fixed missing splits of ternary expressions (#141)
576 - fixed parsing of unaligned standalone comments (#99, #112)
578 - fixed placement of dictionary unpacking inside dictionary literals (#111)
580 - Vim plugin now works on Windows, too
582 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
587 - added `--quiet` (#78)
589 - added automatic parentheses management (#4)
591 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
593 - fixed reporting on `--check` with multiple files (#101, #102)
595 - fixed removing backslash escapes from raw strings (#100, #105)
599 - added `--diff` (#87)
601 - add line breaks before all delimiters, except in cases like commas, to better comply
604 - standardize string literals to use double quotes (almost) everywhere (#75)
606 - fixed handling of standalone comments within nested bracketed expressions; _Black_
607 will no longer produce super long lines or put all standalone comments at the end of
610 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
613 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
614 _Black_ to not emit the rest of the file (#95)
616 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
617 a flurry of asyncio-related exceptions
619 - only allow up to two empty lines on module level and only single empty lines within
624 - `# fmt: off` and `# fmt: on` are implemented (#5)
626 - automatic detection of deprecated Python 2 forms of print statements and exec
627 statements in the formatted file (#49)
629 - use proper spaces for complex expressions in default values of typed function
632 - only return exit code 1 when --check is used (#50)
634 - don't remove single trailing commas from square bracket indexing (#59)
636 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
638 - omit extra space in kwarg unpacking if it's the first argument (#46)
640 - omit extra space in
641 [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
646 - don't remove single empty lines outside of bracketed expressions (#19)
648 - added ability to pipe formatting from stdin to stdin (#25)
650 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
652 - even better handling of numpy-style array indexing (#33, again)
656 - changed positioning of binary operators to occur at beginning of lines instead of at
658 [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
661 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
662 formattings (#34, #35)
664 - remove a trailing comma if there is a single argument to a call
666 - if top level functions were separated by a comment, don't put four empty lines after
669 - fixed unstable formatting of newlines with imports
671 - fixed unintentional folding of post scriptum standalone comments into last statement
672 if it was a simple statement (#18, #28)
674 - fixed missing space in numpy-style array indexing (#33)
676 - fixed spurious space after star-based unary expressions (#31)
682 - only put trailing commas in function signatures and calls if it's safe to do so. If
683 the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
684 or `**kwargs` used in the signature or call. (#8)
686 - fixed invalid spacing of dots in relative imports (#6, #13)
688 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
690 - fixed spurious space in parenthesized set expressions (#7)
692 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
694 - fixed spurious space after unary operators when the operand was a complex expression
699 - first published version, Happy 🍰 Day 2018!
703 - date-versioned (see: <https://calver.org/>)