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

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