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

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