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

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