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

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