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

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