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

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