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

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