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

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