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

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