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

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