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

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