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

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