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