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

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