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

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