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

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