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

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