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

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