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

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