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

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