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

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