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

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