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

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