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

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