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

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