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

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