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

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