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

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