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

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