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

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