]> 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:

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