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

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