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

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