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

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