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

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