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

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