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

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