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

acb5a822674ba22db49ee5223ee641b40c07f973
[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 ### Stable style
10
11 <!-- Changes that affect Black's stable style -->
12
13 - Fix a bug where an illegal trailing comma was added to return type annotations using
14   PEP 604 unions (#3735)
15 - Fix a bug where multi-line open parenthesis magic comment like `type: ignore` were not
16   correctly parsed (#3740)
17
18 ### Preview style
19
20 <!-- Changes that affect Black's preview style -->
21
22 - Implicitly concatenated strings used as function args are no longer wrapped inside
23   parentheses (#3640)
24 - Remove blank lines between a class definition and its docstring (#3692)
25
26 ### Configuration
27
28 <!-- Changes to how Black can be configured -->
29
30 - The `--workers` argument to Black can now be specified via the `BLACK_NUM_WORKERS`
31   environment variable (#3743)
32 - `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (#3691)
33 - Fix black not honouring `pyproject.toml` settings when running `--stdin-filename` and
34   the `pyproject.toml` found isn't in the current working directory (#3719)
35
36 ### Packaging
37
38 <!-- Changes to how Black is packaged, such as dependency requirements -->
39
40 - Upgrade mypyc from 0.991 to 1.3 (#3697)
41
42 ### Parser
43
44 <!-- Changes to the parser or to version autodetection -->
45
46 - Add support for the new PEP 695 syntax in Python 3.12 (#3703)
47
48 ### Performance
49
50 <!-- Changes that improve Black's performance. -->
51
52 - Avoid importing `IPython` in a case where we wouldn't need it (#3748)
53
54 ### Output
55
56 <!-- Changes to Black's terminal output and error messages -->
57
58 - Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728)
59 - Change verbose logging to exactly mirror _Black_'s logic for source discovery (#3749)
60
61 ### _Blackd_
62
63 <!-- Changes to blackd -->
64
65 - The `blackd` argument parser now shows the default values for options in their help
66   text (#3712)
67
68 ### Integrations
69
70 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
71
72 - Black is now tested with
73   [`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning)
74   (#3763)
75 - Update GitHub Action to display black output in the job summary (#3688)
76 - Deprecated `set-output` command in CI test to keep up to date with GitHub's
77   deprecation announcement (#3757)
78
79 ### Documentation
80
81 <!-- Major changes to documentation and policies. Small docs changes
82      don't need a changelog entry. -->
83
84 - Updated the _classes_ and _exceptions_ documentation in Developer reference to match
85   the latest ccode base. (#3755)
86
87 ## 23.3.0
88
89 ### Highlights
90
91 This release fixes a longstanding confusing behavior in Black's GitHub action, where the
92 version of the action did not determine the version of Black being run (issue #3382). In
93 addition, there is a small bug fix around imports and a number of improvements to the
94 preview style.
95
96 Please try out the
97 [preview style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html#preview-style)
98 with `black --preview` and tell us your feedback. All changes in the preview style are
99 expected to become part of Black's stable style in January 2024.
100
101 ### Stable style
102
103 - Import lines with `# fmt: skip` and `# fmt: off` no longer have an extra blank line
104   added when they are right after another import line (#3610)
105
106 ### Preview style
107
108 - Add trailing commas to collection literals even if there's a comment after the last
109   entry (#3393)
110 - `async def`, `async for`, and `async with` statements are now formatted consistently
111   compared to their non-async version. (#3609)
112 - `with` statements that contain two context managers will be consistently wrapped in
113   parentheses (#3589)
114 - Let string splitters respect [East Asian Width](https://www.unicode.org/reports/tr11/)
115   (#3445)
116 - Now long string literals can be split after East Asian commas and periods (`、` U+3001
117   IDEOGRAPHIC COMMA, `。` U+3002 IDEOGRAPHIC FULL STOP, & `,` U+FF0C FULLWIDTH COMMA)
118   besides before spaces (#3445)
119 - For stubs, enforce one blank line after a nested class with a body other than just
120   `...` (#3564)
121 - Improve handling of multiline strings by changing line split behavior (#1879)
122
123 ### Parser
124
125 - Added support for formatting files with invalid type comments (#3594)
126
127 ### Integrations
128
129 - Update GitHub Action to use the version of Black equivalent to action's version if
130   version input is not specified (#3543)
131 - Fix missing Python binary path in autoload script for vim (#3508)
132
133 ### Documentation
134
135 - Document that only the most recent release is supported for security issues;
136   vulnerabilities should be reported through Tidelift (#3612)
137
138 ## 23.1.0
139
140 ### Highlights
141
142 This is the first release of 2023, and following our
143 [stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy),
144 it comes with a number of improvements to our stable style, including improvements to
145 empty line handling, removal of redundant parentheses in several contexts, and output
146 that highlights implicitly concatenated strings better.
147
148 There are also many changes to the preview style; try out `black --preview` and give us
149 feedback to help us set the stable style for next year.
150
151 In addition to style changes, Black now automatically infers the supported Python
152 versions from your `pyproject.toml` file, removing the need to set Black's target
153 versions separately.
154
155 ### Stable style
156
157 <!-- Changes that affect Black's stable style -->
158
159 - Introduce the 2023 stable style, which incorporates most aspects of last year's
160   preview style (#3418). Specific changes:
161   - Enforce empty lines before classes and functions with sticky leading comments
162     (#3302) (22.12.0)
163   - Reformat empty and whitespace-only files as either an empty file (if no newline is
164     present) or as a single newline character (if a newline is present) (#3348)
165     (22.12.0)
166   - Implicitly concatenated strings used as function args are now wrapped inside
167     parentheses (#3307) (22.12.0)
168   - Correctly handle trailing commas that are inside a line's leading non-nested parens
169     (#3370) (22.12.0)
170   - `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
171     normalized as expected (#3168) (since 22.8.0)
172   - When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
173     subscript expressions with more than 1 element (#3209) (22.8.0)
174   - Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
175     parentheses (#3162) (22.8.0)
176   - Fix a string merging/split issue when a comment is present in the middle of
177     implicitly concatenated strings on its own line (#3227) (22.8.0)
178   - Docstring quotes are no longer moved if it would violate the line length limit
179     (#3044, #3430) (22.6.0)
180   - Parentheses around return annotations are now managed (#2990) (22.6.0)
181   - Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
182   - Remove unnecessary parentheses in `with` statements (#2926) (22.6.0)
183   - Remove trailing newlines after code block open (#3035) (22.6.0)
184   - Code cell separators `#%%` are now standardised to `# %%` (#2919) (22.3.0)
185   - Remove unnecessary parentheses from `except` statements (#2939) (22.3.0)
186   - Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945) (22.3.0)
187   - Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
188 - Fix a crash when a colon line is marked between `# fmt: off` and `# fmt: on` (#3439)
189
190 ### Preview style
191
192 <!-- Changes that affect Black's preview style -->
193
194 - Format hex codes in unicode escape sequences in string literals (#2916)
195 - Add parentheses around `if`-`else` expressions (#2278)
196 - Improve performance on large expressions that contain many strings (#3467)
197 - Fix a crash in preview style with assert + parenthesized string (#3415)
198 - Fix crashes in preview style with walrus operators used in function return annotations
199   and except clauses (#3423)
200 - Fix a crash in preview advanced string processing where mixed implicitly concatenated
201   regular and f-strings start with an empty span (#3463)
202 - Fix a crash in preview advanced string processing where a standalone comment is placed
203   before a dict's value (#3469)
204 - Fix an issue where extra empty lines are added when a decorator has `# fmt: skip`
205   applied or there is a standalone comment between decorators (#3470)
206 - Do not put the closing quotes in a docstring on a separate line, even if the line is
207   too long (#3430)
208 - Long values in dict literals are now wrapped in parentheses; correspondingly
209   unnecessary parentheses around short values in dict literals are now removed; long
210   string lambda values are now wrapped in parentheses (#3440)
211 - Fix two crashes in preview style involving edge cases with docstrings (#3451)
212 - Exclude string type annotations from improved string processing; fix crash when the
213   return type annotation is stringified and spans across multiple lines (#3462)
214 - Wrap multiple context managers in parentheses when targeting Python 3.9+ (#3489)
215 - Fix several crashes in preview style with walrus operators used in `with` statements
216   or tuples (#3473)
217 - Fix an invalid quote escaping bug in f-string expressions where it produced invalid
218   code. Implicitly concatenated f-strings with different quotes can now be merged or
219   quote-normalized by changing the quotes used in expressions. (#3509)
220 - Fix crash on `await (yield)` when Black is compiled with mypyc (#3533)
221
222 ### Configuration
223
224 <!-- Changes to how Black can be configured -->
225
226 - Black now tries to infer its `--target-version` from the project metadata specified in
227   `pyproject.toml` (#3219)
228
229 ### Packaging
230
231 <!-- Changes to how Black is packaged, such as dependency requirements -->
232
233 - Upgrade mypyc from `0.971` to `0.991` so mypycified _Black_ can be built on armv7
234   (#3380)
235   - This also fixes some crashes while using compiled Black with a debug build of
236     CPython
237 - Drop specific support for the `tomli` requirement on 3.11 alpha releases, working
238   around a bug that would cause the requirement not to be installed on any non-final
239   Python releases (#3448)
240 - Black now depends on `packaging` version `22.0` or later. This is required for new
241   functionality that needs to parse part of the project metadata (#3219)
242
243 ### Output
244
245 <!-- Changes to Black's terminal output and error messages -->
246
247 - Calling `black --help` multiple times will return the same help contents each time
248   (#3516)
249 - Verbose logging now shows the values of `pyproject.toml` configuration variables
250   (#3392)
251 - Fix false symlink detection messages in verbose output due to using an incorrect
252   relative path to the project root (#3385)
253
254 ### Integrations
255
256 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
257
258 - Move 3.11 CI to normal flow now that all dependencies support 3.11 (#3446)
259 - Docker: Add new `latest_prerelease` tag automation to follow latest black alpha
260   release on docker images (#3465)
261
262 ### Documentation
263
264 <!-- Major changes to documentation and policies. Small docs changes
265      don't need a changelog entry. -->
266
267 - Expand `vim-plug` installation instructions to offer more explicit options (#3468)
268
269 ## 22.12.0
270
271 ### Preview style
272
273 <!-- Changes that affect Black's preview style -->
274
275 - Enforce empty lines before classes and functions with sticky leading comments (#3302)
276 - Reformat empty and whitespace-only files as either an empty file (if no newline is
277   present) or as a single newline character (if a newline is present) (#3348)
278 - Implicitly concatenated strings used as function args are now wrapped inside
279   parentheses (#3307)
280 - For assignment statements, prefer splitting the right hand side if the left hand side
281   fits on a single line (#3368)
282 - Correctly handle trailing commas that are inside a line's leading non-nested parens
283   (#3370)
284
285 ### Configuration
286
287 <!-- Changes to how Black can be configured -->
288
289 - Fix incorrectly applied `.gitignore` rules by considering the `.gitignore` location
290   and the relative path to the target file (#3338)
291 - Fix incorrectly ignoring `.gitignore` presence when more than one source directory is
292   specified (#3336)
293
294 ### Parser
295
296 <!-- Changes to the parser or to version autodetection -->
297
298 - Parsing support has been added for walruses inside generator expression that are
299   passed as function args (for example,
300   `any(match := my_re.match(text) for text in texts)`) (#3327).
301
302 ### Integrations
303
304 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
305
306 - Vim plugin: Optionally allow using the system installation of Black via
307   `let g:black_use_virtualenv = 0`(#3309)
308
309 ## 22.10.0
310
311 ### Highlights
312
313 - Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
314   supported until further notice.
315
316 ### Stable style
317
318 - Fix a crash when `# fmt: on` is used on a different block level than `# fmt: off`
319   (#3281)
320
321 ### Preview style
322
323 - Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
324   (#3262)
325
326 ### Configuration
327
328 - `.ipynb_checkpoints` directories are now excluded by default (#3293)
329 - Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
330   while formatting (#3299)
331
332 ### Packaging
333
334 - Executables made with PyInstaller will no longer crash when formatting several files
335   at once on macOS. Native x86-64 executables for macOS are available once again.
336   (#3275)
337 - Hatchling is now used as the build backend. This will not have any effect for users
338   who install Black with its wheels from PyPI. (#3233)
339 - Faster compiled wheels are now available for CPython 3.11 (#3276)
340
341 ### _Blackd_
342
343 - Windows style (CRLF) newlines will be preserved (#3257).
344
345 ### Integrations
346
347 - Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (#3246)
348 - Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
349   option (#3282)
350 - Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
351   version (#3265)
352
353 ## 22.8.0
354
355 ### Highlights
356
357 - Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as
358   of publishing (#3234)
359 - This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6
360   code will continue to be supported until further notice)
361 - Reword the stability policy to say that we may, in rare cases, make changes that
362   affect code that was not previously formatted by _Black_ (#3155)
363
364 ### Stable style
365
366 - Fix an infinite loop when using `# fmt: on/off` in the middle of an expression or code
367   block (#3158)
368 - Fix incorrect handling of `# fmt: skip` on colon (`:`) lines (#3148)
369 - Comments are no longer deleted when a line had spaces removed around power operators
370   (#2874)
371
372 ### Preview style
373
374 - Single-character closing docstring quotes are no longer moved to their own line as
375   this is invalid. This was a bug introduced in version 22.6.0. (#3166)
376 - `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
377   normalized as expected (#3168)
378 - When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
379   subscript expressions with more than 1 element (#3209)
380 - Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
381   parentheses (#3162)
382 - Fix a string merging/split issue when a comment is present in the middle of implicitly
383   concatenated strings on its own line (#3227)
384
385 ### _Blackd_
386
387 - `blackd` now supports enabling the preview style via the `X-Preview` header (#3217)
388
389 ### Configuration
390
391 - Black now uses the presence of debug f-strings to detect target version (#3215)
392 - Fix misdetection of project root and verbose logging of sources in cases involving
393   `--stdin-filename` (#3216)
394 - Immediate `.gitignore` files in source directories given on the command line are now
395   also respected, previously only `.gitignore` files in the project root and
396   automatically discovered directories were respected (#3237)
397
398 ### Documentation
399
400 - Recommend using BlackConnect in IntelliJ IDEs (#3150)
401
402 ### Integrations
403
404 - Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
405 - Docker: changed to a /opt/venv installation + added to PATH to be available to
406   non-root users (#3202)
407
408 ### Output
409
410 - Change from deprecated `asyncio.get_event_loop()` to create our event loop which
411   removes DeprecationWarning (#3164)
412 - Remove logging from internal `blib2to3` library since it regularly emits error logs
413   about failed caching that can and should be ignored (#3193)
414
415 ### Parser
416
417 - Type comments are now included in the AST equivalence check consistently so accidental
418   deletion raises an error. Though type comments can't be tracked when running on PyPy
419   3.7 due to standard library limitations. (#2874)
420
421 ### Performance
422
423 - Reduce Black's startup time when formatting a single file by 15-30% (#3211)
424
425 ## 22.6.0
426
427 ### Style
428
429 - Fix unstable formatting involving `#fmt: skip` and `# fmt:skip` comments (notice the
430   lack of spaces) (#2970)
431
432 ### Preview style
433
434 - Docstring quotes are no longer moved if it would violate the line length limit (#3044)
435 - Parentheses around return annotations are now managed (#2990)
436 - Remove unnecessary parentheses around awaited objects (#2991)
437 - Remove unnecessary parentheses in `with` statements (#2926)
438 - Remove trailing newlines after code block open (#3035)
439
440 ### Integrations
441
442 - Add `scripts/migrate-black.py` script to ease introduction of Black to a Git project
443   (#3038)
444
445 ### Output
446
447 - Output Python version and implementation as part of `--version` flag (#2997)
448
449 ### Packaging
450
451 - Use `tomli` instead of `tomllib` on Python 3.11 builds where `tomllib` is not
452   available (#2987)
453
454 ### Parser
455
456 - [PEP 654](https://peps.python.org/pep-0654/#except) syntax (for example,
457   `except *ExceptionGroup:`) is now supported (#3016)
458 - [PEP 646](https://peps.python.org/pep-0646) syntax (for example,
459   `Array[Batch, *Shape]` or `def fn(*args: *T) -> None`) is now supported (#3071)
460
461 ### Vim Plugin
462
463 - Fix `strtobool` function. It didn't parse true/on/false/off. (#3025)
464
465 ## 22.3.0
466
467 ### Preview style
468
469 - Code cell separators `#%%` are now standardised to `# %%` (#2919)
470 - Remove unnecessary parentheses from `except` statements (#2939)
471 - Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945)
472 - Avoid magic-trailing-comma in single-element subscripts (#2942)
473
474 ### Configuration
475
476 - Do not format `__pypackages__` directories by default (#2836)
477 - Add support for specifying stable version with `--required-version` (#2832).
478 - Avoid crashing when the user has no homedir (#2814)
479 - Avoid crashing when md5 is not available (#2905)
480 - Fix handling of directory junctions on Windows (#2904)
481
482 ### Documentation
483
484 - Update pylint config documentation (#2931)
485
486 ### Integrations
487
488 - Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
489
490 ### Output
491
492 - In verbose mode, log when _Black_ is using user-level config (#2861)
493
494 ### Packaging
495
496 - Fix Black to work with Click 8.1.0 (#2966)
497 - On Python 3.11 and newer, use the standard library's `tomllib` instead of `tomli`
498   (#2903)
499 - `black-primer`, the deprecated internal devtool, has been removed and copied to a
500   [separate repository](https://github.com/cooperlees/black-primer) (#2924)
501
502 ### Parser
503
504 - Black can now parse starred expressions in the target of `for` and `async for`
505   statements, e.g `for item in *items_1, *items_2: pass` (#2879).
506
507 ## 22.1.0
508
509 At long last, _Black_ is no longer a beta product! This is the first non-beta release
510 and the first release covered by our new
511 [stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy).
512
513 ### Highlights
514
515 - **Remove Python 2 support** (#2740)
516 - Introduce the `--preview` flag (#2752)
517
518 ### Style
519
520 - Deprecate `--experimental-string-processing` and move the functionality under
521   `--preview` (#2789)
522 - For stubs, one blank line between class attributes and methods is now kept if there's
523   at least one pre-existing blank line (#2736)
524 - Black now normalizes string prefix order (#2297)
525 - Remove spaces around power operators if both operands are simple (#2726)
526 - Work around bug that causes unstable formatting in some cases in the presence of the
527   magic trailing comma (#2807)
528 - Use parentheses for attribute access on decimal float and int literals (#2799)
529 - Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex
530   literals (#2799)
531 - Treat blank lines in stubs the same inside top-level `if` statements (#2820)
532 - Fix unstable formatting with semicolons and arithmetic expressions (#2817)
533 - Fix unstable formatting around magic trailing comma (#2572)
534
535 ### Parser
536
537 - Fix mapping cases that contain as-expressions, like `case {"key": 1 | 2 as password}`
538   (#2686)
539 - Fix cases that contain multiple top-level as-expressions, like `case 1 as a, 2 as b`
540   (#2716)
541 - Fix call patterns that contain as-expressions with keyword arguments, like
542   `case Foo(bar=baz as quux)` (#2749)
543 - Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (#2700)
544 - Unparenthesized tuples on annotated assignments (e.g
545   `values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (#2708)
546 - Fix handling of standalone `match()` or `case()` when there is a trailing newline or a
547   comment inside of the parentheses. (#2760)
548 - `from __future__ import annotations` statement now implies Python 3.7+ (#2690)
549
550 ### Performance
551
552 - Speed-up the new backtracking parser about 4X in general (enabled when
553   `--target-version` is set to 3.10 and higher). (#2728)
554 - _Black_ is now compiled with [mypyc](https://github.com/mypyc/mypyc) for an overall 2x
555   speed-up. 64-bit Windows, MacOS, and Linux (not including musl) are supported. (#1009,
556   #2431)
557
558 ### Configuration
559
560 - Do not accept bare carriage return line endings in pyproject.toml (#2408)
561 - Add configuration option (`python-cell-magics`) to format cells with custom magics in
562   Jupyter Notebooks (#2744)
563 - Allow setting custom cache directory on all platforms with environment variable
564   `BLACK_CACHE_DIR` (#2739).
565 - Enable Python 3.10+ by default, without any extra need to specify
566   `--target-version=py310`. (#2758)
567 - Make passing `SRC` or `--code` mandatory and mutually exclusive (#2804)
568
569 ### Output
570
571 - Improve error message for invalid regular expression (#2678)
572 - Improve error message when parsing fails during AST safety check by embedding the
573   underlying SyntaxError (#2693)
574 - No longer color diff headers white as it's unreadable in light themed terminals
575   (#2691)
576 - Text coloring added in the final statistics (#2712)
577 - Verbose mode also now describes how a project root was discovered and which paths will
578   be formatted. (#2526)
579
580 ### Packaging
581
582 - All upper version bounds on dependencies have been removed (#2718)
583 - `typing-extensions` is no longer a required dependency in Python 3.10+ (#2772)
584 - Set `click` lower bound to `8.0.0` (#2791)
585
586 ### Integrations
587
588 - Update GitHub action to support containerized runs (#2748)
589
590 ### Documentation
591
592 - Change protocol in pip installation instructions to `https://` (#2761)
593 - Change HTML theme to Furo primarily for its responsive design and mobile support
594   (#2793)
595 - Deprecate the `black-primer` tool (#2809)
596 - Document Python support policy (#2819)
597
598 ## 21.12b0
599
600 ### _Black_
601
602 - Fix determination of f-string expression spans (#2654)
603 - Fix bad formatting of error messages about EOF in multi-line statements (#2343)
604 - Functions and classes in blocks now have more consistent surrounding spacing (#2472)
605
606 #### Jupyter Notebook support
607
608 - Cell magics are now only processed if they are known Python cell magics. Earlier, all
609   cell magics were tokenized, leading to possible indentation errors e.g. with
610   `%%writefile`. (#2630)
611 - Fix assignment to environment variables in Jupyter Notebooks (#2642)
612
613 #### Python 3.10 support
614
615 - Point users to using `--target-version py310` if we detect 3.10-only syntax (#2668)
616 - Fix `match` statements with open sequence subjects, like `match a, b:` or
617   `match a, *b:` (#2639) (#2659)
618 - Fix `match`/`case` statements that contain `match`/`case` soft keywords multiple
619   times, like `match re.match()` (#2661)
620 - Fix `case` statements with an inline body (#2665)
621 - Fix styling of starred expressions inside `match` subject (#2667)
622 - Fix parser error location on invalid syntax in a `match` statement (#2649)
623 - Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
624 - Improve parsing performance on code that uses `match` under `--target-version py310`
625   up to ~50% (#2670)
626
627 ### Packaging
628
629 - Remove dependency on `regex` (#2644) (#2663)
630
631 ## 21.11b1
632
633 ### _Black_
634
635 - Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
636
637 ## 21.11b0
638
639 ### _Black_
640
641 - Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
642   detection (#2592)
643 - Add experimental PyPy support (#2559)
644 - Add partial support for the match statement. As it's experimental, it's only enabled
645   when `--target-version py310` is explicitly specified (#2586)
646 - Add support for parenthesized with (#2586)
647 - Declare support for Python 3.10 for running Black (#2562)
648
649 ### Integrations
650
651 - Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
652 - The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (#2613)
653
654 ## 21.10b0
655
656 ### _Black_
657
658 - Document stability policy, that will apply for non-beta releases (#2529)
659 - Add new `--workers` parameter (#2514)
660 - Fixed feature detection for positional-only arguments in lambdas (#2532)
661 - Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
662 - Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
663   even though it has been removed (#2580)
664 - Deprecate Python 2 formatting support (#2523)
665
666 ### _Blackd_
667
668 - Remove dependency on aiohttp-cors (#2500)
669 - Bump required aiohttp version to 3.7.4 (#2509)
670
671 ### _Black-Primer_
672
673 - Add primer support for --projects (#2555)
674 - Print primer summary after individual failures (#2570)
675
676 ### Integrations
677
678 - Allow to pass `target_version` in the vim plugin (#1319)
679 - Install build tools in docker file and use multi-stage build to keep the image size
680   down (#2582)
681
682 ## 21.9b0
683
684 ### Packaging
685
686 - Fix missing modules in self-contained binaries (#2466)
687 - Fix missing toml extra used during installation (#2475)
688
689 ## 21.8b0
690
691 ### _Black_
692
693 - Add support for formatting Jupyter Notebook files (#2357)
694 - Move from `appdirs` dependency to `platformdirs` (#2375)
695 - Present a more user-friendly error if .gitignore is invalid (#2414)
696 - The failsafe for accidentally added backslashes in f-string expressions has been
697   hardened to handle more edge cases during quote normalization (#2437)
698 - Avoid changing a function return type annotation's type to a tuple by adding a
699   trailing comma (#2384)
700 - Parsing support has been added for unparenthesized walruses in set literals, set
701   comprehensions, and indices (#2447).
702 - Pin `setuptools-scm` build-time dependency version (#2457)
703 - Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10
704   (#2460)
705
706 ### _Blackd_
707
708 - Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that
709   scan installed packages (#2440)
710
711 ### Integrations
712
713 - The provided pre-commit hooks no longer specify `language_version` to avoid overriding
714   `default_language_version` (#2430)
715
716 ## 21.7b0
717
718 ### _Black_
719
720 - Configuration files using TOML features higher than spec v0.5.0 are now supported
721   (#2301)
722 - Add primer support and test for code piped into black via STDIN (#2315)
723 - Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (#2332)
724 - Accept empty stdin (#2346)
725 - Provide a more useful error when parsing fails during AST safety checks (#2304)
726
727 ### Docker
728
729 - Add new `latest_release` tag automation to follow latest black release on docker
730   images (#2374)
731
732 ### Integrations
733
734 - The vim plugin now searches upwards from the directory containing the current buffer
735   instead of the current working directory for pyproject.toml. (#1871)
736 - The vim plugin now reads the correct string normalization option in pyproject.toml
737   (#1869)
738 - The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
739   (#1869)
740
741 ## 21.6b0
742
743 ### _Black_
744
745 - Fix failure caused by `fmt: skip` and indentation (#2281)
746 - Account for += assignment when deciding whether to split string (#2312)
747 - Correct max string length calculation when there are string operators (#2292)
748 - Fixed option usage when using the `--code` flag (#2259)
749 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
750 - Added `--required-version` option to require a specific version to be running (#2300)
751 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
752   (#2311)
753 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
754 - Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
755   used (#2319)
756
757 ### Integrations
758
759 - The official Black action now supports choosing what version to use, and supports the
760   major 3 OSes. (#1940)
761
762 ## 21.5b2
763
764 ### _Black_
765
766 - A space is no longer inserted into empty docstrings (#2249)
767 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
768 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
769   `.gitignore` rules like `git` does) (#2225)
770 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
771 - Add extra uvloop install + import support if in python env (#2258)
772 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
773 - Make sure to split lines that start with a string operator (#2286)
774 - Fix regular expression that black uses to identify f-expressions (#2287)
775
776 ### _Blackd_
777
778 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
779   supported. (#2231)
780
781 ### Packaging
782
783 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
784   (#2198)
785 - Always build binaries with the latest available Python (#2260)
786
787 ### Documentation
788
789 - Add discussion of magic comments to FAQ page (#2272)
790 - `--experimental-string-processing` will be enabled by default in the future (#2273)
791 - Fix typos discovered by codespell (#2228)
792 - Fix Vim plugin installation instructions. (#2235)
793 - Add new Frequently Asked Questions page (#2247)
794 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
795
796 ## 21.5b1
797
798 ### _Black_
799
800 - Refactor `src/black/__init__.py` into many files (#2206)
801
802 ### Documentation
803
804 - Replaced all remaining references to the
805   [`master`](https://github.com/psf/black/tree/main) branch with the
806   [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
807   the source code were also made. (#2210)
808 - Sigificantly reorganized the documentation to make much more sense. Check them out by
809   heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
810   (#2174)
811
812 ## 21.5b0
813
814 ### _Black_
815
816 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
817 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
818   being called but with no arguments (#2182)
819
820 ### _Black-Primer_
821
822 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
823
824 ## 21.4b2
825
826 ### _Black_
827
828 - Fix crash if the user configuration directory is inaccessible. (#2158)
829
830 - Clarify
831   [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
832   in which _Black_ may change the AST (#2159)
833
834 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
835   or on the command line. (#2170)
836
837 ### _Packaging_
838
839 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
840
841 ## 21.4b1
842
843 ### _Black_
844
845 - Fix crash on docstrings ending with "\\ ". (#2142)
846
847 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
848
849 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
850   in the name of the cache file. Without this fix, changes in these flags would not take
851   effect if the cache had already been populated. (#2131)
852
853 - Don't remove necessary parentheses from assignment expression containing assert /
854   return statements. (#2143)
855
856 ### _Packaging_
857
858 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
859
860 ## 21.4b0
861
862 ### _Black_
863
864 - Fixed a rare but annoying formatting instability created by the combination of
865   optional trailing commas inserted by `Black` and optional parentheses looking at
866   pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
867   duplicates. (#2126)
868
869 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
870   and adding a padding space when needed to break up """". (#1740)
871
872 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
873
874 - `Black` now respects `--skip-string-normalization` when normalizing multiline
875   docstring quotes (#1637)
876
877 - `Black` no longer removes all empty lines between non-function code and decorators
878   when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
879
880 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
881   in if/while statements (#1655)
882
883 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
884   to split lines (#1824)
885
886 - fixed a crash when PWD=/ on POSIX (#1631)
887
888 - fixed "I/O operation on closed file" when using --diff (#1664)
889
890 - Prevent coloured diff output being interleaved with multiple files (#1673)
891
892 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
893
894 - Added parsing support for unparenthesized tuples and yield expressions in annotated
895   assignments (#1835)
896
897 - added `--extend-exclude` argument (PR #2005)
898
899 - speed up caching by avoiding pathlib (#1950)
900
901 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
902
903 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
904   (#1780)
905
906 - Lines ending with `fmt: skip` will now be not formatted (#1800)
907
908 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
909
910 - PR #2053: Python 2 support is now optional, install with
911   `python3 -m pip install black[python2]` to maintain support.
912
913 - Exclude `venv` directory by default (#1683)
914
915 - Fixed "Black produced code that is not equivalent to the source" when formatting
916   Python 2 docstrings (#2037)
917
918 ### _Packaging_
919
920 - Self-contained native _Black_ binaries are now provided for releases via GitHub
921   Releases (#1743)
922
923 ## 20.8b1
924
925 ### _Packaging_
926
927 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
928   older than 7.0
929
930 ## 20.8b0
931
932 ### _Black_
933
934 - re-implemented support for explicit trailing commas: now it works consistently within
935   any bracket pair, including nested structures (#1288 and duplicates)
936
937 - `Black` now reindents docstrings when reindenting code around it (#1053)
938
939 - `Black` now shows colored diffs (#1266)
940
941 - `Black` is now packaged using 'py3' tagged wheels (#1388)
942
943 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
944   (#1121)
945
946 - `Black` no longer normalizes capital R-string prefixes as those have a
947   community-accepted meaning (#1244)
948
949 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
950
951 - `Black` now works on AWS Lambda (#1141)
952
953 - added `--force-exclude` argument (#1032)
954
955 - removed deprecated `--py36` option (#1236)
956
957 - fixed `--diff` output when EOF is encountered (#526)
958
959 - fixed `# fmt: off` handling around decorators (#560)
960
961 - fixed unstable formatting with some `# type: ignore` comments (#1113)
962
963 - fixed invalid removal on organizing brackets followed by indexing (#1575)
964
965 - introduced `black-primer`, a CI tool that allows us to run regression tests against
966   existing open source users of Black (#1402)
967
968 - introduced property-based fuzzing to our test suite based on Hypothesis and
969   Hypothersmith (#1566)
970
971 - implemented experimental and disabled by default long string rewrapping (#1132),
972   hidden under a `--experimental-string-processing` flag while it's being worked on;
973   this is an undocumented and unsupported feature, you lose Internet points for
974   depending on it (#1609)
975
976 ### Vim plugin
977
978 - prefer virtualenv packages over global packages (#1383)
979
980 ## 19.10b0
981
982 - added support for PEP 572 assignment expressions (#711)
983
984 - added support for PEP 570 positional-only arguments (#943)
985
986 - added support for async generators (#593)
987
988 - added support for pre-splitting collections by putting an explicit trailing comma
989   inside (#826)
990
991 - added `black -c` as a way to format code passed from the command line (#761)
992
993 - --safe now works with Python 2 code (#840)
994
995 - fixed grammar selection for Python 2-specific code (#765)
996
997 - fixed feature detection for trailing commas in function definitions and call sites
998   (#763)
999
1000 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
1001   code now behave correctly (#1005)
1002
1003 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
1004
1005 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
1006
1007 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
1008
1009 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
1010
1011 - _Black_ no longer fails on comments in from-imports (#671)
1012
1013 - _Black_ no longer fails when the file starts with a backslash (#922)
1014
1015 - _Black_ no longer merges regular comments with type comments (#1027)
1016
1017 - _Black_ no longer splits long lines that contain type comments (#997)
1018
1019 - removed unnecessary parentheses around `yield` expressions (#834)
1020
1021 - added parentheses around long tuples in unpacking assignments (#832)
1022
1023 - added parentheses around complex powers when they are prefixed by a unary operator
1024   (#646)
1025
1026 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
1027
1028 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
1029   (#863)
1030
1031 - if _Black_ puts parenthesis around a single expression, it moves comments to the
1032   wrapped expression instead of after the brackets (#872)
1033
1034 - `blackd` now returns the version of _Black_ in the response headers (#1013)
1035
1036 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
1037   provided (#969)
1038
1039 ## 19.3b0
1040
1041 - new option `--target-version` to control which Python versions _Black_-formatted code
1042   should target (#618)
1043
1044 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
1045
1046 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
1047
1048 - long `del` statements are now split into multiple lines (#698)
1049
1050 - type comments are no longer mangled in function signatures
1051
1052 - improved performance of formatting deeply nested data structures (#509)
1053
1054 - _Black_ now properly formats multiple files in parallel on Windows (#632)
1055
1056 - _Black_ now creates cache files atomically which allows it to be used in parallel
1057   pipelines (like `xargs -P8`) (#673)
1058
1059 - _Black_ now correctly indents comments in files that were previously formatted with
1060   tabs (#262)
1061
1062 - `blackd` now supports CORS (#622)
1063
1064 ## 18.9b0
1065
1066 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
1067
1068   - numeric literals are normalized to include `_` separators on Python 3.6+ code
1069
1070   - added `--skip-numeric-underscore-normalization` to disable the above behavior and
1071     leave numeric underscores as they were in the input
1072
1073   - code with `_` in numeric literals is recognized as Python 3.6+
1074
1075   - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
1076
1077   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
1078
1079 - added `blackd`, see
1080   [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
1081   more info (#349)
1082
1083 - adjacent string literals are now correctly split into multiple lines (#463)
1084
1085 - trailing comma is now added to single imports that don't fit on a line (#250)
1086
1087 - cache is now populated when `--check` is successful for a file which speeds up
1088   consecutive checks of properly formatted unmodified files (#448)
1089
1090 - whitespace at the beginning of the file is now removed (#399)
1091
1092 - fixed mangling [pweave](http://mpastell.com/pweave/) and
1093   [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
1094
1095 - fixed unstable formatting when unpacking big tuples (#267)
1096
1097 - fixed parsing of `__future__` imports with renames (#389)
1098
1099 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
1100
1101 - fixed formatting of lambda expressions with default arguments (#468)
1102
1103 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
1104
1105 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
1106   be a bad idea (#415)
1107
1108 ## 18.6b4
1109
1110 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
1111
1112 ## 18.6b3
1113
1114 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
1115
1116 - `# fmt: off` and `# fmt: on` are now much more dependable:
1117
1118   - they now work also within bracket pairs (#329)
1119
1120   - they now correctly work across function/class boundaries (#335)
1121
1122   - they now work when an indentation block starts with empty lines or misaligned
1123     comments (#334)
1124
1125 - made Click not fail on invalid environments; note that Click is right but the
1126   likelihood we'll need to access non-ASCII file paths when dealing with Python source
1127   code is low (#277)
1128
1129 - fixed improper formatting of f-strings with quotes inside interpolated expressions
1130   (#322)
1131
1132 - fixed unnecessary slowdown when long list literals where found in a file
1133
1134 - fixed unnecessary slowdown on AST nodes with very many siblings
1135
1136 - fixed cannibalizing backslashes during string normalization
1137
1138 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
1139
1140 ## 18.6b2
1141
1142 - added `--config` (#65)
1143
1144 - added `-h` equivalent to `--help` (#316)
1145
1146 - fixed improper unmodified file caching when `-S` was used
1147
1148 - fixed extra space in string unpacking (#305)
1149
1150 - fixed formatting of empty triple quoted strings (#313)
1151
1152 - fixed unnecessary slowdown in comment placement calculation on lines without comments
1153
1154 ## 18.6b1
1155
1156 - hotfix: don't output human-facing information on stdout (#299)
1157
1158 - hotfix: don't output cake emoji on non-zero return code (#300)
1159
1160 ## 18.6b0
1161
1162 - added `--include` and `--exclude` (#270)
1163
1164 - added `--skip-string-normalization` (#118)
1165
1166 - added `--verbose` (#283)
1167
1168 - the header output in `--diff` now actually conforms to the unified diff spec
1169
1170 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
1171
1172 - fixed unnecessary parentheses when a line contained multiline strings (#232)
1173
1174 - fixed stdin handling not working correctly if an old version of Click was used (#276)
1175
1176 - _Black_ now preserves line endings when formatting a file in place (#258)
1177
1178 ## 18.5b1
1179
1180 - added `--pyi` (#249)
1181
1182 - added `--py36` (#249)
1183
1184 - Python grammar pickle caches are stored with the formatting caches, making _Black_
1185   work in environments where site-packages is not user-writable (#192)
1186
1187 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
1188   fields) and the first method
1189
1190 - fixed invalid code produced when standalone comments were present in a trailer that
1191   was omitted from line splitting on a large expression (#237)
1192
1193 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
1194
1195 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
1196   in optional parentheses (#234)
1197
1198 - fixed unstable formatting when inline comments were moved around in a trailer that was
1199   omitted from line splitting on a large expression (#238)
1200
1201 - fixed extra empty line between a class declaration and the first method if no class
1202   docstring or fields are present (#219)
1203
1204 - fixed extra empty line between a function signature and an inner function or inner
1205   class (#196)
1206
1207 ## 18.5b0
1208
1209 - call chains are now formatted according to the
1210   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
1211
1212 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
1213   exploded like imports when they don't fit in a single line (#152)
1214
1215 - slices are now formatted according to PEP 8 (#178)
1216
1217 - parentheses are now also managed automatically on the right-hand side of assignments
1218   and return statements (#140)
1219
1220 - math operators now use their respective priorities for delimiting multiline
1221   expressions (#148)
1222
1223 - optional parentheses are now omitted on expressions that start or end with a bracket
1224   and only contain a single operator (#177)
1225
1226 - empty parentheses in a class definition are now removed (#145, #180)
1227
1228 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
1229   only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
1230   #199)
1231
1232 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
1233   484 (#207, #210)
1234
1235 - progress when reformatting many files is now reported incrementally
1236
1237 - fixed trailers (content with brackets) being unnecessarily exploded into their own
1238   lines after a dedented closing bracket (#119)
1239
1240 - fixed an invalid trailing comma sometimes left in imports (#185)
1241
1242 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
1243   used (#183)
1244
1245 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
1246   assignments (#215)
1247
1248 - fixed not splitting long from-imports with only a single name
1249
1250 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
1251   This fixed non-deterministic formatting if trailing commas where used both in function
1252   signatures with stars and function calls with stars but the former would be
1253   reformatted to a single line.
1254
1255 - fixed crash on dealing with optional parentheses (#193)
1256
1257 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
1258   purposes
1259
1260 - fixed crash when dead symlinks where encountered
1261
1262 ## 18.4a4
1263
1264 - don't populate the cache on `--check` (#175)
1265
1266 ## 18.4a3
1267
1268 - added a "cache"; files already reformatted that haven't changed on disk won't be
1269   reformatted again (#109)
1270
1271 - `--check` and `--diff` are no longer mutually exclusive (#149)
1272
1273 - generalized star expression handling, including double stars; this fixes
1274   multiplication making expressions "unsafe" for trailing commas (#132)
1275
1276 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
1277
1278 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
1279
1280 - fixed comment indentation when a standalone comment closes a block (#16, #32)
1281
1282 - fixed standalone comments receiving extra empty lines if immediately preceding a
1283   class, def, or decorator (#56, #154)
1284
1285 - fixed `--diff` not showing entire path (#130)
1286
1287 - fixed parsing of complex expressions after star and double stars in function calls
1288   (#2)
1289
1290 - fixed invalid splitting on comma in lambda arguments (#133)
1291
1292 - fixed missing splits of ternary expressions (#141)
1293
1294 ## 18.4a2
1295
1296 - fixed parsing of unaligned standalone comments (#99, #112)
1297
1298 - fixed placement of dictionary unpacking inside dictionary literals (#111)
1299
1300 - Vim plugin now works on Windows, too
1301
1302 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
1303   (#120)
1304
1305 ## 18.4a1
1306
1307 - added `--quiet` (#78)
1308
1309 - added automatic parentheses management (#4)
1310
1311 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
1312
1313 - fixed reporting on `--check` with multiple files (#101, #102)
1314
1315 - fixed removing backslash escapes from raw strings (#100, #105)
1316
1317 ## 18.4a0
1318
1319 - added `--diff` (#87)
1320
1321 - add line breaks before all delimiters, except in cases like commas, to better comply
1322   with PEP 8 (#73)
1323
1324 - standardize string literals to use double quotes (almost) everywhere (#75)
1325
1326 - fixed handling of standalone comments within nested bracketed expressions; _Black_
1327   will no longer produce super long lines or put all standalone comments at the end of
1328   the expression (#22)
1329
1330 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
1331   (#80)
1332
1333 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
1334   _Black_ to not emit the rest of the file (#95)
1335
1336 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
1337   a flurry of asyncio-related exceptions
1338
1339 - only allow up to two empty lines on module level and only single empty lines within
1340   functions (#74)
1341
1342 ## 18.3a4
1343
1344 - `# fmt: off` and `# fmt: on` are implemented (#5)
1345
1346 - automatic detection of deprecated Python 2 forms of print statements and exec
1347   statements in the formatted file (#49)
1348
1349 - use proper spaces for complex expressions in default values of typed function
1350   arguments (#60)
1351
1352 - only return exit code 1 when --check is used (#50)
1353
1354 - don't remove single trailing commas from square bracket indexing (#59)
1355
1356 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
1357
1358 - omit extra space in kwarg unpacking if it's the first argument (#46)
1359
1360 - omit extra space in
1361   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
1362   (#68)
1363
1364 ## 18.3a3
1365
1366 - don't remove single empty lines outside of bracketed expressions (#19)
1367
1368 - added ability to pipe formatting from stdin to stdin (#25)
1369
1370 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
1371
1372 - even better handling of numpy-style array indexing (#33, again)
1373
1374 ## 18.3a2
1375
1376 - changed positioning of binary operators to occur at beginning of lines instead of at
1377   the end, following
1378   [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
1379   (#21)
1380
1381 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
1382   formattings (#34, #35)
1383
1384 - remove a trailing comma if there is a single argument to a call
1385
1386 - if top level functions were separated by a comment, don't put four empty lines after
1387   the upper function
1388
1389 - fixed unstable formatting of newlines with imports
1390
1391 - fixed unintentional folding of post scriptum standalone comments into last statement
1392   if it was a simple statement (#18, #28)
1393
1394 - fixed missing space in numpy-style array indexing (#33)
1395
1396 - fixed spurious space after star-based unary expressions (#31)
1397
1398 ## 18.3a1
1399
1400 - added `--check`
1401
1402 - only put trailing commas in function signatures and calls if it's safe to do so. If
1403   the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
1404   or `**kwargs` used in the signature or call. (#8)
1405
1406 - fixed invalid spacing of dots in relative imports (#6, #13)
1407
1408 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
1409
1410 - fixed spurious space in parenthesized set expressions (#7)
1411
1412 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
1413
1414 - fixed spurious space after unary operators when the operand was a complex expression
1415   (#15)
1416
1417 ## 18.3a0
1418
1419 - first published version, Happy 🍰 Day 2018!
1420
1421 - alpha quality
1422
1423 - date-versioned (see: <https://calver.org/>)