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

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