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

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