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

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