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

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