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

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