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

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