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

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