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

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