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

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