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

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