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

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