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

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