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

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