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 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
8 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
10 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
11 being called but with no arguments (#2182)
17 - Fix crash if the user configuration directory is inaccessible. (#2158)
20 [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
21 in which _Black_ may change the AST (#2159)
25 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
31 - Fix crash on docstrings ending with "\ ". (#2142)
33 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
35 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
36 in the name of the cache file. Without this fix, changes in these flags would not take
37 effect if the cache had already been populated. (#2131)
39 - Don't remove necessary parentheses from assignment expression containing assert /
40 return statements. (#2143)
44 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
50 - Fixed a rare but annoying formatting instability created by the combination of
51 optional trailing commas inserted by `Black` and optional parentheses looking at
52 pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
55 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
56 and adding a padding space when needed to break up """". (#1740)
58 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
60 - `Black` now respects `--skip-string-normalization` when normalizing multiline
61 docstring quotes (#1637)
63 - `Black` no longer removes all empty lines between non-function code and decorators
64 when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
66 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
67 in if/while statements (#1655)
69 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
70 to split lines (#1824)
72 - fixed a crash when PWD=/ on POSIX (#1631)
74 - fixed "I/O operation on closed file" when using --diff (#1664)
76 - Prevent coloured diff output being interleaved with multiple files (#1673)
78 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
80 - Added parsing support for unparenthesized tuples and yield expressions in annotated
83 - added `--extend-exclude` argument (PR #2005)
85 - speed up caching by avoiding pathlib (#1950)
87 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
89 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
92 - Lines ending with `fmt: skip` will now be not formatted (#1800)
94 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
96 - PR #2053: Python 2 support is now optional, install with
97 `python3 -m pip install black[python2]` to maintain support.
99 - Exclude `venv` directory by default (#1683)
101 - Fixed "Black produced code that is not equivalent to the source" when formatting
102 Python 2 docstrings (#2037)
106 - Self-contained native _Black_ binaries are now provided for releases via GitHub
113 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
120 - re-implemented support for explicit trailing commas: now it works consistently within
121 any bracket pair, including nested structures (#1288 and duplicates)
123 - `Black` now reindents docstrings when reindenting code around it (#1053)
125 - `Black` now shows colored diffs (#1266)
127 - `Black` is now packaged using 'py3' tagged wheels (#1388)
129 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
132 - `Black` no longer normalizes capital R-string prefixes as those have a
133 community-accepted meaning (#1244)
135 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
137 - `Black` now works on AWS Lambda (#1141)
139 - added `--force-exclude` argument (#1032)
141 - removed deprecated `--py36` option (#1236)
143 - fixed `--diff` output when EOF is encountered (#526)
145 - fixed `# fmt: off` handling around decorators (#560)
147 - fixed unstable formatting with some `# type: ignore` comments (#1113)
149 - fixed invalid removal on organizing brackets followed by indexing (#1575)
151 - introduced `black-primer`, a CI tool that allows us to run regression tests against
152 existing open source users of Black (#1402)
154 - introduced property-based fuzzing to our test suite based on Hypothesis and
155 Hypothersmith (#1566)
157 - implemented experimental and disabled by default long string rewrapping (#1132),
158 hidden under a `--experimental-string-processing` flag while it's being worked on;
159 this is an undocumented and unsupported feature, you lose Internet points for
160 depending on it (#1609)
164 - prefer virtualenv packages over global packages (#1383)
168 - added support for PEP 572 assignment expressions (#711)
170 - added support for PEP 570 positional-only arguments (#943)
172 - added support for async generators (#593)
174 - added support for pre-splitting collections by putting an explicit trailing comma
177 - added `black -c` as a way to format code passed from the command line (#761)
179 - --safe now works with Python 2 code (#840)
181 - fixed grammar selection for Python 2-specific code (#765)
183 - fixed feature detection for trailing commas in function definitions and call sites
186 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
187 code now behave correctly (#1005)
189 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
191 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
193 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
195 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
197 - _Black_ no longer fails on comments in from-imports (#671)
199 - _Black_ no longer fails when the file starts with a backslash (#922)
201 - _Black_ no longer merges regular comments with type comments (#1027)
203 - _Black_ no longer splits long lines that contain type comments (#997)
205 - removed unnecessary parentheses around `yield` expressions (#834)
207 - added parentheses around long tuples in unpacking assignments (#832)
209 - added parentheses around complex powers when they are prefixed by a unary operator
212 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
214 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
217 - if _Black_ puts parenthesis around a single expression, it moves comments to the
218 wrapped expression instead of after the brackets (#872)
220 - `blackd` now returns the version of _Black_ in the response headers (#1013)
222 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
227 - new option `--target-version` to control which Python versions _Black_-formatted code
230 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
232 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
234 - long `del` statements are now split into multiple lines (#698)
236 - type comments are no longer mangled in function signatures
238 - improved performance of formatting deeply nested data structures (#509)
240 - _Black_ now properly formats multiple files in parallel on Windows (#632)
242 - _Black_ now creates cache files atomically which allows it to be used in parallel
243 pipelines (like `xargs -P8`) (#673)
245 - _Black_ now correctly indents comments in files that were previously formatted with
248 - `blackd` now supports CORS (#622)
252 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
254 - numeric literals are normalized to include `_` separators on Python 3.6+ code
256 - added `--skip-numeric-underscore-normalization` to disable the above behavior and
257 leave numeric underscores as they were in the input
259 - code with `_` in numeric literals is recognized as Python 3.6+
261 - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
263 - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
265 - added `blackd`, see [its documentation](#blackd) for more info (#349)
267 - adjacent string literals are now correctly split into multiple lines (#463)
269 - trailing comma is now added to single imports that don't fit on a line (#250)
271 - cache is now populated when `--check` is successful for a file which speeds up
272 consecutive checks of properly formatted unmodified files (#448)
274 - whitespace at the beginning of the file is now removed (#399)
276 - fixed mangling [pweave](http://mpastell.com/pweave/) and
277 [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
279 - fixed unstable formatting when unpacking big tuples (#267)
281 - fixed parsing of `__future__` imports with renames (#389)
283 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
285 - fixed formatting of lambda expressions with default arguments (#468)
287 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
289 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
294 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
298 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
300 - `# fmt: off` and `# fmt: on` are now much more dependable:
302 - they now work also within bracket pairs (#329)
304 - they now correctly work across function/class boundaries (#335)
306 - they now work when an indentation block starts with empty lines or misaligned
309 - made Click not fail on invalid environments; note that Click is right but the
310 likelihood we'll need to access non-ASCII file paths when dealing with Python source
313 - fixed improper formatting of f-strings with quotes inside interpolated expressions
316 - fixed unnecessary slowdown when long list literals where found in a file
318 - fixed unnecessary slowdown on AST nodes with very many siblings
320 - fixed cannibalizing backslashes during string normalization
322 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
326 - added `--config` (#65)
328 - added `-h` equivalent to `--help` (#316)
330 - fixed improper unmodified file caching when `-S` was used
332 - fixed extra space in string unpacking (#305)
334 - fixed formatting of empty triple quoted strings (#313)
336 - fixed unnecessary slowdown in comment placement calculation on lines without comments
340 - hotfix: don't output human-facing information on stdout (#299)
342 - hotfix: don't output cake emoji on non-zero return code (#300)
346 - added `--include` and `--exclude` (#270)
348 - added `--skip-string-normalization` (#118)
350 - added `--verbose` (#283)
352 - the header output in `--diff` now actually conforms to the unified diff spec
354 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
356 - fixed unnecessary parentheses when a line contained multiline strings (#232)
358 - fixed stdin handling not working correctly if an old version of Click was used (#276)
360 - _Black_ now preserves line endings when formatting a file in place (#258)
364 - added `--pyi` (#249)
366 - added `--py36` (#249)
368 - Python grammar pickle caches are stored with the formatting caches, making _Black_
369 work in environments where site-packages is not user-writable (#192)
371 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
372 fields) and the first method
374 - fixed invalid code produced when standalone comments were present in a trailer that
375 was omitted from line splitting on a large expression (#237)
377 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
379 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
380 in optional parentheses (#234)
382 - fixed unstable formatting when inline comments were moved around in a trailer that was
383 omitted from line splitting on a large expression (#238)
385 - fixed extra empty line between a class declaration and the first method if no class
386 docstring or fields are present (#219)
388 - fixed extra empty line between a function signature and an inner function or inner
393 - call chains are now formatted according to the
394 [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
396 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
397 exploded like imports when they don't fit in a single line (#152)
399 - slices are now formatted according to PEP 8 (#178)
401 - parentheses are now also managed automatically on the right-hand side of assignments
402 and return statements (#140)
404 - math operators now use their respective priorities for delimiting multiline
407 - optional parentheses are now omitted on expressions that start or end with a bracket
408 and only contain a single operator (#177)
410 - empty parentheses in a class definition are now removed (#145, #180)
412 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
413 only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
416 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
419 - progress when reformatting many files is now reported incrementally
421 - fixed trailers (content with brackets) being unnecessarily exploded into their own
422 lines after a dedented closing bracket (#119)
424 - fixed an invalid trailing comma sometimes left in imports (#185)
426 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
429 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
432 - fixed not splitting long from-imports with only a single name
434 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
435 This fixed non-deterministic formatting if trailing commas where used both in function
436 signatures with stars and function calls with stars but the former would be
437 reformatted to a single line.
439 - fixed crash on dealing with optional parentheses (#193)
441 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
444 - fixed crash when dead symlinks where encountered
448 - don't populate the cache on `--check` (#175)
452 - added a "cache"; files already reformatted that haven't changed on disk won't be
453 reformatted again (#109)
455 - `--check` and `--diff` are no longer mutually exclusive (#149)
457 - generalized star expression handling, including double stars; this fixes
458 multiplication making expressions "unsafe" for trailing commas (#132)
460 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
462 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
464 - fixed comment indentation when a standalone comment closes a block (#16, #32)
466 - fixed standalone comments receiving extra empty lines if immediately preceding a
467 class, def, or decorator (#56, #154)
469 - fixed `--diff` not showing entire path (#130)
471 - fixed parsing of complex expressions after star and double stars in function calls
474 - fixed invalid splitting on comma in lambda arguments (#133)
476 - fixed missing splits of ternary expressions (#141)
480 - fixed parsing of unaligned standalone comments (#99, #112)
482 - fixed placement of dictionary unpacking inside dictionary literals (#111)
484 - Vim plugin now works on Windows, too
486 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
491 - added `--quiet` (#78)
493 - added automatic parentheses management (#4)
495 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
497 - fixed reporting on `--check` with multiple files (#101, #102)
499 - fixed removing backslash escapes from raw strings (#100, #105)
503 - added `--diff` (#87)
505 - add line breaks before all delimiters, except in cases like commas, to better comply
508 - standardize string literals to use double quotes (almost) everywhere (#75)
510 - fixed handling of standalone comments within nested bracketed expressions; _Black_
511 will no longer produce super long lines or put all standalone comments at the end of
514 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
517 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
518 _Black_ to not emit the rest of the file (#95)
520 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
521 a flurry of asyncio-related exceptions
523 - only allow up to two empty lines on module level and only single empty lines within
528 - `# fmt: off` and `# fmt: on` are implemented (#5)
530 - automatic detection of deprecated Python 2 forms of print statements and exec
531 statements in the formatted file (#49)
533 - use proper spaces for complex expressions in default values of typed function
536 - only return exit code 1 when --check is used (#50)
538 - don't remove single trailing commas from square bracket indexing (#59)
540 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
542 - omit extra space in kwarg unpacking if it's the first argument (#46)
544 - omit extra space in
545 [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
550 - don't remove single empty lines outside of bracketed expressions (#19)
552 - added ability to pipe formatting from stdin to stdin (#25)
554 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
556 - even better handling of numpy-style array indexing (#33, again)
560 - changed positioning of binary operators to occur at beginning of lines instead of at
562 [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
565 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
566 formattings (#34, #35)
568 - remove a trailing comma if there is a single argument to a call
570 - if top level functions were separated by a comment, don't put four empty lines after
573 - fixed unstable formatting of newlines with imports
575 - fixed unintentional folding of post scriptum standalone comments into last statement
576 if it was a simple statement (#18, #28)
578 - fixed missing space in numpy-style array indexing (#33)
580 - fixed spurious space after star-based unary expressions (#31)
586 - only put trailing commas in function signatures and calls if it's safe to do so. If
587 the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
588 or `**kwargs` used in the signature or call. (#8)
590 - fixed invalid spacing of dots in relative imports (#6, #13)
592 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
594 - fixed spurious space in parenthesized set expressions (#7)
596 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
598 - fixed spurious space after unary operators when the operand was a complex expression
603 - first published version, Happy 🍰 Day 2018!
607 - date-versioned (see: https://calver.org/)