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

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