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

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