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

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