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

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