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

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