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

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