]> git.madduck.net Git - etc/vim.git/blob - CHANGES.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

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.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

CI: add diff-shades integration (#2725)
[etc/vim.git] / CHANGES.md
1 # Change Log
2
3 ## Unreleased
4
5 ### _Black_
6
7 - **Remove Python 2 support** (#2740)
8 - Do not accept bare carriage return line endings in pyproject.toml (#2408)
9 - Improve error message for invalid regular expression (#2678)
10 - Improve error message when parsing fails during AST safety check by embedding the
11   underlying SyntaxError (#2693)
12 - Fix mapping cases that contain as-expressions, like `case {"key": 1 | 2 as password}`
13   (#2686)
14 - Fix cases that contain multiple top-level as-expressions, like `case 1 as a, 2 as b`
15   (#2716)
16 - Fix call patterns that contain as-expressions with keyword arguments, like
17   `case Foo(bar=baz as quux)` (#2749)
18 - No longer color diff headers white as it's unreadable in light themed terminals
19   (#2691)
20 - Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (#2700)
21 - Unparenthesized tuples on annotated assignments (e.g
22   `values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (#2708)
23 - Text coloring added in the final statistics (#2712)
24 - For stubs, one blank line between class attributes and methods is now kept if there's
25   at least one pre-existing blank line (#2736)
26 - Verbose mode also now describes how a project root was discovered and which paths will
27   be formatted. (#2526)
28 - Speed-up the new backtracking parser about 4X in general (enabled when
29   `--target-version` is set to 3.10 and higher). (#2728)
30 - Fix handling of standalone `match()` or `case()` when there is a trailing newline or a
31   comment inside of the parentheses. (#2760)
32 - Black now normalizes string prefix order (#2297)
33
34 ### Packaging
35
36 - All upper version bounds on dependencies have been removed (#2718)
37
38 ### Integrations
39
40 - Update GitHub action to support containerized runs (#2748)
41
42 ### Documentation
43
44 - Change protocol in pip installation instructions to `https://` (#2761)
45
46 ## 21.12b0
47
48 ### _Black_
49
50 - Fix determination of f-string expression spans (#2654)
51 - Fix bad formatting of error messages about EOF in multi-line statements (#2343)
52 - Functions and classes in blocks now have more consistent surrounding spacing (#2472)
53 - `from __future__ import annotations` statement now implies Python 3.7+ (#2690)
54
55 #### Jupyter Notebook support
56
57 - Cell magics are now only processed if they are known Python cell magics. Earlier, all
58   cell magics were tokenized, leading to possible indentation errors e.g. with
59   `%%writefile`. (#2630)
60 - Fix assignment to environment variables in Jupyter Notebooks (#2642)
61
62 #### Python 3.10 support
63
64 - Point users to using `--target-version py310` if we detect 3.10-only syntax (#2668)
65 - Fix `match` statements with open sequence subjects, like `match a, b:` or
66   `match a, *b:` (#2639) (#2659)
67 - Fix `match`/`case` statements that contain `match`/`case` soft keywords multiple
68   times, like `match re.match()` (#2661)
69 - Fix `case` statements with an inline body (#2665)
70 - Fix styling of starred expressions inside `match` subject (#2667)
71 - Fix parser error location on invalid syntax in a `match` statement (#2649)
72 - Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
73 - Improve parsing performance on code that uses `match` under `--target-version py310`
74   up to ~50% (#2670)
75
76 ### Packaging
77
78 - Remove dependency on `regex` (#2644) (#2663)
79
80 ## 21.11b1
81
82 ### _Black_
83
84 - Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
85
86 ## 21.11b0
87
88 ### _Black_
89
90 - Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
91   detection (#2592)
92 - Add experimental PyPy support (#2559)
93 - Add partial support for the match statement. As it's experimental, it's only enabled
94   when `--target-version py310` is explicitly specified (#2586)
95 - Add support for parenthesized with (#2586)
96 - Declare support for Python 3.10 for running Black (#2562)
97
98 ### Integrations
99
100 - Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
101 - The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (#2613)
102
103 ## 21.10b0
104
105 ### _Black_
106
107 - Document stability policy, that will apply for non-beta releases (#2529)
108 - Add new `--workers` parameter (#2514)
109 - Fixed feature detection for positional-only arguments in lambdas (#2532)
110 - Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
111 - Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
112   even though it has been removed (#2580)
113 - Deprecate Python 2 formatting support (#2523)
114
115 ### _Blackd_
116
117 - Remove dependency on aiohttp-cors (#2500)
118 - Bump required aiohttp version to 3.7.4 (#2509)
119
120 ### _Black-Primer_
121
122 - Add primer support for --projects (#2555)
123 - Print primer summary after individual failures (#2570)
124
125 ### Integrations
126
127 - Allow to pass `target_version` in the vim plugin (#1319)
128 - Install build tools in docker file and use multi-stage build to keep the image size
129   down (#2582)
130
131 ## 21.9b0
132
133 ### Packaging
134
135 - Fix missing modules in self-contained binaries (#2466)
136 - Fix missing toml extra used during installation (#2475)
137
138 ## 21.8b0
139
140 ### _Black_
141
142 - Add support for formatting Jupyter Notebook files (#2357)
143 - Move from `appdirs` dependency to `platformdirs` (#2375)
144 - Present a more user-friendly error if .gitignore is invalid (#2414)
145 - The failsafe for accidentally added backslashes in f-string expressions has been
146   hardened to handle more edge cases during quote normalization (#2437)
147 - Avoid changing a function return type annotation's type to a tuple by adding a
148   trailing comma (#2384)
149 - Parsing support has been added for unparenthesized walruses in set literals, set
150   comprehensions, and indices (#2447).
151 - Pin `setuptools-scm` build-time dependency version (#2457)
152 - Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10
153   (#2460)
154
155 ### _Blackd_
156
157 - Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that
158   scan installed packages (#2440)
159
160 ### Integrations
161
162 - The provided pre-commit hooks no longer specify `language_version` to avoid overriding
163   `default_language_version` (#2430)
164
165 ## 21.7b0
166
167 ### _Black_
168
169 - Configuration files using TOML features higher than spec v0.5.0 are now supported
170   (#2301)
171 - Add primer support and test for code piped into black via STDIN (#2315)
172 - Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (#2332)
173 - Accept empty stdin (#2346)
174 - Provide a more useful error when parsing fails during AST safety checks (#2304)
175
176 ### Docker
177
178 - Add new `latest_release` tag automation to follow latest black release on docker
179   images (#2374)
180
181 ### Integrations
182
183 - The vim plugin now searches upwards from the directory containing the current buffer
184   instead of the current working directory for pyproject.toml. (#1871)
185 - The vim plugin now reads the correct string normalization option in pyproject.toml
186   (#1869)
187 - The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
188   (#1869)
189
190 ## 21.6b0
191
192 ### _Black_
193
194 - Fix failure caused by `fmt: skip` and indentation (#2281)
195 - Account for += assignment when deciding whether to split string (#2312)
196 - Correct max string length calculation when there are string operators (#2292)
197 - Fixed option usage when using the `--code` flag (#2259)
198 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
199 - Added `--required-version` option to require a specific version to be running (#2300)
200 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
201   (#2311)
202 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
203 - Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
204   used (#2319)
205
206 ### Integrations
207
208 - The official Black action now supports choosing what version to use, and supports the
209   major 3 OSes. (#1940)
210
211 ## 21.5b2
212
213 ### _Black_
214
215 - A space is no longer inserted into empty docstrings (#2249)
216 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
217 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
218   `.gitignore` rules like `git` does) (#2225)
219 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
220 - Add extra uvloop install + import support if in python env (#2258)
221 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
222 - Make sure to split lines that start with a string operator (#2286)
223 - Fix regular expression that black uses to identify f-expressions (#2287)
224
225 ### _Blackd_
226
227 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
228   supported. (#2231)
229
230 ### Packaging
231
232 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
233   (#2198)
234 - Always build binaries with the latest available Python (#2260)
235
236 ### Documentation
237
238 - Add discussion of magic comments to FAQ page (#2272)
239 - `--experimental-string-processing` will be enabled by default in the future (#2273)
240 - Fix typos discovered by codespell (#2228)
241 - Fix Vim plugin installation instructions. (#2235)
242 - Add new Frequently Asked Questions page (#2247)
243 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
244
245 ## 21.5b1
246
247 ### _Black_
248
249 - Refactor `src/black/__init__.py` into many files (#2206)
250
251 ### Documentation
252
253 - Replaced all remaining references to the
254   [`master`](https://github.com/psf/black/tree/main) branch with the
255   [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
256   the source code were also made. (#2210)
257 - Sigificantly reorganized the documentation to make much more sense. Check them out by
258   heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
259   (#2174)
260
261 ## 21.5b0
262
263 ### _Black_
264
265 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
266 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
267   being called but with no arguments (#2182)
268
269 ### _Black-Primer_
270
271 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
272
273 ## 21.4b2
274
275 ### _Black_
276
277 - Fix crash if the user configuration directory is inaccessible. (#2158)
278
279 - Clarify
280   [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
281   in which _Black_ may change the AST (#2159)
282
283 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
284   or on the command line. (#2170)
285
286 ### _Packaging_
287
288 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
289
290 ## 21.4b1
291
292 ### _Black_
293
294 - Fix crash on docstrings ending with "\\ ". (#2142)
295
296 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
297
298 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
299   in the name of the cache file. Without this fix, changes in these flags would not take
300   effect if the cache had already been populated. (#2131)
301
302 - Don't remove necessary parentheses from assignment expression containing assert /
303   return statements. (#2143)
304
305 ### _Packaging_
306
307 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
308
309 ## 21.4b0
310
311 ### _Black_
312
313 - Fixed a rare but annoying formatting instability created by the combination of
314   optional trailing commas inserted by `Black` and optional parentheses looking at
315   pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
316   duplicates. (#2126)
317
318 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
319   and adding a padding space when needed to break up """". (#1740)
320
321 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
322
323 - `Black` now respects `--skip-string-normalization` when normalizing multiline
324   docstring quotes (#1637)
325
326 - `Black` no longer removes all empty lines between non-function code and decorators
327   when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
328
329 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
330   in if/while statements (#1655)
331
332 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
333   to split lines (#1824)
334
335 - fixed a crash when PWD=/ on POSIX (#1631)
336
337 - fixed "I/O operation on closed file" when using --diff (#1664)
338
339 - Prevent coloured diff output being interleaved with multiple files (#1673)
340
341 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
342
343 - Added parsing support for unparenthesized tuples and yield expressions in annotated
344   assignments (#1835)
345
346 - added `--extend-exclude` argument (PR #2005)
347
348 - speed up caching by avoiding pathlib (#1950)
349
350 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
351
352 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
353   (#1780)
354
355 - Lines ending with `fmt: skip` will now be not formatted (#1800)
356
357 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
358
359 - PR #2053: Python 2 support is now optional, install with
360   `python3 -m pip install black[python2]` to maintain support.
361
362 - Exclude `venv` directory by default (#1683)
363
364 - Fixed "Black produced code that is not equivalent to the source" when formatting
365   Python 2 docstrings (#2037)
366
367 ### _Packaging_
368
369 - Self-contained native _Black_ binaries are now provided for releases via GitHub
370   Releases (#1743)
371
372 ## 20.8b1
373
374 ### _Packaging_
375
376 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
377   older than 7.0
378
379 ## 20.8b0
380
381 ### _Black_
382
383 - re-implemented support for explicit trailing commas: now it works consistently within
384   any bracket pair, including nested structures (#1288 and duplicates)
385
386 - `Black` now reindents docstrings when reindenting code around it (#1053)
387
388 - `Black` now shows colored diffs (#1266)
389
390 - `Black` is now packaged using 'py3' tagged wheels (#1388)
391
392 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
393   (#1121)
394
395 - `Black` no longer normalizes capital R-string prefixes as those have a
396   community-accepted meaning (#1244)
397
398 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
399
400 - `Black` now works on AWS Lambda (#1141)
401
402 - added `--force-exclude` argument (#1032)
403
404 - removed deprecated `--py36` option (#1236)
405
406 - fixed `--diff` output when EOF is encountered (#526)
407
408 - fixed `# fmt: off` handling around decorators (#560)
409
410 - fixed unstable formatting with some `# type: ignore` comments (#1113)
411
412 - fixed invalid removal on organizing brackets followed by indexing (#1575)
413
414 - introduced `black-primer`, a CI tool that allows us to run regression tests against
415   existing open source users of Black (#1402)
416
417 - introduced property-based fuzzing to our test suite based on Hypothesis and
418   Hypothersmith (#1566)
419
420 - implemented experimental and disabled by default long string rewrapping (#1132),
421   hidden under a `--experimental-string-processing` flag while it's being worked on;
422   this is an undocumented and unsupported feature, you lose Internet points for
423   depending on it (#1609)
424
425 ### Vim plugin
426
427 - prefer virtualenv packages over global packages (#1383)
428
429 ## 19.10b0
430
431 - added support for PEP 572 assignment expressions (#711)
432
433 - added support for PEP 570 positional-only arguments (#943)
434
435 - added support for async generators (#593)
436
437 - added support for pre-splitting collections by putting an explicit trailing comma
438   inside (#826)
439
440 - added `black -c` as a way to format code passed from the command line (#761)
441
442 - --safe now works with Python 2 code (#840)
443
444 - fixed grammar selection for Python 2-specific code (#765)
445
446 - fixed feature detection for trailing commas in function definitions and call sites
447   (#763)
448
449 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
450   code now behave correctly (#1005)
451
452 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
453
454 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
455
456 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
457
458 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
459
460 - _Black_ no longer fails on comments in from-imports (#671)
461
462 - _Black_ no longer fails when the file starts with a backslash (#922)
463
464 - _Black_ no longer merges regular comments with type comments (#1027)
465
466 - _Black_ no longer splits long lines that contain type comments (#997)
467
468 - removed unnecessary parentheses around `yield` expressions (#834)
469
470 - added parentheses around long tuples in unpacking assignments (#832)
471
472 - added parentheses around complex powers when they are prefixed by a unary operator
473   (#646)
474
475 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
476
477 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
478   (#863)
479
480 - if _Black_ puts parenthesis around a single expression, it moves comments to the
481   wrapped expression instead of after the brackets (#872)
482
483 - `blackd` now returns the version of _Black_ in the response headers (#1013)
484
485 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
486   provided (#969)
487
488 ## 19.3b0
489
490 - new option `--target-version` to control which Python versions _Black_-formatted code
491   should target (#618)
492
493 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
494
495 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
496
497 - long `del` statements are now split into multiple lines (#698)
498
499 - type comments are no longer mangled in function signatures
500
501 - improved performance of formatting deeply nested data structures (#509)
502
503 - _Black_ now properly formats multiple files in parallel on Windows (#632)
504
505 - _Black_ now creates cache files atomically which allows it to be used in parallel
506   pipelines (like `xargs -P8`) (#673)
507
508 - _Black_ now correctly indents comments in files that were previously formatted with
509   tabs (#262)
510
511 - `blackd` now supports CORS (#622)
512
513 ## 18.9b0
514
515 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
516
517   - numeric literals are normalized to include `_` separators on Python 3.6+ code
518
519   - added `--skip-numeric-underscore-normalization` to disable the above behavior and
520     leave numeric underscores as they were in the input
521
522   - code with `_` in numeric literals is recognized as Python 3.6+
523
524   - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
525
526   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
527
528 - added `blackd`, see
529   [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
530   more info (#349)
531
532 - adjacent string literals are now correctly split into multiple lines (#463)
533
534 - trailing comma is now added to single imports that don't fit on a line (#250)
535
536 - cache is now populated when `--check` is successful for a file which speeds up
537   consecutive checks of properly formatted unmodified files (#448)
538
539 - whitespace at the beginning of the file is now removed (#399)
540
541 - fixed mangling [pweave](http://mpastell.com/pweave/) and
542   [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
543
544 - fixed unstable formatting when unpacking big tuples (#267)
545
546 - fixed parsing of `__future__` imports with renames (#389)
547
548 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
549
550 - fixed formatting of lambda expressions with default arguments (#468)
551
552 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
553
554 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
555   be a bad idea (#415)
556
557 ## 18.6b4
558
559 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
560
561 ## 18.6b3
562
563 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
564
565 - `# fmt: off` and `# fmt: on` are now much more dependable:
566
567   - they now work also within bracket pairs (#329)
568
569   - they now correctly work across function/class boundaries (#335)
570
571   - they now work when an indentation block starts with empty lines or misaligned
572     comments (#334)
573
574 - made Click not fail on invalid environments; note that Click is right but the
575   likelihood we'll need to access non-ASCII file paths when dealing with Python source
576   code is low (#277)
577
578 - fixed improper formatting of f-strings with quotes inside interpolated expressions
579   (#322)
580
581 - fixed unnecessary slowdown when long list literals where found in a file
582
583 - fixed unnecessary slowdown on AST nodes with very many siblings
584
585 - fixed cannibalizing backslashes during string normalization
586
587 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
588
589 ## 18.6b2
590
591 - added `--config` (#65)
592
593 - added `-h` equivalent to `--help` (#316)
594
595 - fixed improper unmodified file caching when `-S` was used
596
597 - fixed extra space in string unpacking (#305)
598
599 - fixed formatting of empty triple quoted strings (#313)
600
601 - fixed unnecessary slowdown in comment placement calculation on lines without comments
602
603 ## 18.6b1
604
605 - hotfix: don't output human-facing information on stdout (#299)
606
607 - hotfix: don't output cake emoji on non-zero return code (#300)
608
609 ## 18.6b0
610
611 - added `--include` and `--exclude` (#270)
612
613 - added `--skip-string-normalization` (#118)
614
615 - added `--verbose` (#283)
616
617 - the header output in `--diff` now actually conforms to the unified diff spec
618
619 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
620
621 - fixed unnecessary parentheses when a line contained multiline strings (#232)
622
623 - fixed stdin handling not working correctly if an old version of Click was used (#276)
624
625 - _Black_ now preserves line endings when formatting a file in place (#258)
626
627 ## 18.5b1
628
629 - added `--pyi` (#249)
630
631 - added `--py36` (#249)
632
633 - Python grammar pickle caches are stored with the formatting caches, making _Black_
634   work in environments where site-packages is not user-writable (#192)
635
636 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
637   fields) and the first method
638
639 - fixed invalid code produced when standalone comments were present in a trailer that
640   was omitted from line splitting on a large expression (#237)
641
642 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
643
644 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
645   in optional parentheses (#234)
646
647 - fixed unstable formatting when inline comments were moved around in a trailer that was
648   omitted from line splitting on a large expression (#238)
649
650 - fixed extra empty line between a class declaration and the first method if no class
651   docstring or fields are present (#219)
652
653 - fixed extra empty line between a function signature and an inner function or inner
654   class (#196)
655
656 ## 18.5b0
657
658 - call chains are now formatted according to the
659   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
660
661 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
662   exploded like imports when they don't fit in a single line (#152)
663
664 - slices are now formatted according to PEP 8 (#178)
665
666 - parentheses are now also managed automatically on the right-hand side of assignments
667   and return statements (#140)
668
669 - math operators now use their respective priorities for delimiting multiline
670   expressions (#148)
671
672 - optional parentheses are now omitted on expressions that start or end with a bracket
673   and only contain a single operator (#177)
674
675 - empty parentheses in a class definition are now removed (#145, #180)
676
677 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
678   only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
679   #199)
680
681 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
682   484 (#207, #210)
683
684 - progress when reformatting many files is now reported incrementally
685
686 - fixed trailers (content with brackets) being unnecessarily exploded into their own
687   lines after a dedented closing bracket (#119)
688
689 - fixed an invalid trailing comma sometimes left in imports (#185)
690
691 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
692   used (#183)
693
694 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
695   assignments (#215)
696
697 - fixed not splitting long from-imports with only a single name
698
699 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
700   This fixed non-deterministic formatting if trailing commas where used both in function
701   signatures with stars and function calls with stars but the former would be
702   reformatted to a single line.
703
704 - fixed crash on dealing with optional parentheses (#193)
705
706 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
707   purposes
708
709 - fixed crash when dead symlinks where encountered
710
711 ## 18.4a4
712
713 - don't populate the cache on `--check` (#175)
714
715 ## 18.4a3
716
717 - added a "cache"; files already reformatted that haven't changed on disk won't be
718   reformatted again (#109)
719
720 - `--check` and `--diff` are no longer mutually exclusive (#149)
721
722 - generalized star expression handling, including double stars; this fixes
723   multiplication making expressions "unsafe" for trailing commas (#132)
724
725 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
726
727 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
728
729 - fixed comment indentation when a standalone comment closes a block (#16, #32)
730
731 - fixed standalone comments receiving extra empty lines if immediately preceding a
732   class, def, or decorator (#56, #154)
733
734 - fixed `--diff` not showing entire path (#130)
735
736 - fixed parsing of complex expressions after star and double stars in function calls
737   (#2)
738
739 - fixed invalid splitting on comma in lambda arguments (#133)
740
741 - fixed missing splits of ternary expressions (#141)
742
743 ## 18.4a2
744
745 - fixed parsing of unaligned standalone comments (#99, #112)
746
747 - fixed placement of dictionary unpacking inside dictionary literals (#111)
748
749 - Vim plugin now works on Windows, too
750
751 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
752   (#120)
753
754 ## 18.4a1
755
756 - added `--quiet` (#78)
757
758 - added automatic parentheses management (#4)
759
760 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
761
762 - fixed reporting on `--check` with multiple files (#101, #102)
763
764 - fixed removing backslash escapes from raw strings (#100, #105)
765
766 ## 18.4a0
767
768 - added `--diff` (#87)
769
770 - add line breaks before all delimiters, except in cases like commas, to better comply
771   with PEP 8 (#73)
772
773 - standardize string literals to use double quotes (almost) everywhere (#75)
774
775 - fixed handling of standalone comments within nested bracketed expressions; _Black_
776   will no longer produce super long lines or put all standalone comments at the end of
777   the expression (#22)
778
779 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
780   (#80)
781
782 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
783   _Black_ to not emit the rest of the file (#95)
784
785 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
786   a flurry of asyncio-related exceptions
787
788 - only allow up to two empty lines on module level and only single empty lines within
789   functions (#74)
790
791 ## 18.3a4
792
793 - `# fmt: off` and `# fmt: on` are implemented (#5)
794
795 - automatic detection of deprecated Python 2 forms of print statements and exec
796   statements in the formatted file (#49)
797
798 - use proper spaces for complex expressions in default values of typed function
799   arguments (#60)
800
801 - only return exit code 1 when --check is used (#50)
802
803 - don't remove single trailing commas from square bracket indexing (#59)
804
805 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
806
807 - omit extra space in kwarg unpacking if it's the first argument (#46)
808
809 - omit extra space in
810   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
811   (#68)
812
813 ## 18.3a3
814
815 - don't remove single empty lines outside of bracketed expressions (#19)
816
817 - added ability to pipe formatting from stdin to stdin (#25)
818
819 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
820
821 - even better handling of numpy-style array indexing (#33, again)
822
823 ## 18.3a2
824
825 - changed positioning of binary operators to occur at beginning of lines instead of at
826   the end, following
827   [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
828   (#21)
829
830 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
831   formattings (#34, #35)
832
833 - remove a trailing comma if there is a single argument to a call
834
835 - if top level functions were separated by a comment, don't put four empty lines after
836   the upper function
837
838 - fixed unstable formatting of newlines with imports
839
840 - fixed unintentional folding of post scriptum standalone comments into last statement
841   if it was a simple statement (#18, #28)
842
843 - fixed missing space in numpy-style array indexing (#33)
844
845 - fixed spurious space after star-based unary expressions (#31)
846
847 ## 18.3a1
848
849 - added `--check`
850
851 - only put trailing commas in function signatures and calls if it's safe to do so. If
852   the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
853   or `**kwargs` used in the signature or call. (#8)
854
855 - fixed invalid spacing of dots in relative imports (#6, #13)
856
857 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
858
859 - fixed spurious space in parenthesized set expressions (#7)
860
861 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
862
863 - fixed spurious space after unary operators when the operand was a complex expression
864   (#15)
865
866 ## 18.3a0
867
868 - first published version, Happy 🍰 Day 2018!
869
870 - alpha quality
871
872 - date-versioned (see: <https://calver.org/>)