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

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