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

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