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 - reindent docstrings when reindenting code around it (#1053)
9 - show colored diffs (#1266)
11 - move to 'py3' tagged wheels (#1388)
15 - prefer virtualenv packages over global packages (#1383)
19 - added support for PEP 572 assignment expressions (#711)
21 - added support for PEP 570 positional-only arguments (#943)
23 - added support for async generators (#593)
25 - added support for pre-splitting collections by putting an explicit trailing comma
28 - added `black -c` as a way to format code passed from the command line (#761)
30 - --safe now works with Python 2 code (#840)
32 - fixed grammar selection for Python 2-specific code (#765)
34 - fixed feature detection for trailing commas in function definitions and call sites
37 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
38 code now behave correctly (#1005)
40 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
42 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
44 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
46 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
48 - _Black_ no longer fails on comments in from-imports (#671)
50 - _Black_ no longer fails when the file starts with a backslash (#922)
52 - _Black_ no longer merges regular comments with type comments (#1027)
54 - _Black_ no longer splits long lines that contain type comments (#997)
56 - removed unnecessary parentheses around `yield` expressions (#834)
58 - added parentheses around long tuples in unpacking assignments (#832)
60 - added parentheses around complex powers when they are prefixed by a unary operator
63 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
65 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
68 - if _Black_ puts parenthesis around a single expression, it moves comments to the
69 wrapped expression instead of after the brackets (#872)
71 - `blackd` now returns the version of _Black_ in the response headers (#1013)
73 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
78 - new option `--target-version` to control which Python versions _Black_-formatted code
81 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
83 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
85 - long `del` statements are now split into multiple lines (#698)
87 - type comments are no longer mangled in function signatures
89 - improved performance of formatting deeply nested data structures (#509)
91 - _Black_ now properly formats multiple files in parallel on Windows (#632)
93 - _Black_ now creates cache files atomically which allows it to be used in parallel
94 pipelines (like `xargs -P8`) (#673)
96 - _Black_ now correctly indents comments in files that were previously formatted with
99 - `blackd` now supports CORS (#622)
103 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
105 - numeric literals are normalized to include `_` separators on Python 3.6+ code
107 - added `--skip-numeric-underscore-normalization` to disable the above behavior and
108 leave numeric underscores as they were in the input
110 - code with `_` in numeric literals is recognized as Python 3.6+
112 - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
114 - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
116 - added `blackd`, see [its documentation](#blackd) for more info (#349)
118 - adjacent string literals are now correctly split into multiple lines (#463)
120 - trailing comma is now added to single imports that don't fit on a line (#250)
122 - cache is now populated when `--check` is successful for a file which speeds up
123 consecutive checks of properly formatted unmodified files (#448)
125 - whitespace at the beginning of the file is now removed (#399)
127 - fixed mangling [pweave](http://mpastell.com/pweave/) and
128 [Spyder IDE](https://pythonhosted.org/spyder/) special comments (#532)
130 - fixed unstable formatting when unpacking big tuples (#267)
132 - fixed parsing of `__future__` imports with renames (#389)
134 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
136 - fixed formatting of lambda expressions with default arguments (#468)
138 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
140 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
145 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
149 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
151 - `# fmt: off` and `# fmt: on` are now much more dependable:
153 - they now work also within bracket pairs (#329)
155 - they now correctly work across function/class boundaries (#335)
157 - they now work when an indentation block starts with empty lines or misaligned
160 - made Click not fail on invalid environments; note that Click is right but the
161 likelihood we'll need to access non-ASCII file paths when dealing with Python source
164 - fixed improper formatting of f-strings with quotes inside interpolated expressions
167 - fixed unnecessary slowdown when long list literals where found in a file
169 - fixed unnecessary slowdown on AST nodes with very many siblings
171 - fixed cannibalizing backslashes during string normalization
173 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
177 - added `--config` (#65)
179 - added `-h` equivalent to `--help` (#316)
181 - fixed improper unmodified file caching when `-S` was used
183 - fixed extra space in string unpacking (#305)
185 - fixed formatting of empty triple quoted strings (#313)
187 - fixed unnecessary slowdown in comment placement calculation on lines without comments
191 - hotfix: don't output human-facing information on stdout (#299)
193 - hotfix: don't output cake emoji on non-zero return code (#300)
197 - added `--include` and `--exclude` (#270)
199 - added `--skip-string-normalization` (#118)
201 - added `--verbose` (#283)
203 - the header output in `--diff` now actually conforms to the unified diff spec
205 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
207 - fixed unnecessary parentheses when a line contained multiline strings (#232)
209 - fixed stdin handling not working correctly if an old version of Click was used (#276)
211 - _Black_ now preserves line endings when formatting a file in place (#258)
215 - added `--pyi` (#249)
217 - added `--py36` (#249)
219 - Python grammar pickle caches are stored with the formatting caches, making _Black_
220 work in environments where site-packages is not user-writable (#192)
222 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
223 fields) and the first method
225 - fixed invalid code produced when standalone comments were present in a trailer that
226 was omitted from line splitting on a large expression (#237)
228 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
230 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
231 in optional parentheses (#234)
233 - fixed unstable formatting when inline comments were moved around in a trailer that was
234 omitted from line splitting on a large expression (#238)
236 - fixed extra empty line between a class declaration and the first method if no class
237 docstring or fields are present (#219)
239 - fixed extra empty line between a function signature and an inner function or inner
244 - call chains are now formatted according to the
245 [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
247 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
248 exploded like imports when they don't fit in a single line (#152)
250 - slices are now formatted according to PEP 8 (#178)
252 - parentheses are now also managed automatically on the right-hand side of assignments
253 and return statements (#140)
255 - math operators now use their respective priorities for delimiting multiline
258 - optional parentheses are now omitted on expressions that start or end with a bracket
259 and only contain a single operator (#177)
261 - empty parentheses in a class definition are now removed (#145, #180)
263 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
264 only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
267 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
270 - progress when reformatting many files is now reported incrementally
272 - fixed trailers (content with brackets) being unnecessarily exploded into their own
273 lines after a dedented closing bracket (#119)
275 - fixed an invalid trailing comma sometimes left in imports (#185)
277 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
280 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
283 - fixed not splitting long from-imports with only a single name
285 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
286 This fixed non-deterministic formatting if trailing commas where used both in function
287 signatures with stars and function calls with stars but the former would be
288 reformatted to a single line.
290 - fixed crash on dealing with optional parentheses (#193)
292 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
295 - fixed crash when dead symlinks where encountered
299 - don't populate the cache on `--check` (#175)
303 - added a "cache"; files already reformatted that haven't changed on disk won't be
304 reformatted again (#109)
306 - `--check` and `--diff` are no longer mutually exclusive (#149)
308 - generalized star expression handling, including double stars; this fixes
309 multiplication making expressions "unsafe" for trailing commas (#132)
311 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
313 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
315 - fixed comment indentation when a standalone comment closes a block (#16, #32)
317 - fixed standalone comments receiving extra empty lines if immediately preceding a
318 class, def, or decorator (#56, #154)
320 - fixed `--diff` not showing entire path (#130)
322 - fixed parsing of complex expressions after star and double stars in function calls
325 - fixed invalid splitting on comma in lambda arguments (#133)
327 - fixed missing splits of ternary expressions (#141)
331 - fixed parsing of unaligned standalone comments (#99, #112)
333 - fixed placement of dictionary unpacking inside dictionary literals (#111)
335 - Vim plugin now works on Windows, too
337 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
342 - added `--quiet` (#78)
344 - added automatic parentheses management (#4)
346 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
348 - fixed reporting on `--check` with multiple files (#101, #102)
350 - fixed removing backslash escapes from raw strings (#100, #105)
354 - added `--diff` (#87)
356 - add line breaks before all delimiters, except in cases like commas, to better comply
359 - standardize string literals to use double quotes (almost) everywhere (#75)
361 - fixed handling of standalone comments within nested bracketed expressions; _Black_
362 will no longer produce super long lines or put all standalone comments at the end of
365 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
368 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
369 _Black_ to not emit the rest of the file (#95)
371 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
372 a flurry of asyncio-related exceptions
374 - only allow up to two empty lines on module level and only single empty lines within
379 - `# fmt: off` and `# fmt: on` are implemented (#5)
381 - automatic detection of deprecated Python 2 forms of print statements and exec
382 statements in the formatted file (#49)
384 - use proper spaces for complex expressions in default values of typed function
387 - only return exit code 1 when --check is used (#50)
389 - don't remove single trailing commas from square bracket indexing (#59)
391 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
393 - omit extra space in kwarg unpacking if it's the first argument (#46)
395 - omit extra space in
396 [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
401 - don't remove single empty lines outside of bracketed expressions (#19)
403 - added ability to pipe formatting from stdin to stdin (#25)
405 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
407 - even better handling of numpy-style array indexing (#33, again)
411 - changed positioning of binary operators to occur at beginning of lines instead of at
413 [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
416 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
417 formattings (#34, #35)
419 - remove a trailing comma if there is a single argument to a call
421 - if top level functions were separated by a comment, don't put four empty lines after
424 - fixed unstable formatting of newlines with imports
426 - fixed unintentional folding of post scriptum standalone comments into last statement
427 if it was a simple statement (#18, #28)
429 - fixed missing space in numpy-style array indexing (#33)
431 - fixed spurious space after star-based unary expressions (#31)
437 - only put trailing commas in function signatures and calls if it's safe to do so. If
438 the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
439 or `**kwargs` used in the signature or call. (#8)
441 - fixed invalid spacing of dots in relative imports (#6, #13)
443 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
445 - fixed spurious space in parenthesized set expressions (#7)
447 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
449 - fixed spurious space after unary operators when the operand was a complex expression
454 - first published version, Happy 🍰 Day 2018!
458 - date-versioned (see: https://calver.org/)