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

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