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

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