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

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