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

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