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

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