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

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