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

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