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

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