Pin black to latest version 24.1.0

[pyup-bot]

This PR pins black to the latest release 24.1.0.

Changelog

24.1.0

Highlights

This release introduces the new 2024 stable style (4106), stabilizing the following
changes:

- Add parentheses around `if`-`else` expressions (2278)
- Dummy class and function implementations consisting only of `...` are formatted more
compactly (3796)
- If an assignment statement is too long, we now prefer splitting on the right-hand side
(3368)
- Hex codes in Unicode escape sequences are now standardized to lowercase (2916)
- Allow empty first lines at the beginning of most blocks (3967, 4061)
- Add parentheses around long type annotations (3899)
- Enforce newline after module docstrings (3932, 4028)
- Fix incorrect magic trailing comma handling in return types (3916)
- Remove blank lines before class docstrings (3692)
- Wrap multiple context managers in parentheses if combined in a single `with` statement
(3489)
- Fix bug in line length calculations for power operations (3942)
- Add trailing commas to collection literals even if there's a comment after the last
entry (3393)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
subscript expressions with more than 1 element (3209)
- Add extra blank lines in stubs in a few cases (3564, 3862)
- Accept raw strings as docstrings (3947)
- Split long lines in case blocks (4024)
- Stop removing spaces from walrus operators within subscripts (3823)
- Fix incorrect formatting of certain async statements (3609)
- Allow combining ` fmt: skip` with other comments (3959)

There are already a few improvements in the `--preview` style, which are slated for the
2025 stable style. Try them out and
[share your feedback](https://github.com/psf/black/issues). In the past, the preview
style has included some features that we were not able to stabilize. This year, we're
adding a separate `--unstable` style for features with known problems. Now, the
`--preview` style only includes features that we actually expect to make it into next
year's stable style.

Stable style

Several bug fixes were made in features that are moved to the stable style in this
release:

- Fix comment handling when parenthesising conditional expressions (4134)
- Fix bug where spaces were not added around parenthesized walruses in subscripts,
unlike other binary operators (4109)
- Remove empty lines before docstrings in async functions (4132)
- Address a missing case in the change to allow empty lines at the beginning of all
blocks, except immediately before a docstring (4130)
- For stubs, fix logic to enforce empty line after nested classes with bodies (4141)

Preview style

- Add `--unstable` style, covering preview features that have known problems that would
block them from going into the stable style. Also add the `--enable-unstable-feature`
flag; for example, use
`--enable-unstable-feature hug_parens_with_braces_and_square_brackets` to apply this
preview feature throughout 2024, even if a later Black release downgrades the feature
to unstable (4096)
- Format module docstrings the same as class and function docstrings (4095)
- Fix crash when using a walrus in a dictionary (4155)
- Fix unnecessary parentheses when wrapping long dicts (4135)
- Stop normalizing spaces before ` fmt: skip` comments (4146)

Configuration

- Print warning when configuration in `pyproject.toml` contains an invalid key (4165)
- Fix symlink handling, properly ignoring symlinks that point outside of root (4161)
- Fix cache mtime logic that resulted in false positive cache hits (4128)
- Remove the long-deprecated `--experimental-string-processing` flag. This feature can
currently be enabled with `--preview --enable-unstable-feature string_processing`.
(4096)

Integrations

- Revert the change to run Black's pre-commit integration only on specific git hooks
(3940) for better compatibility with older versions of pre-commit (4137)

Thank you

Thank you to everyone who provided feedback to help make Black's 2024 style even better. Thank you also to everyone who contributed code to Black.

24.1a1

This is a preview of the 2024 stable style, showing the formatting that Black will use in 2024. Please test it out and [share your feedback](https://github.com/psf/black/issues/4042).

This applies the following changes:

- Multiline strings passed as the sole function arguments are formatted more compactly
(1879)
- Dummy class and function implementations consisting only of `...` are formatted more
compactly (3796)
- If an assignment statement is too long, we now prefer splitting on the right-hand side
(3368)
- Hex codes in Unicode escape sequences are now standardized to lowercase (2916)
- Allow empty first lines at the beginning of most blocks (3967, 4061)
- Add parentheses around long type annotations (3899)
- Standardize on a single newline after module docstrings (3932)
- Fix incorrect magic trailing comma handling in return types (3916)
- Remove blank lines before class docstrings (3692)
- Wrap multiple context managers in parentheses if combined in a single `with` statement
(3489)
- Fix bug in line length calculations for power operations (3942)
- Add trailing commas to collection literals even if there's a comment after the last
entry (3393)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
subscript expressions with more than 1 element (3209)
- Add extra blank lines in stubs in a few cases (3564, 3862)
- Accept raw strings as docstrings (3947)
- Split long lines in case blocks (4024)
- Stop removing spaces from walrus operators within subscripts (3823)
- Fix incorrect formatting of certain async statements (3609)
- Allow combining ` fmt: skip` with other comments (3959)

The following two changes may be included, but have outstanding issues that will need to
be resolved:

- Long values in dict literals are now wrapped in parentheses; correspondingly
unnecessary parentheses around short values in dict literals are now removed; long
string lambda values are now wrapped in parentheses (3440)
- Add parentheses around `if`-`else` expressions (2278)

23.12.1

Fixed a bug that included dependencies from the d extra by default (4108)

23.12.0

Highlights

It's almost 2024, which means it's time for a new edition of _Black_'s stable style!
Together with this release, we'll put out an alpha release 24.1a1 showcasing the draft
2024 stable style, which we'll finalize in the January release. Please try it out and
[share your feedback](https://github.com/psf/black/issues/4042).

This release (23.12.0) will still produce the 2023 style. Most but not all of the
changes in `--preview` mode will be in the 2024 stable style.

Stable style

- Fix bug where ` fmt: off` automatically dedents when used with the `--line-ranges`
option, even when it is not within the specified line range. (4084)
- Fix feature detection for parenthesized context managers (4104)

Preview style

- Prefer more equal signs before a break when splitting chained assignments (4010)
- Standalone form feed characters at the module level are no longer removed (4021)
- Additional cases of immediately nested tuples, lists, and dictionaries are now
indented less (4012)
- Allow empty lines at the beginning of all blocks, except immediately before a
docstring (4060)
- Fix crash in preview mode when using a short `--line-length` (4086)
- Keep suites consisting of only an ellipsis on their own lines if they are not
functions or class definitions (4066) (4103)

Configuration

- `--line-ranges` now skips _Black_'s internal stability check in `--safe` mode. This
avoids a crash on rare inputs that have many unformatted same-content lines. (4034)

Packaging

- Upgrade to mypy 1.7.1 (4049) (4069)
- Faster compiled wheels are now available for CPython 3.12 (4070)

Integrations

- Enable 3.12 CI (4035)
- Build docker images in parallel (4054)
- Build docker images with 3.12 (4055)

23.11.0

Highlights

- Support formatting ranges of lines with the new `--line-ranges` command-line option
(4020)

Stable style

- Fix crash on formatting bytes strings that look like docstrings (4003)
- Fix crash when whitespace followed a backslash before newline in a docstring (4008)
- Fix standalone comments inside complex blocks crashing Black (4016)
- Fix crash on formatting code like `await (a ** b)` (3994)
- No longer treat leading f-strings as docstrings. This matches Python's behaviour and
fixes a crash (4019)

Preview style

- Multiline dicts and lists that are the sole argument to a function are now
indented less (3964)
- Multiline unpacked dicts and lists as the sole argument to a function are now also
indented less (3992)
- In f-string debug expressions, quote types that are visible in the final string
are now preserved (4005)
- Fix a bug where long `case` blocks were not split into multiple lines. Also enable
general trailing comma rules on `case` blocks (4024)
- Keep requiring two empty lines between module-level docstring and first function or
class definition (4028)
- Add support for single-line format skip with other comments on the same line (3959)

Configuration

- Consistently apply force exclusion logic before resolving symlinks (4015)
- Fix a bug in the matching of absolute path names in `--include` (3976)

Performance

- Fix mypyc builds on arm64 on macOS (4017)

Integrations

- Black's pre-commit integration will now run only on git hooks appropriate for a code
formatter (3940)

23.10.1

Highlights

- Maintanence release to get a fix out for GitHub Action edge case (3957)

Preview style

- Fix merging implicit multiline strings that have inline comments (3956)
- Allow empty first line after block open before a comment or compound statement (3967)

Packaging

- Change Dockerfile to hatch + compile black (3965)

Integrations

- The summary output for GitHub workflows is now suppressible using the `summary`
parameter. (3958)
- Fix the action failing when Black check doesn't pass (3957)

Documentation

- It is known Windows documentation CI is broken
https://github.com/psf/black/issues/3968

23.10.0

Stable style

- Fix comments getting removed from inside parenthesized strings (3909)

Preview style

- Fix long lines with power operators getting split before the line length (3942)
- Long type hints are now wrapped in parentheses and properly indented when split across
multiple lines (3899)
- Magic trailing commas are now respected in return types. (3916)
- Require one empty line after module-level docstrings. (3932)
- Treat raw triple-quoted strings as docstrings (3947)

Configuration

- Fix cache versioning logic when `BLACK_CACHE_DIR` is set (3937)

Parser

- Fix bug where attributes named `type` were not acccepted inside `match` statements
(3950)
- Add support for PEP 695 type aliases containing lambdas and other unusual expressions
(3949)

Output

- Black no longer attempts to provide special errors for attempting to format Python 2
code (3933)
- Black will more consistently print stacktraces on internal errors in verbose mode
(3938)

Integrations

- The action output displayed in the job summary is now wrapped in Markdown (3914)

23.9.1

Due to various issues, the previous release (23.9.0) did not include compiled mypyc
wheels, which make Black significantly faster. These issues have now been fixed, and
this release should come with compiled wheels once again.

There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12
wheels in a future release as soon as the mypyc bug is fixed.

Packaging

- Upgrade to mypy 1.5.1 (3864)

Performance

- Store raw tuples instead of NamedTuples in Black's cache, improving performance and
decreasing the size of the cache (3877)

23.9.0

Preview style

- More concise formatting for dummy implementations (3796)
- In stub files, add a blank line between a statement with a body (e.g an
`if sys.version_info > (3, x):`) and a function definition on the same level (3862)
- Fix a bug whereby spaces were removed from walrus operators within subscript(3823)

Configuration

- Black now applies exclusion and ignore logic before resolving symlinks (3846)

Performance

- Avoid importing `IPython` if notebook cells do not contain magics (3782)
- Improve caching by comparing file hashes as fallback for mtime and size (3821)

_Blackd_

- Fix an issue in `blackd` with single character input (3558)

Integrations

- Black now has an
[official pre-commit mirror](https://github.com/psf/black-pre-commit-mirror). Swapping
`https://github.com/psf/black` to `https://github.com/psf/black-pre-commit-mirror` in
your `.pre-commit-config.yaml` will make Black about 2x faster (3828)
- The `.black.env` folder specified by `ENV_PATH` will now be removed on the completion
of the GitHub Action (3759)

23.7.0

Highlights

- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
supported until further notice (3765)

Stable style

- Fix a bug where an illegal trailing comma was added to return type annotations using
PEP 604 unions (3735)
- Fix several bugs and crashes where comments in stub files were removed or mishandled
under some circumstances (3745)
- Fix a crash with multi-line magic comments like `type: ignore` within parentheses
(3740)
- Fix error in AST validation when _Black_ removes trailing whitespace in a type comment
(3773)

Preview style

- Implicitly concatenated strings used as function args are no longer wrapped inside
parentheses (3640)
- Remove blank lines between a class definition and its docstring (3692)

Configuration

- The `--workers` argument to _Black_ can now be specified via the `BLACK_NUM_WORKERS`
environment variable (3743)
- `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (3691)
- Fix _Black_ not honouring `pyproject.toml` settings when running `--stdin-filename`
and the `pyproject.toml` found isn't in the current working directory (3719)
- _Black_ will now error if `exclude` and `extend-exclude` have invalid data types in
`pyproject.toml`, instead of silently doing the wrong thing (3764)

Packaging

- Upgrade mypyc from 0.991 to 1.3 (3697)
- Remove patching of Click that mitigated errors on Python 3.6 with `LANG=C` (3768)

Parser

- Add support for the new PEP 695 syntax in Python 3.12 (3703)

Performance

- Speed up _Black_ significantly when the cache is full (3751)
- Avoid importing `IPython` in a case where we wouldn't need it (3748)

Output

- Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (3728)
- Change verbose logging to exactly mirror _Black_'s logic for source discovery (3749)

_Blackd_

- The `blackd` argument parser now shows the default values for options in their help
text (3712)

Integrations

- Black is now tested with
[`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning)
(3763)
- Update GitHub Action to display black output in the job summary (3688)

Documentation

- Add a CITATION.cff file to the root of the repository, containing metadata on how to
cite this software (3723)
- Update the _classes_ and _exceptions_ documentation in Developer reference to match
the latest code base (3755)

23.3.0

Highlights

This release fixes a longstanding confusing behavior in Black's GitHub action, where the
version of the action did not determine the version of Black being run (issue 3382). In
addition, there is a small bug fix around imports and a number of improvements to the
preview style.

Please try out the
[preview style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html#preview-style)
with `black --preview` and tell us your feedback. All changes in the preview style are
expected to become part of Black's stable style in January 2024.

Stable style

- Import lines with ` fmt: skip` and ` fmt: off` no longer have an extra blank line
added when they are right after another import line (3610)

Preview style

- Add trailing commas to collection literals even if there's a comment after the last
entry (3393)
- `async def`, `async for`, and `async with` statements are now formatted consistently
compared to their non-async version. (3609)
- `with` statements that contain two context managers will be consistently wrapped in
parentheses (3589)
- Let string splitters respect [East Asian Width](https://www.unicode.org/reports/tr11/)
(3445)
- Now long string literals can be split after East Asian commas and periods (`、` U+3001
IDEOGRAPHIC COMMA, `。` U+3002 IDEOGRAPHIC FULL STOP, & `，` U+FF0C FULLWIDTH COMMA)
besides before spaces (3445)
- For stubs, enforce one blank line after a nested class with a body other than just
`...` (3564)
- Improve handling of multiline strings by changing line split behavior (1879)

Parser

- Added support for formatting files with invalid type comments (3594)

Integrations

- Update GitHub Action to use the version of Black equivalent to action's version if
version input is not specified (3543)
- Fix missing Python binary path in autoload script for vim (3508)

Documentation

- Document that only the most recent release is supported for security issues;
vulnerabilities should be reported through Tidelift (3612)

23.1.0

Highlights

This is the first release of 2023, and following our [stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy), it comes with a number of improvements to our stable style, notably improvements to empty line handling and the removal of redundant parentheses in several contexts.

There are also many changes to the preview style; try out `black --preview` and give us feedback to help us set the stable style for next year.

In addition to style changes, Black now automatically infers the supported Python versions from your `pyproject.toml` file, removing the need to set Black's target versions separately.

Stable style

<!-- Changes that affect Black's stable style -->

- Introduce the 2023 stable style, which incorporates most aspects of last year's preview style (3418). Specific changes:
- Enforce empty lines before classes and functions with sticky leading comments (3302) (22.12.0)
- Reformat empty and whitespace-only files as either an empty file (if no newline is present) or as a single newline character (if a newline is present) (3348) (22.12.0)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (3370) (22.12.0)
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being normalized as expected (3168) (since 22.8.0)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from subscript expressions with more than 1 element (3209) (22.8.0)
- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (3227) (22.8.0)
- Docstring quotes are no longer moved if it would violate the line length limit (3044, 3430) (22.6.0)
- Parentheses around return annotations are now managed (2990) (22.6.0)
- Remove unnecessary parentheses around awaited objects (2991) (22.6.0)
- Remove unnecessary parentheses in `with` statements (2926) (22.6.0)
- Remove trailing newlines after code block open (3035) (22.6.0)
- Code cell separators `%%` are now standardised to ` %%` (2919) (22.3.0)
- Remove unnecessary parentheses from `except` statements (2939) (22.3.0)
- Remove unnecessary parentheses from tuple unpacking in `for` loops (2945) (22.3.0)
- Avoid magic-trailing-comma in single-element subscripts (2942) (22.3.0)
- Fix a crash when a colon line is marked between ` fmt: off` and ` fmt: on` (3439)

Preview style

<!-- Changes that affect Black's preview style -->

- Format hex codes in unicode escape sequences in string literals (2916)
- Add parentheses around `if`-`else` expressions (2278)
- Improve performance on large expressions that contain many strings (3467)
- Fix a crash in preview style with assert + parenthesized string (3415)
- Fix crashes in preview style with walrus operators used in function return annotations and except clauses (3423)
- Fix a crash in preview advanced string processing where mixed implicitly concatenated regular and f-strings start with an empty span (3463)
- Fix a crash in preview advanced string processing where a standalone comment is placed before a dict's value (3469)
- Fix an issue where extra empty lines are added when a decorator has ` fmt: skip` applied or there is a standalone comment between decorators (3470)
- Do not put the closing quotes in a docstring on a separate line, even if the line is too long (3430)
- Long values in dict literals are now wrapped in parentheses; correspondingly unnecessary parentheses around short values in dict literals are now removed; long string lambda values are now wrapped in parentheses (3440)
- Fix two crashes in preview style involving edge cases with docstrings (3451)
- Exclude string type annotations from improved string processing; fix crash when the return type annotation is stringified and spans across multiple lines (3462)
- Wrap multiple context managers in parentheses when targeting Python 3.9+ (3489)
- Fix several crashes in preview style with walrus operators used in `with` statements or tuples (3473)
- Fix an invalid quote escaping bug in f-string expressions where it produced invalid code. Implicitly concatenated f-strings with different quotes can now be merged or quote-normalized by changing the quotes used in expressions. (3509)
- Fix crash on `await (yield)` when Black is compiled with mypyc (3533)

Configuration

<!-- Changes to how Black can be configured -->

- Black now tries to infer its `--target-version` from the project metadata specified in `pyproject.toml` (3219)

Packaging

<!-- Changes to how Black is packaged, such as dependency requirements -->

- Upgrade mypyc from `0.971` to `0.991` so mypycified _Black_ can be built on armv7 (3380)
- This also fixes some crashes while using compiled Black with a debug build of CPython
- Drop specific support for the `tomli` requirement on 3.11 alpha releases, working around a bug that would cause the requirement not to be installed on any non-final Python releases (3448)
- Black now depends on `packaging` version `22.0` or later. This is required for new functionality that needs to parse part of the project metadata (3219)

Output

<!-- Changes to Black's terminal output and error messages -->

- Calling `black --help` multiple times will return the same help contents each time (3516)
- Verbose logging now shows the values of `pyproject.toml` configuration variables (3392)
- Fix false symlink detection messages in verbose output due to using an incorrect relative path to the project root (3385)

Integrations

<!-- For example, Docker, GitHub Actions, pre-commit, editors -->

- Move 3.11 CI to normal flow now that all dependencies support 3.11 (3446)
- Docker: Add new `latest_prerelease` tag automation to follow latest black alpha release on docker images (3465)

Documentation

<!-- Major changes to documentation and policies. Small docs changes
  don't need a changelog entry. -->

- Expand `vim-plug` installation instructions to offer more explicit options (3468)

23.1a1

This release provides a preview of Black's 2023 stable style. Black's default formatting style includes the following changes:

- Enforce empty lines before classes and functions with sticky leading comments
(3302) (22.12.0)
- Reformat empty and whitespace-only files as either an empty file (if no newline is
present) or as a single newline character (if a newline is present) (3348)
(22.12.0)
- Implicitly concatenated strings used as function args are now wrapped inside
parentheses (3307) (22.12.0)
- Correctly handle trailing commas that are inside a line's leading non-nested parens
(3370) (22.12.0)
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
normalized as expected (3168) (since 22.8.0)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
subscript expressions with more than 1 element (3209) (22.8.0)
- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
parentheses (3162) (22.8.0)
- Fix a string merging/split issue when a comment is present in the middle of
implicitly concatenated strings on its own line (3227) (22.8.0)
- Docstring quotes are no longer moved if it would violate the line length limit
(3044, 3430) (22.6.0)
- Parentheses around return annotations are now managed (2990) (22.6.0)
- Remove unnecessary parentheses around awaited objects (2991) (22.6.0)
- Remove unnecessary parentheses in `with` statements (2926) (22.6.0)
- Remove trailing newlines after code block open (3035) (22.6.0)
- Code cell separators `%%` are now standardised to ` %%` (2919) (22.3.0)
- Remove unnecessary parentheses from `except` statements (2939) (22.3.0)
- Remove unnecessary parentheses from tuple unpacking in `for` loops (2945) (22.3.0)
- Avoid magic-trailing-comma in single-element subscripts (2942) (22.3.0)

Please try it out and give feedback here: https://github.com/psf/black/issues/3407

A stable 23.1.0 release will follow in January 2023.

22.12.0

Preview style

<!-- Changes that affect Black's preview style -->

- Enforce empty lines before classes and functions with sticky leading comments (3302)
- Reformat empty and whitespace-only files as either an empty file (if no newline is
present) or as a single newline character (if a newline is present) (3348)
- Implicitly concatenated strings used as function args are now wrapped inside
parentheses (3307)
- Correctly handle trailing commas that are inside a line's leading non-nested parens
(3370)

Configuration

<!-- Changes to how Black can be configured -->

- Fix incorrectly applied `.gitignore` rules by considering the `.gitignore` location
and the relative path to the target file (3338)
- Fix incorrectly ignoring `.gitignore` presence when more than one source directory is
specified (3336)

Parser

<!-- Changes to the parser or to version autodetection -->

- Parsing support has been added for walruses inside generator expression that are
passed as function args (for example,
`any(match := my_re.match(text) for text in texts)`) (3327).

Integrations

<!-- For example, Docker, GitHub Actions, pre-commit, editors -->

- Vim plugin: Optionally allow using the system installation of Black via
`let g:black_use_virtualenv = 0`(3309)

22.10.0

Highlights

- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
supported until further notice.

Stable style

- Fix a crash when ` fmt: on` is used on a different block level than ` fmt: off`
(3281)

Preview style

- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
(3262)

Configuration

- `.ipynb_checkpoints` directories are now excluded by default (3293)
- Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
while formatting (3299)

Packaging

- Executables made with PyInstaller will no longer crash when formatting several files
at once on macOS. Native x86-64 executables for macOS are available once again.
(3275)
- Hatchling is now used as the build backend. This will not have any effect for users
who install Black with its wheels from PyPI. (3233)
- Faster compiled wheels are now available for CPython 3.11 (3276)

_Blackd_

- Windows style (CRLF) newlines will be preserved (3257).

Integrations

- Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (3246)
- Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
option (3282)
- Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
version (3265)

22.8.0

Highlights

- Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as of publishing (3234)
- This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6 code will continue to be supported until further notice)
- Reword the stability policy to say that we may, in rare cases, make changes that affect code that was not previously formatted by _Black_ (3155)

Stable style

- Fix an infinite loop when using ` fmt: on/off` in the middle of an expression or code block (3158)
- Fix incorrect handling of ` fmt: skip` on colon (`:`) lines (3148)
- Comments are no longer deleted when a line had spaces removed around power operators (2874)

Preview style

- Single-character closing docstring quotes are no longer moved to their own line as this is invalid. This was a bug introduced in version 22.6.0. (3166)
- `--skip-string-normalization` / `-S` now prevents docstring prefixes from being normalized as expected (3168)
- When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from subscript expressions with more than 1 element (3209)
- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside parentheses (3162)
- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (3227)

_Blackd_

- `blackd` now supports enabling the preview style via the `X-Preview` header (3217)

Configuration

- Black now uses the presence of debug f-strings to detect target version (3215)
- Fix misdetection of project root and verbose logging of sources in cases involving `--stdin-filename` (3216)
- Immediate `.gitignore` files in source directories given on the command line are now also respected, previously only `.gitignore` files in the project root and automatically discovered directories were respected (3237)

Documentation

- Recommend using BlackConnect in IntelliJ IDEs (3150)

Integrations

- Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (3194)
- Docker: changed to a /opt/venv installation + added to PATH to be available to non-root users (3202)

Output

- Change from deprecated `asyncio.get_event_loop()` to create our event loop which removes DeprecationWarning (3164)
- Remove logging from internal `blib2to3` library since it regularly emits error logs about failed caching that can and should be ignored (3193)

Parser

- Type comments are now included in the AST equivalence check consistently so accidental deletion raises an error. Though type comments can't be tracked when running on PyPy 3.7 due to standard library limitations. (2874)

Performance

- Reduce Black's startup time when formatting a single file by 15-30% (3211)

**Full Changelog**: https://github.com/psf/black/compare/22.6.0...22.8.0

---

**Thank you!**

- hauntsaninja for modernizing our type annotations and fixing a few bugs too 
- yilei for fixing our ` fmt: off/on/skip` code and continuing to improve the preview style, notably the (still) experimental string processing
- The many community contributions to the non-core parts of the project:
- tobast for improving the QOL of the Vim plugin by simply appending `Black: ` to most emitted messages 
- Mogost for adding preview style support to `blackd` (finally :tada:)
- n-borges for improving the Docker image 
- ionite34 for removing a hack in the official Black GitHub Action's start up code
- cooperlees for adding support for Python 3.11 and addressing DeprecationWarnings
- graingert for adding PyPy 3.8 to our CI matrix so we know Black works in even more places
- martinResearch for contributing a simple fix for such a silly and stupid `.gitignore` bug that we should've caught many moons ago
- fabioz for contributing the original patch that reduced the start up overhead when formatting a single file by 15-30% (!)

... and everyone else who contributed documentation, tests, or other improvements to the Black project!

Finally congratulations to the first time contributors this time around!

* dmerejkowsky made their first contribution in https://github.com/psf/black/pull/3142
* m-aciek made their first contribution in https://github.com/psf/black/pull/3150
* Panther-12 made their first contribution in https://github.com/psf/black/pull/3167
* onescriptkid made their first contribution in https://github.com/psf/black/pull/3170
* tobast made their first contribution in https://github.com/psf/black/pull/3194
* n-borges made their first contribution in https://github.com/psf/black/pull/3202
* Mogost made their first contribution in https://github.com/psf/black/pull/3217
* ionite34 made their first contribution in https://github.com/psf/black/pull/3226
* martinResearch made their first contribution in https://github.com/psf/black/pull/3237

22.6.0

Style

- Fix unstable formatting involving `fmt: skip` and ` fmt:skip` comments (notice the lack of spaces) (2970)

Preview style

- Docstring quotes are no longer moved if it would violate the line length limit (3044)
- Parentheses around return annotations are now managed (2990)
- Remove unnecessary parentheses around awaited objects (2991)
- Remove unnecessary parentheses in `with` statements (2926)
- Remove trailing newlines after code block open (3035)

Integrations

- Add `scripts/migrate-black.py` script to ease introduction of Black to a Git project (3038)

Output

- Output Python version and implementation as part of `--version` flag (2997)

Packaging

- Use `tomli` instead of `tomllib` on Python 3.11 builds where `tomllib` is not available (2987)

Parser

- [PEP 654](https://peps.python.org/pep-0654/#except) syntax (for example, `except *ExceptionGroup:`) is now supported (3016)
- [PEP 646](https://peps.python.org/pep-0646) syntax (for example, `Array[Batch, *Shape]` or `def fn(*args: *T) -> None`) is now supported (#3071)

Vim Plugin

- Fix `strtobool` function. It didn't parse true/on/false/off. (3025)

**Full Changelog**: https://github.com/psf/black/compare/22.3.0...22.6.0

---

**Thank you!**

- jpy-git for improving our parentheses formatting significantly
- siuryan for fixing a fmt: skip bug, making it a little less annoying to use :)
- isidentical for implementing support for PEP 654 and 646 syntax
- defntvdm for fixing our vim plugin, especially as we (the maintainers) don't really know vim script sadly
- idorrington92 for fixing the docstring bug where Black would move the closing quotes causing it to violate the line length limit (whoops!)
- hbrunn for contributing the migrate-black script
- saroad2 for improving newline handling after code blocks and test infrastructure improvements

... and everyone else who contributed documentation, tests, or other improvements to the Black project!

Finally congrats to first contributors!

* kolibril13 made their first contribution in https://github.com/psf/black/pull/2982
* siuryan made their first contribution in https://github.com/psf/black/pull/2970
* dignissimus made their first contribution in https://github.com/psf/black/pull/3007
* JiriKr made their first contribution in https://github.com/psf/black/pull/3023
* defntvdm made their first contribution in https://github.com/psf/black/pull/3025
* naveensrinivasan made their first contribution in https://github.com/psf/black/pull/3043
* idorrington92 made their first contribution in https://github.com/psf/black/pull/3044
* laundmo made their first contribution in https://github.com/psf/black/pull/3063
* ysk24ok made their first contribution in https://github.com/psf/black/pull/3070
* hbrunn made their first contribution in https://github.com/psf/black/pull/3038
* vivekvashist made their first contribution in https://github.com/psf/black/pull/3096
* nateprewitt made their first contribution in https://github.com/psf/black/pull/3125
* yilei made their first contribution in https://github.com/psf/black/pull/3135

22.3.0

Preview style

- Code cell separators `%%` are now standardised to ` %%` (2919)
- Remove unnecessary parentheses from `except` statements (2939)
- Remove unnecessary parentheses from tuple unpacking in `for` loops (2945)
- Avoid magic-trailing-comma in single-element subscripts (2942)

Configuration

- Do not format `__pypackages__` directories by default (2836)
- Add support for specifying stable version with `--required-version` (2832).
- Avoid crashing when the user has no homedir (2814)
- Avoid crashing when md5 is not available (2905)
- Fix handling of directory junctions on Windows (2904)

Documentation

- Update pylint config documentation (2931)

Integrations

- Move test to disable plugin in Vim/Neovim, which speeds up loading (2896)

Output

- In verbose, mode, log when _Black_ is using user-level config (2861)

Packaging

- Fix Black to work with Click 8.1.0 (2966)
- On Python 3.11 and newer, use the standard library's `tomllib` instead of `tomli`
(2903)
- `black-primer`, the deprecated internal devtool, has been removed and copied to a
[separate repository](https://github.com/cooperlees/black-primer) (#2924)

Parser

- Black can now parse starred expressions in the target of `for` and `async for`
statements, e.g `for item in *items_1, *items_2: pass` (2879).

22.1.0

At long last, Black is no longer a beta product! This is the first non-beta release and the first release covered by our [new stability policy](https://black.readthedocs.io/en/latest/the_black_code_style/index.html#stability-policy).

Highlights
- Remove Python 2 support (2740)
- Introduce the `--preview` flag (2752)

Style
- Deprecate `--experimental-string-processing` and move the functionality under `--preview` (2789)
- For stubs, one blank line between class attributes and methods is now kept if there's at least one pre-existing blank line (2736)
- Black now normalizes string prefix order (2297)
- Remove spaces around power operators if both operands are simple (2726)
- Work around bug that causes unstable formatting in some cases in the presence of the magic trailing comma (2807)
- Use parentheses for attribute access on decimal float and int literals (2799)
- Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex literals (2799)
- Treat blank lines in stubs the same inside top-level if statements (2820)
- Fix unstable formatting with semicolons and arithmetic expressions (2817)
- Fix unstable formatting around magic trailing comma (2572)

Parser
- Fix mapping cases that contain as-expressions, like `case {"key": 1 | 2 as password}` (2686)
- Fix cases that contain multiple top-level as-expressions, like `case 1 as a, 2 as b` (2716)
- Fix call patterns that contain as-expressions with keyword arguments, like `case Foo(bar=baz as quux)` (2749)
- Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (2700)
- Unparenthesized tuples on annotated assignments (e.g `values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (2708)
- Fix handling of standalone `match()` or `case()` when there is a trailing newline or a comment inside of the parentheses. (2760)
- `from __future__ import annotations` statement now implies Python 3.7+ (2690)

Performance
- Speed-up the new backtracking parser about 4X in general (enabled when `--target-version` is set to 3.10 and higher). (2728)
- Black is now compiled with mypyc for an overall 2x speed-up. 64-bit Windows, MacOS, and Linux (not including musl) are supported. (1009, 2431)

Configuration
- Do not accept bare carriage return line endings in pyproject.toml (2408)
- Add configuration option (`python-cell-magics`) to format cells with custom magics in Jupyter Notebooks (2744)
- Allow setting custom cache directory on all platforms with environment variable `BLACK_CACHE_DIR` (2739).
- Enable Python 3.10+ by default, without any extra need to specify -`-target-version=py310`. (2758)
- Make passing `SRC` or `--code` mandatory and mutually exclusive (2804)

Output
- Improve error message for invalid regular expression (2678)
- Improve error message when parsing fails during AST safety check by embedding the underlying SyntaxError (2693)
- No longer color diff headers white as it's unreadable in light themed terminals (2691)
- Text coloring added in the final statistics (2712)
- Verbose mode also now describes how a project root was discovered and which paths will be formatted. (2526)

Packaging
- All upper version bounds on dependencies have been removed (2718)
- `typing-extensions` is no longer a required dependency in Python 3.10+ (2772)
- Set `click` lower bound to `8.0.0` as _Black_ crashes on `7.1.2` (2791)

Integrations
- Update GitHub action to support containerized runs (2748)

Documentation
- Change protocol in pip installation instructions to `https://` (#2761)
- Change HTML theme to Furo primarily for its responsive design and mobile support (2793)
- Deprecate the `black-primer` tool (2809)
- Document Python support policy (2819)

**Full Changelog**: https://github.com/psf/black/compare/21.12b0...22.1.0

---

Thank you!

- isidentical for their continued work on making our Python 3.10 support better than ever (we made them a co-maintainer :tada:) 
- hauntsaninja for their help improving our stub style
- nipunn1313 making Black more stable (which has been a long running battle)
- .. and all of my fellow co-maintainers who have made working on this project a wonderful ride JelleZijlstra cooperlees felix-hilden ambv zsol 

And also congrats to first contributors!

* mwtoews made their first contribution in https://github.com/psf/black/pull/2701
* gunungpw made their first contribution in https://github.com/psf/black/pull/2733
* joshowen made their first contribution in https://github.com/psf/black/pull/2748
* Shivansh-007 made their first contribution in https://github.com/psf/black/pull/2526
* cbows made their first contribution in https://github.com/psf/black/pull/2761
* jlazar17 made their first contribution in https://github.com/psf/black/pull/2765
* VanSHOE made their first contribution in https://github.com/psf/black/pull/2712
* emfdavid made their first contribution in https://github.com/psf/black/pull/2786
* mgmarino made their first contribution in https://github.com/psf/black/pull/2744
* RHammond2 made their first contribution in https://github.com/psf/black/pull/2792
* percurnicus made their first contribution in https://github.com/psf/black/pull/2739
* sobolevn made their first contribution in https://github.com/psf/black/pull/2802

21.12b0

_Black_

- Fix determination of f-string expression spans (2654)
- Fix bad formatting of error messages about EOF in multi-line statements (2343)
- Functions and classes in blocks now have more consistent surrounding spacing (2472)

Jupyter Notebook support

- Cell magics are now only processed if they are known Python cell magics. Earlier, all cell magics were tokenized, leading to possible indentation errors e.g. with `%%writefile`. (2630)
- Fix assignment to environment variables in Jupyter Notebooks (2642)

Python 3.10 support

- Point users to using `--target-version py310` if we detect 3.10-only syntax (2668)
- Fix `match` statements with open sequence subjects, like `match a, b:` or `match a, *b:` (2639) (2659)
- Fix `match`/`case` statements that contain `match`/`case` soft keywords multiple times, like `match re.match()` (2661)
- Fix `case` statements with an inline body (2665)
- Fix styling of starred expressions inside `match` subject (2667)
- Fix parser error location on invalid syntax in a `match` statement (2649)
- Fix Python 3.10 support on platforms without ProcessPoolExecutor (2631)
- Improve parsing performance on code that uses `match` under `--target-version py310` up to ~50% (2670)

Packaging

- Remove dependency on `regex` (2644) (2663)

---

Thank you!

* isidentical for the polishing up 3.10 syntax support (which they contributed in the first place!)
* MarcoGorelli for their ever-continuing work on Black's jupyter support
* jalaziz for cleaning up our Pyinstaller CD workflow
* hauntsaninja for helping us drop the `regex` dependency

And also congrats to first contributors!

* MatthewScholefield made their first contribution in https://github.com/psf/black/pull/2631
* AshIsbitt made their first contribution in https://github.com/psf/black/pull/2632
* kalbasit made their first contribution in https://github.com/psf/black/pull/2638
* danieleades made their first contribution in https://github.com/psf/black/pull/2653
* danielsparing made their first contribution in https://github.com/psf/black/pull/2630
* tanvimoharir made their first contribution in https://github.com/psf/black/pull/2343

21.11b1

_Black_

- Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (2621)

21.11b0

_Black_

- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
detection (2592)
- Add experimental PyPy support (2559)
- Add partial support for the match statement. As it's experimental, it's only enabled
when `--target-version py310` is explicitly specified (2586)
- Add support for parenthesized with (2586)
- Declare support for Python 3.10 for running Black (2562)

Integrations

- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (2610)
- The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (2613)

21.10b0

_Black_

- Document stability policy, that will apply for non-beta releases (2529)
- Add new `--workers` parameter (2514)
- Fixed feature detection for positional-only arguments in lambdas (2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
even though it has been removed (2580)
- Deprecate Python 2 formatting support (2523)

_Blackd_

- Remove dependency on aiohttp-cors (2500)
- Bump required aiohttp version to 3.7.4 (2509)

_Black-Primer_

- Add primer support for --projects (2555)
- Print primer summary after individual failures (2570)

Integrations

- Allow to pass `target_version` in the vim plugin (1319)
- Install build tools in docker file and use multi-stage build to keep the image size
down (2582)

21.9b0

Packaging

- Fix missing modules in self-contained binaries (2466)
- Fix missing toml extra used during installation (2475)

21.8b0

_Black_

- Add support for formatting Jupyter Notebook files (2357)
- Move from `appdirs` dependency to `platformdirs` (2375)
- Present a more user-friendly error if .gitignore is invalid (2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (2447).
- Pin `setuptools-scm` build-time dependency version (2457)
- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (2460)

_Blackd_

- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (2440)

Integrations

- The provided pre-commit hooks no longer specify `language_version` to avoid overriding `default_language_version` (2430)

21.7b0

_Black_

- Configuration files using TOML features higher than spec v0.5.0 are now supported
(2301)
- Add primer support and test for code piped into black via STDIN (2315)
- Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (2332)
- Accept empty stdin (2346)
- Provide a more useful error when parsing fails during AST safety checks (2304)

Docker

- Add new `latest_release` tag automation to follow latest black release on docker
images (2374)

Integrations

- The vim plugin now searches upwards from the directory containing the current buffer
instead of the current working directory for pyproject.toml. (1871)
- The vim plugin now reads the correct string normalization option in pyproject.toml
(1869)
- The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
(1869)

21.6b0

_Black_

- Fix failure caused by `fmt: skip` and indentation (2281)
- Account for += assignment when deciding whether to split string (2312)
- Correct max string length calculation when there are string operators (2292)
- Fixed option usage when using the `--code` flag (2259)
- Do not call `uvloop.install()` when _Black_ is used as a library (2303)
- Added `--required-version` option to require a specific version to be running (2300)
- Fix incorrect custom breakpoint indices when string group contains fake f-strings
(2311)
- Fix regression where `R` prefixes would be lowercased for docstrings (2285)
- Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
used (2319)

21.5b2

_Black_

- A space is no longer inserted into empty docstrings (2249)
- Fix handling of .gitignore files containing non-ASCII characters on Windows (2229)
- Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
`.gitignore` rules like `git` does) (2225)
- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (2227)
- Add extra uvloop install + import support if in python env (2258)
- Fix --experimental-string-processing crash when matching parens are not found (2283)
- Make sure to split lines that start with a string operator (2286)
- Fix regular expression that black uses to identify f-expressions (2287)

_Blackd_

- Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
supported. (2231)

_Packaging_

- Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
(2198)
- Always build binaries with the latest available Python (2260)

Documentation

- Add discussion of magic comments to FAQ page (2272)
- `--experimental-string-processing` will be enabled by default in the future (2273)
- Fix typos discovered by codespell (2228)
- Fix Vim plugin installation instructions. (2235)
- Add new Frequently Asked Questions page (2247)
- Fix encoding + symlink issues preventing proper build on Windows (2262)

21.5b1

_Black_

- Refactor `src/black/__init__.py` into many files (2206)

Documentation

- Replaced all remaining references to the [`master`](https://github.com/psf/black/tree/main) branch with the [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in the source code were also made. (#2210)
- Sigificantly reorganized the documentation to make much more sense. Check them out by heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/). (#2174)

21.5b0

_Black_

- Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (2169)
- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
being called but with no arguments (2182)

_Black-Primer_

- Add `--no-diff` to black-primer to suppress formatting changes (2187)

21.4b2

_Black_

- Fix crash if the user configuration directory is inaccessible. (2158)

- Clarify
[circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
in which _Black_ may change the AST (2159)

_Packaging_

- Install `primer.json` (used by `black-primer` by default) with black. (2154)

21.4b1

_Black_

- Fix crash on docstrings ending with "\ ". (2142)

- Fix crash when atypical whitespace is cleaned out of dostrings (2120)

- Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
in the name of the cache file. Without this fix, changes in these flags would not take
effect if the cache had already been populated. (2131)

- Don't remove necessary parentheses from assignment expression containing assert /
return statements. (2143)

_Packaging_

- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling

21.4b0

_Black_

- Fixed a rare but annoying formatting instability created by the combination of
optional trailing commas inserted by `Black` and optional parentheses looking at
pre-existing "magic" trailing commas. This fixes issue 1629 and all of its many many
duplicates. (2126)

- `Black` now processes one-line docstrings by stripping leading and trailing spaces,
and adding a padding space when needed to break up """". (1740)

- `Black` now cleans up leading non-breaking spaces in comments (2092)

- `Black` now respects `--skip-string-normalization` when normalizing multiline
docstring quotes (1637)

- `Black` no longer removes all empty lines between non-function code and decorators
when formatting typing stubs. Now `Black` enforces a single empty line. (1646)

- `Black` no longer adds an incorrect space after a parenthesized assignment expression
in if/while statements (1655)

- Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
to split lines (1824)

- fixed a crash when PWD=/ on POSIX (1631)

- fixed "I/O operation on closed file" when using --diff (1664)

- Prevent coloured diff output being interleaved with multiple files (1673)

- Added support for PEP 614 relaxed decorator syntax on python 3.9 (1711)

- Added parsing support for unparenthesized tuples and yield expressions in annotated
assignments (1835)

- use lowercase hex strings (1692)

- added `--extend-exclude` argument (PR 2005)

- speed up caching by avoiding pathlib (1950)

- `--diff` correctly indicates when a file doesn't end in a newline (1662)

- Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
(1780)

- Lines ending with `fmt: skip` will now be not formatted (1800)

- PR 2053: Black no longer relies on typed-ast for Python 3.8 and higher

- PR 2053: Python 2 support is now optional, install with
`python3 -m pip install black[python2]` to maintain support.

- Exclude `venv` directory by default (1683)

- Fixed "Black produced code that is not equivalent to the source" when formatting
Python 2 docstrings (2037)

_Packaging_

- Self-contained native _Black_ binaries are now provided for releases via GitHub
Releases (1743)

20.8b1

None

20.8b0

None

19.10b0

None

19.3b0

None

Links

• PyPI: https://pypi.org/project/black
• Changelog: https://data.safetycli.com/changelogs/black/