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 - `Black` now respects `--skip-string-normalization` when normalizing multiline
8 docstring quotes (#1637)
10 - `Black` no longer removes all empty lines between non-function code and decorators
11 when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
13 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
14 in if/while statements (#1655)
16 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
17 to split lines (#1824)
19 - fixed a crash when PWD=/ on POSIX (#1631)
21 - fixed "I/O operation on closed file" when using --diff (#1664)
23 - Prevent coloured diff output being interleaved with multiple files (#1673)
25 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
27 - Added parsing support for unparenthesized tuples and yield expressions in annotated
30 - use lowercase hex strings (#1692)
32 - added `--extend-exclude` argument (PR #2005)
34 - speed up caching by avoiding pathlib (#1950)
36 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
38 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
41 - Lines ending with `fmt: skip` will now be not formatted (#1800)
43 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
45 - PR #2053: Python 2 support is now optional, install with
46 `python3 -m pip install black[python2]` to maintain support.
50 - Self-contained native _Black_ binaries are now provided for releases via GitHub
57 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
64 - re-implemented support for explicit trailing commas: now it works consistently within
65 any bracket pair, including nested structures (#1288 and duplicates)
67 - `Black` now reindents docstrings when reindenting code around it (#1053)
69 - `Black` now shows colored diffs (#1266)
71 - `Black` is now packaged using 'py3' tagged wheels (#1388)
73 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
76 - `Black` no longer normalizes capital R-string prefixes as those have a
77 community-accepted meaning (#1244)
79 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
81 - `Black` now works on AWS Lambda (#1141)
83 - added `--force-exclude` argument (#1032)
85 - removed deprecated `--py36` option (#1236)
87 - fixed `--diff` output when EOF is encountered (#526)
89 - fixed `# fmt: off` handling around decorators (#560)
91 - fixed unstable formatting with some `# type: ignore` comments (#1113)
93 - fixed invalid removal on organizing brackets followed by indexing (#1575)
95 - introduced `black-primer`, a CI tool that allows us to run regression tests against
96 existing open source users of Black (#1402)
98 - introduced property-based fuzzing to our test suite based on Hypothesis and
101 - implemented experimental and disabled by default long string rewrapping (#1132),
102 hidden under a `--experimental-string-processing` flag while it's being worked on;
103 this is an undocumented and unsupported feature, you lose Internet points for
104 depending on it (#1609)
108 - prefer virtualenv packages over global packages (#1383)
112 - added support for PEP 572 assignment expressions (#711)
114 - added support for PEP 570 positional-only arguments (#943)
116 - added support for async generators (#593)
118 - added support for pre-splitting collections by putting an explicit trailing comma
121 - added `black -c` as a way to format code passed from the command line (#761)
123 - --safe now works with Python 2 code (#840)
125 - fixed grammar selection for Python 2-specific code (#765)
127 - fixed feature detection for trailing commas in function definitions and call sites
130 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
131 code now behave correctly (#1005)
133 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
135 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
137 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
139 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
141 - _Black_ no longer fails on comments in from-imports (#671)
143 - _Black_ no longer fails when the file starts with a backslash (#922)
145 - _Black_ no longer merges regular comments with type comments (#1027)
147 - _Black_ no longer splits long lines that contain type comments (#997)
149 - removed unnecessary parentheses around `yield` expressions (#834)
151 - added parentheses around long tuples in unpacking assignments (#832)
153 - added parentheses around complex powers when they are prefixed by a unary operator
156 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
158 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
161 - if _Black_ puts parenthesis around a single expression, it moves comments to the
162 wrapped expression instead of after the brackets (#872)
164 - `blackd` now returns the version of _Black_ in the response headers (#1013)
166 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
171 - new option `--target-version` to control which Python versions _Black_-formatted code
174 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
176 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
178 - long `del` statements are now split into multiple lines (#698)
180 - type comments are no longer mangled in function signatures
182 - improved performance of formatting deeply nested data structures (#509)
184 - _Black_ now properly formats multiple files in parallel on Windows (#632)
186 - _Black_ now creates cache files atomically which allows it to be used in parallel
187 pipelines (like `xargs -P8`) (#673)
189 - _Black_ now correctly indents comments in files that were previously formatted with
192 - `blackd` now supports CORS (#622)
196 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
198 - numeric literals are normalized to include `_` separators on Python 3.6+ code
200 - added `--skip-numeric-underscore-normalization` to disable the above behavior and
201 leave numeric underscores as they were in the input
203 - code with `_` in numeric literals is recognized as Python 3.6+
205 - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
207 - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
209 - added `blackd`, see [its documentation](#blackd) for more info (#349)
211 - adjacent string literals are now correctly split into multiple lines (#463)
213 - trailing comma is now added to single imports that don't fit on a line (#250)
215 - cache is now populated when `--check` is successful for a file which speeds up
216 consecutive checks of properly formatted unmodified files (#448)
218 - whitespace at the beginning of the file is now removed (#399)
220 - fixed mangling [pweave](http://mpastell.com/pweave/) and
221 [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
223 - fixed unstable formatting when unpacking big tuples (#267)
225 - fixed parsing of `__future__` imports with renames (#389)
227 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
229 - fixed formatting of lambda expressions with default arguments (#468)
231 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
233 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
238 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
242 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
244 - `# fmt: off` and `# fmt: on` are now much more dependable:
246 - they now work also within bracket pairs (#329)
248 - they now correctly work across function/class boundaries (#335)
250 - they now work when an indentation block starts with empty lines or misaligned
253 - made Click not fail on invalid environments; note that Click is right but the
254 likelihood we'll need to access non-ASCII file paths when dealing with Python source
257 - fixed improper formatting of f-strings with quotes inside interpolated expressions
260 - fixed unnecessary slowdown when long list literals where found in a file
262 - fixed unnecessary slowdown on AST nodes with very many siblings
264 - fixed cannibalizing backslashes during string normalization
266 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
270 - added `--config` (#65)
272 - added `-h` equivalent to `--help` (#316)
274 - fixed improper unmodified file caching when `-S` was used
276 - fixed extra space in string unpacking (#305)
278 - fixed formatting of empty triple quoted strings (#313)
280 - fixed unnecessary slowdown in comment placement calculation on lines without comments
284 - hotfix: don't output human-facing information on stdout (#299)
286 - hotfix: don't output cake emoji on non-zero return code (#300)
290 - added `--include` and `--exclude` (#270)
292 - added `--skip-string-normalization` (#118)
294 - added `--verbose` (#283)
296 - the header output in `--diff` now actually conforms to the unified diff spec
298 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
300 - fixed unnecessary parentheses when a line contained multiline strings (#232)
302 - fixed stdin handling not working correctly if an old version of Click was used (#276)
304 - _Black_ now preserves line endings when formatting a file in place (#258)
308 - added `--pyi` (#249)
310 - added `--py36` (#249)
312 - Python grammar pickle caches are stored with the formatting caches, making _Black_
313 work in environments where site-packages is not user-writable (#192)
315 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
316 fields) and the first method
318 - fixed invalid code produced when standalone comments were present in a trailer that
319 was omitted from line splitting on a large expression (#237)
321 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
323 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
324 in optional parentheses (#234)
326 - fixed unstable formatting when inline comments were moved around in a trailer that was
327 omitted from line splitting on a large expression (#238)
329 - fixed extra empty line between a class declaration and the first method if no class
330 docstring or fields are present (#219)
332 - fixed extra empty line between a function signature and an inner function or inner
337 - call chains are now formatted according to the
338 [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
340 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
341 exploded like imports when they don't fit in a single line (#152)
343 - slices are now formatted according to PEP 8 (#178)
345 - parentheses are now also managed automatically on the right-hand side of assignments
346 and return statements (#140)
348 - math operators now use their respective priorities for delimiting multiline
351 - optional parentheses are now omitted on expressions that start or end with a bracket
352 and only contain a single operator (#177)
354 - empty parentheses in a class definition are now removed (#145, #180)
356 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
357 only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
360 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
363 - progress when reformatting many files is now reported incrementally
365 - fixed trailers (content with brackets) being unnecessarily exploded into their own
366 lines after a dedented closing bracket (#119)
368 - fixed an invalid trailing comma sometimes left in imports (#185)
370 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
373 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
376 - fixed not splitting long from-imports with only a single name
378 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
379 This fixed non-deterministic formatting if trailing commas where used both in function
380 signatures with stars and function calls with stars but the former would be
381 reformatted to a single line.
383 - fixed crash on dealing with optional parentheses (#193)
385 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
388 - fixed crash when dead symlinks where encountered
392 - don't populate the cache on `--check` (#175)
396 - added a "cache"; files already reformatted that haven't changed on disk won't be
397 reformatted again (#109)
399 - `--check` and `--diff` are no longer mutually exclusive (#149)
401 - generalized star expression handling, including double stars; this fixes
402 multiplication making expressions "unsafe" for trailing commas (#132)
404 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
406 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
408 - fixed comment indentation when a standalone comment closes a block (#16, #32)
410 - fixed standalone comments receiving extra empty lines if immediately preceding a
411 class, def, or decorator (#56, #154)
413 - fixed `--diff` not showing entire path (#130)
415 - fixed parsing of complex expressions after star and double stars in function calls
418 - fixed invalid splitting on comma in lambda arguments (#133)
420 - fixed missing splits of ternary expressions (#141)
424 - fixed parsing of unaligned standalone comments (#99, #112)
426 - fixed placement of dictionary unpacking inside dictionary literals (#111)
428 - Vim plugin now works on Windows, too
430 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
435 - added `--quiet` (#78)
437 - added automatic parentheses management (#4)
439 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
441 - fixed reporting on `--check` with multiple files (#101, #102)
443 - fixed removing backslash escapes from raw strings (#100, #105)
447 - added `--diff` (#87)
449 - add line breaks before all delimiters, except in cases like commas, to better comply
452 - standardize string literals to use double quotes (almost) everywhere (#75)
454 - fixed handling of standalone comments within nested bracketed expressions; _Black_
455 will no longer produce super long lines or put all standalone comments at the end of
458 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
461 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
462 _Black_ to not emit the rest of the file (#95)
464 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
465 a flurry of asyncio-related exceptions
467 - only allow up to two empty lines on module level and only single empty lines within
472 - `# fmt: off` and `# fmt: on` are implemented (#5)
474 - automatic detection of deprecated Python 2 forms of print statements and exec
475 statements in the formatted file (#49)
477 - use proper spaces for complex expressions in default values of typed function
480 - only return exit code 1 when --check is used (#50)
482 - don't remove single trailing commas from square bracket indexing (#59)
484 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
486 - omit extra space in kwarg unpacking if it's the first argument (#46)
488 - omit extra space in
489 [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
494 - don't remove single empty lines outside of bracketed expressions (#19)
496 - added ability to pipe formatting from stdin to stdin (#25)
498 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
500 - even better handling of numpy-style array indexing (#33, again)
504 - changed positioning of binary operators to occur at beginning of lines instead of at
506 [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
509 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
510 formattings (#34, #35)
512 - remove a trailing comma if there is a single argument to a call
514 - if top level functions were separated by a comment, don't put four empty lines after
517 - fixed unstable formatting of newlines with imports
519 - fixed unintentional folding of post scriptum standalone comments into last statement
520 if it was a simple statement (#18, #28)
522 - fixed missing space in numpy-style array indexing (#33)
524 - fixed spurious space after star-based unary expressions (#31)
530 - only put trailing commas in function signatures and calls if it's safe to do so. If
531 the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
532 or `**kwargs` used in the signature or call. (#8)
534 - fixed invalid spacing of dots in relative imports (#6, #13)
536 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
538 - fixed spurious space in parenthesized set expressions (#7)
540 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
542 - fixed spurious space after unary operators when the operand was a complex expression
547 - first published version, Happy 🍰 Day 2018!
551 - date-versioned (see: https://calver.org/)