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

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