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

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