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

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