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

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