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

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