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

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