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

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