Improve function declaration wrapping when it contains generic type definitions #4553

Pedro-Muller29 · 2025-01-21T01:51:03Z

Description

This PR addresses #4071 by improving how Black wraps function definitions that include generic type declarations.

Current Behavior

When a function with generic type declarations is formatted, Black prioritizes wrapping the generic type definitions, even in cases where splitting the arguments would result in a cleaner layout. For example:

Input:

def func[T](a: T, b: T,) -> T:
    return a

Current Output:

def func[
    T
](a: T, b: T,) -> T:
    return a

New Behavior

With this improvement, Black prioritizes wrapping the arguments instead of the generic type definitions, resulting in more readable code:

Improved Output:

def func[T](
    a: T,
    b: T,
) -> T:
    return a

However, Black will still wrap the generic type declarations if:

A magic trailing comma is present in the generic type declaration.
The length of the line from the start of the function declaration to the closing square bracket approaches the line limit, making necessary wrapping it to conform to the limit.

For example:

Input:

def trailing_comma1[T=int,](a: str):
    pass

Output:

def trailing_comma1[
    T = int,
](a: str):
    pass

Implementation details:

In the left_hand_split function, black would search for an opening brackets leaf in function declaration. It was not differentiating between squared brackets and parenthesis, thus it was treating function parameters and generic type definitions the same way. Since generic type definitions comes first, it would always wrap them first.

The solution was to just make it ignore the opening of square brackets in all cases, expect:

There was a magic trailing comma in the generic type definition.
If the amount of characters from the start of the function declaration until the closing squared bracket would almost reach the line limit.

Checklist

Added an entry in CHANGES.md if necessary.
Added/updated tests to cover the changes.
Updated documentation as needed.

…larations. (psf#4071)

JelleZijlstra · 2025-01-24T03:45:53Z

This crashes with a comment on a line by itself after the typevar:

$ python -m black -c '''def with_random_comments[
>     Z
>     # bye
> ]():
>     return a'''
def with_random_comments[
    Z
    # bye
]():
    return a
$ python -m black -c '''def with_random_comments[
    Z
    # bye
]():
    return a''' --preview
def with_random_comments[
    Z
    # bye
]():
    return a
error: cannot format <string>: Cannot parse: 2:4:     return a

I'll push a few changes.

JelleZijlstra · 2025-01-24T03:54:59Z

The crash happens only if the comment is on a line by itself after the last type parameter. Black tries to reformat the code like this:

def with_random_comments[Z# bye]():
    return a

We should either leave the code alone or reformat it with the comment at the end of a collapsed line, like this:

$ python -m black -c '''def with_random_comments[
    Z    # bye
]():
    return a''' --fast --preview
def with_random_comments[Z]():  # bye
    return a

(I don't really care which of the two we pick, whatever is easiest to implement.)

hauntsaninja

Thanks for this PR, it's great!

I think the trailing comma handling isn't exactly right (but maybe this is fine), see e.g. both_magic in the new test cases I pushed. :-)

hauntsaninja · 2025-01-24T05:19:05Z

Okay, I have a fix for both things that I think also simplifies things a little, pushing...

hauntsaninja · 2025-01-24T05:24:30Z

@Pedro-Muller29 @JelleZijlstra please lmk what you both think!

JelleZijlstra · 2025-01-24T06:12:03Z

Nice, thanks for the fixes! I think we could use some more test cases with comments in random places, I might spend some time on that tomorrow.

Pedro-Muller29 · 2025-01-24T12:55:02Z

@Pedro-Muller29 @JelleZijlstra please lmk what you both think!

Nice changes!

It simplified the logic, and I think relying on bracket_split_build_line to determine whether the line should be split, instead of manually doing it as my changes were, is a better idea.

…neric_functions

hauntsaninja

Let's merge! Thanks again for the PR, the old behaviour was pretty bad formatting

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | dependency-groups | major | `<25.0.0,>=24.10.0` -> `<25.2.0,>=25.1.0` | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`v25.1.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2510) [Compare Source](psf/black@24.10.0...25.1.0) ##### Highlights This release introduces the new 2025 stable style ([#4558](psf/black#4558)), stabilizing the following changes: - Normalize casing of Unicode escape characters in strings to lowercase ([#2916](psf/black#2916)) - Fix inconsistencies in whether certain strings are detected as docstrings ([#4095](psf/black#4095)) - Consistently add trailing commas to typed function parameters ([#4164](psf/black#4164)) - Remove redundant parentheses in if guards for case blocks ([#4214](psf/black#4214)) - Add parentheses to if clauses in case blocks when the line is too long ([#4269](psf/black#4269)) - Whitespace before `# fmt: skip` comments is no longer normalized ([#4146](psf/black#4146)) - Fix line length computation for certain expressions that involve the power operator ([#4154](psf/black#4154)) - Check if there is a newline before the terminating quotes of a docstring ([#4185](psf/black#4185)) - Fix type annotation spacing between `*` and more complex type variable tuple ([#4440](psf/black#4440)) The following changes were not in any previous release: - Remove parentheses around sole list items ([#4312](psf/black#4312)) - Generic function definitions are now formatted more elegantly: parameters are split over multiple lines first instead of type parameter definitions ([#4553](psf/black#4553)) ##### Stable style - Fix formatting cells in IPython notebooks with magic methods and starting or trailing empty lines ([#4484](psf/black#4484)) - Fix crash when formatting `with` statements containing tuple generators/unpacking ([#4538](psf/black#4538)) ##### Preview style - Fix/remove string merging changing f-string quotes on f-strings with internal quotes ([#4498](psf/black#4498)) - Collapse multiple empty lines after an import into one ([#4489](psf/black#4489)) - Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing parentheses around long dictionary values ([#4377](psf/black#4377)) - Move `wrap_long_dict_values_in_parens` from the unstable to preview style ([#4561](psf/black#4561)) ##### Packaging - Store license identifier inside the `License-Expression` metadata field, see [PEP 639](https://peps.python.org/pep-0639/). ([#4479](psf/black#4479)) ##### Performance - Speed up the `is_fstring_start` function in Black's tokenizer ([#4541](psf/black#4541)) ##### Integrations - If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be formatted. ([#4539](psf/black#4539)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/repos/PwnedPW/pulls/283 Reviewed-by: Luke Tainton <luke@tainton.uk> Co-authored-by: Renovate [BOT] <renovate-bot@git.tainton.uk> Co-committed-by: Renovate [BOT] <renovate-bot@git.tainton.uk>

…efinitions (psf#4553) --------- Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: hauntsaninja <hauntsaninja@gmail.com> Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>

This MR contains the following updates: | Package | Type | Update | Change | OpenSSF | |---|---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | dev | major | `^24.4.2` → `^25.0.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/psf/black/badge)](https://securityscorecards.dev/viewer/?uri=github.com/psf/black) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`v25.12.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#25120) [Compare Source](psf/black@25.11.0...25.12.0) ##### Highlights - Black no longer supports running with Python 3.9 ([#4842](psf/black#4842)) ##### Stable style - Fix bug where comments preceding `# fmt: off`/`# fmt: on` blocks were incorrectly removed, particularly affecting Jupytext's `# %% [markdown]` comments ([#4845](psf/black#4845)) - Fix crash when multiple `# fmt: skip` comments are used in a multi-part if-clause, on string literals, or on dictionary entries with long lines ([#4872](psf/black#4872)) - Fix possible crash when `fmt: ` directives aren't on the top level ([#4856](psf/black#4856)) ##### Preview style - Fix `fmt: skip` skipping the line after instead of the line it's on ([#4855](psf/black#4855)) - Remove unnecessary parentheses from the left-hand side of assignments while preserving magic trailing commas and intentional multiline formatting ([#4865](psf/black#4865)) - Fix `fix_fmt_skip_in_one_liners` crashing on `with` statements ([#4853](psf/black#4853)) - Fix `fix_fmt_skip_in_one_liners` crashing on annotated parameters ([#4854](psf/black#4854)) - Fix new lines being added after imports with `# fmt: skip` on them ([#4894](psf/black#4894)) ##### Packaging - Releases now include arm64 Windows binaries and wheels ([#4814](psf/black#4814)) ##### Integrations - Add `output-file` input to GitHub Action `psf/black` to write formatter output to a file for artifact capture and log cleanliness ([#4824](psf/black#4824)) ### [`v25.11.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#25110) [Compare Source](psf/black@25.9.0...25.11.0) ##### Highlights - Enable base 3.14 support ([#4804](psf/black#4804)) - Add support for the new Python 3.14 t-string syntax introduced by PEP 750 ([#4805](psf/black#4805)) ##### Stable style - Fix bug where comments between `# fmt: off` and `# fmt: on` were reformatted ([#4811](psf/black#4811)) - Comments containing fmt directives now preserve their exact formatting instead of being normalized ([#4811](psf/black#4811)) ##### Preview style - Move `multiline_string_handling` from `--unstable` to `--preview` ([#4760](psf/black#4760)) - Fix bug where module docstrings would be treated as normal strings if preceded by comments ([#4764](psf/black#4764)) - Fix bug where python 3.12 generics syntax split line happens weirdly ([#4777](psf/black#4777)) - Standardize type comments to form `# type: <value>` ([#4645](psf/black#4645)) - Fix `fix_fmt_skip_in_one_liners` preview feature to respect `# fmt: skip` for compound statements with semicolon-separated bodies ([#4800](psf/black#4800)) ##### Configuration - Add `no_cache` option to control caching behavior. ([#4803](psf/black#4803)) ##### Packaging - Releases now include arm64 Linux binaries ([#4773](psf/black#4773)) ##### Output - Write unchanged content to stdout when excluding formatting from stdin using pipes ([#4610](psf/black#4610)) ##### *Blackd* - Implemented BlackDClient. This simple python client allows to easily send formatting requests to blackd ([#4774](psf/black#4774)) ##### Integrations - Enable 3.14 base CI ([#4804](psf/black#4804)) - Enhance GitHub Action `psf/black` to support the `required-version` major-version-only "stability" format when using pyproject.toml ([#4770](psf/black#4770)) - Improve error message for vim plugin users. It now handles independently vim version - Vim: Warn on unsupported Vim and Python versions independently ([#4772](psf/black#4772)) - Vim: Print the import paths when importing black fails ([#4675](psf/black#4675)) - Vim: Fix handling of virtualenvs that have a different Python version ([#4675](psf/black#4675)) ### [`v25.9.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2590) [Compare Source](psf/black@25.1.0...25.9.0) ##### Highlights - Remove support for pre-python 3.7 `await/async` as soft keywords/variable names ([#4676](psf/black#4676)) ##### Stable style - Fix crash while formatting a long `del` statement containing tuples ([#4628](psf/black#4628)) - Fix crash while formatting expressions using the walrus operator in complex `with` statements ([#4630](psf/black#4630)) - Handle `# fmt: skip` followed by a comment at the end of file ([#4635](psf/black#4635)) - Fix crash when a tuple appears in the `as` clause of a `with` statement ([#4634](psf/black#4634)) - Fix crash when tuple is used as a context manager inside a `with` statement ([#4646](psf/black#4646)) - Fix crash when formatting a `\` followed by a `\r` followed by a comment ([#4663](psf/black#4663)) - Fix crash on a `\\r\n` ([#4673](psf/black#4673)) - Fix crash on `await ...` (where `...` is a literal `Ellipsis`) ([#4676](psf/black#4676)) - Fix crash on parenthesized expression inside a type parameter bound ([#4684](psf/black#4684)) - Fix crash when using line ranges excluding indented single line decorated items ([#4670](psf/black#4670)) ##### Preview style - Fix a bug where one-liner functions/conditionals marked with `# fmt: skip` would still be formatted ([#4552](psf/black#4552)) - Improve `multiline_string_handling` with ternaries and dictionaries ([#4657](psf/black#4657)) - Fix a bug where `string_processing` would not split f-strings directly after expressions ([#4680](psf/black#4680)) - Wrap the `in` clause of comprehensions across lines if necessary ([#4699](psf/black#4699)) - Remove parentheses around multiple exception types in `except` and `except*` without `as`. ([#4720](psf/black#4720)) - Add `\r` style newlines to the potential newlines to normalize file newlines both from and to ([#4710](psf/black#4710)) ##### Parser - Rewrite tokenizer to improve performance and compliance ([#4536](psf/black#4536)) - Fix bug where certain unusual expressions (e.g., lambdas) were not accepted in type parameter bounds and defaults. ([#4602](psf/black#4602)) ##### Performance - Avoid using an extra process when running with only one worker ([#4734](psf/black#4734)) ##### Integrations - Fix the version check in the vim file to reject Python 3.8 ([#4567](psf/black#4567)) - Enhance GitHub Action `psf/black` to read Black version from an additional section in pyproject.toml: `[project.dependency-groups]` ([#4606](psf/black#4606)) - Build gallery docker image with python3-slim and reduce image size ([#4686](psf/black#4686)) ##### Documentation - Add FAQ entry for windows emoji not displaying ([#4714](psf/black#4714)) ### [`v25.1.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2510) [Compare Source](psf/black@24.10.0...25.1.0) ##### Highlights This release introduces the new 2025 stable style ([#4558](psf/black#4558)), stabilizing the following changes: - Normalize casing of Unicode escape characters in strings to lowercase ([#2916](psf/black#2916)) - Fix inconsistencies in whether certain strings are detected as docstrings ([#4095](psf/black#4095)) - Consistently add trailing commas to typed function parameters ([#4164](psf/black#4164)) - Remove redundant parentheses in if guards for case blocks ([#4214](psf/black#4214)) - Add parentheses to if clauses in case blocks when the line is too long ([#4269](psf/black#4269)) - Whitespace before `# fmt: skip` comments is no longer normalized ([#4146](psf/black#4146)) - Fix line length computation for certain expressions that involve the power operator ([#4154](psf/black#4154)) - Check if there is a newline before the terminating quotes of a docstring ([#4185](psf/black#4185)) - Fix type annotation spacing between `*` and more complex type variable tuple ([#4440](psf/black#4440)) The following changes were not in any previous release: - Remove parentheses around sole list items ([#4312](psf/black#4312)) - Generic function definitions are now formatted more elegantly: parameters are split over multiple lines first instead of type parameter definitions ([#4553](psf/black#4553)) ##### Stable style - Fix formatting cells in IPython notebooks with magic methods and starting or trailing empty lines ([#4484](psf/black#4484)) - Fix crash when formatting `with` statements containing tuple generators/unpacking ([#4538](psf/black#4538)) ##### Preview style - Fix/remove string merging changing f-string quotes on f-strings with internal quotes ([#4498](psf/black#4498)) - Collapse multiple empty lines after an import into one ([#4489](psf/black#4489)) - Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing parentheses around long dictionary values ([#4377](psf/black#4377)) - Move `wrap_long_dict_values_in_parens` from the unstable to preview style ([#4561](psf/black#4561)) ##### Packaging - Store license identifier inside the `License-Expression` metadata field, see [PEP 639](https://peps.python.org/pep-0639/). ([#4479](psf/black#4479)) ##### Performance - Speed up the `is_fstring_start` function in Black's tokenizer ([#4541](psf/black#4541)) ##### Integrations - If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be formatted. ([#4539](psf/black#4539)) ### [`v24.10.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#24100) [Compare Source](psf/black@24.8.0...24.10.0) ##### Highlights - Black is now officially tested with Python 3.13 and provides Python 3.13 mypyc-compiled wheels. ([#4436](psf/black#4436)) ([#4449](psf/black#4449)) - Black will issue an error when used with Python 3.12.5, due to an upstream memory safety issue in Python 3.12.5 that can cause Black's AST safety checks to fail. Please use Python 3.12.6 or Python 3.12.4 instead. ([#4447](psf/black#4447)) - Black no longer supports running with Python 3.8 ([#4452](psf/black#4452)) ##### Stable style - Fix crashes involving comments in parenthesised return types or `X | Y` style unions. ([#4453](psf/black#4453)) - Fix skipping Jupyter cells with unknown `%%` magic ([#4462](psf/black#4462)) ##### Preview style - Fix type annotation spacing between \* and more complex type variable tuple (i.e. `def fn(*args: *tuple[*Ts, T]) -> None: pass`) ([#4440](psf/black#4440)) ##### Caching - Fix bug where the cache was shared between runs with and without `--unstable` ([#4466](psf/black#4466)) ##### Packaging - Upgrade version of mypyc used to 1.12 beta ([#4450](psf/black#4450)) ([#4449](psf/black#4449)) - `blackd` now requires a newer version of aiohttp. ([#4451](psf/black#4451)) ##### Output - Added Python target version information on parse error ([#4378](psf/black#4378)) - Add information about Black version to internal error messages ([#4457](psf/black#4457)) ### [`v24.8.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2480) [Compare Source](psf/black@24.4.2...24.8.0) ##### Stable style - Fix crash when `# fmt: off` is used before a closing parenthesis or bracket. ([#4363](psf/black#4363)) ##### Packaging - Packaging metadata updated: docs are explictly linked, the issue tracker is now also linked. This improves the PyPI listing for Black. ([#4345](psf/black#4345)) ##### Parser - Fix regression where Black failed to parse a multiline f-string containing another multiline string ([#4339](psf/black#4339)) - Fix regression where Black failed to parse an escaped single quote inside an f-string ([#4401](psf/black#4401)) - Fix bug with Black incorrectly parsing empty lines with a backslash ([#4343](psf/black#4343)) - Fix bugs with Black's tokenizer not handling `\{` inside f-strings very well ([#4422](psf/black#4422)) - Fix incorrect line numbers in the tokenizer for certain tokens within f-strings ([#4423](psf/black#4423)) ##### Performance - Improve performance when a large directory is listed in `.gitignore` ([#4415](psf/black#4415)) ##### *Blackd* - Fix blackd (and all extras installs) for docker container ([#4357](psf/black#4357)) </details> --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  See merge request swiss-armed-forces/cyber-command/cea/loom!235 Co-authored-by: shrewd-laidback palace <shrewd-laidback-palace-736-c41-2c1-e464fc974@swiss-armed-forces-open-source.ch> Co-authored-by: Loom MR Pipeline Trigger <group_103951964_bot_9504bb8dead6d4e406ad817a607f24be@noreply.gitlab.com>

chore(deps): update black (major) This MR contains the following updates: | Package | Type | Update | Change | OpenSSF | |---|---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | dev | major | `^24.4.2` → `^25.0.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/psf/black/badge)](https://securityscorecards.dev/viewer/?uri=github.com/psf/black) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`v25.12.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#25120) [Compare Source](psf/black@25.11.0...25.12.0) ##### Highlights - Black no longer supports running with Python 3.9 ([#4842](psf/black#4842)) ##### Stable style - Fix bug where comments preceding `# fmt: off`/`# fmt: on` blocks were incorrectly removed, particularly affecting Jupytext's `# %% [markdown]` comments ([#4845](psf/black#4845)) - Fix crash when multiple `# fmt: skip` comments are used in a multi-part if-clause, on string literals, or on dictionary entries with long lines ([#4872](psf/black#4872)) - Fix possible crash when `fmt: ` directives aren't on the top level ([#4856](psf/black#4856)) ##### Preview style - Fix `fmt: skip` skipping the line after instead of the line it's on ([#4855](psf/black#4855)) - Remove unnecessary parentheses from the left-hand side of assignments while preserving magic trailing commas and intentional multiline formatting ([#4865](psf/black#4865)) - Fix `fix_fmt_skip_in_one_liners` crashing on `with` statements ([#4853](psf/black#4853)) - Fix `fix_fmt_skip_in_one_liners` crashing on annotated parameters ([#4854](psf/black#4854)) - Fix new lines being added after imports with `# fmt: skip` on them ([#4894](psf/black#4894)) ##### Packaging - Releases now include arm64 Windows binaries and wheels ([#4814](psf/black#4814)) ##### Integrations - Add `output-file` input to GitHub Action `psf/black` to write formatter output to a file for artifact capture and log cleanliness ([#4824](psf/black#4824)) ### [`v25.11.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#25110) [Compare Source](psf/black@25.9.0...25.11.0) ##### Highlights - Enable base 3.14 support ([#4804](psf/black#4804)) - Add support for the new Python 3.14 t-string syntax introduced by PEP 750 ([#4805](psf/black#4805)) ##### Stable style - Fix bug where comments between `# fmt: off` and `# fmt: on` were reformatted ([#4811](psf/black#4811)) - Comments containing fmt directives now preserve their exact formatting instead of being normalized ([#4811](psf/black#4811)) ##### Preview style - Move `multiline_string_handling` from `--unstable` to `--preview` ([#4760](psf/black#4760)) - Fix bug where module docstrings would be treated as normal strings if preceded by comments ([#4764](psf/black#4764)) - Fix bug where python 3.12 generics syntax split line happens weirdly ([#4777](psf/black#4777)) - Standardize type comments to form `# type: <value>` ([#4645](psf/black#4645)) - Fix `fix_fmt_skip_in_one_liners` preview feature to respect `# fmt: skip` for compound statements with semicolon-separated bodies ([#4800](psf/black#4800)) ##### Configuration - Add `no_cache` option to control caching behavior. ([#4803](psf/black#4803)) ##### Packaging - Releases now include arm64 Linux binaries ([#4773](psf/black#4773)) ##### Output - Write unchanged content to stdout when excluding formatting from stdin using pipes ([#4610](psf/black#4610)) ##### *Blackd* - Implemented BlackDClient. This simple python client allows to easily send formatting requests to blackd ([#4774](psf/black#4774)) ##### Integrations - Enable 3.14 base CI ([#4804](psf/black#4804)) - Enhance GitHub Action `psf/black` to support the `required-version` major-version-only "stability" format when using pyproject.toml ([#4770](psf/black#4770)) - Improve error message for vim plugin users. It now handles independently vim version - Vim: Warn on unsupported Vim and Python versions independently ([#4772](psf/black#4772)) - Vim: Print the import paths when importing black fails ([#4675](psf/black#4675)) - Vim: Fix handling of virtualenvs that have a different Python version ([#4675](psf/black#4675)) ### [`v25.9.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2590) [Compare Source](psf/black@25.1.0...25.9.0) ##### Highlights - Remove support for pre-python 3.7 `await/async` as soft keywords/variable names ([#4676](psf/black#4676)) ##### Stable style - Fix crash while formatting a long `del` statement containing tuples ([#4628](psf/black#4628)) - Fix crash while formatting expressions using the walrus operator in complex `with` statements ([#4630](psf/black#4630)) - Handle `# fmt: skip` followed by a comment at the end of file ([#4635](psf/black#4635)) - Fix crash when a tuple appears in the `as` clause of a `with` statement ([#4634](psf/black#4634)) - Fix crash when tuple is used as a context manager inside a `with` statement ([#4646](psf/black#4646)) - Fix crash when formatting a `\` followed by a `\r` followed by a comment ([#4663](psf/black#4663)) - Fix crash on a `\\r\n` ([#4673](psf/black#4673)) - Fix crash on `await ...` (where `...` is a literal `Ellipsis`) ([#4676](psf/black#4676)) - Fix crash on parenthesized expression inside a type parameter bound ([#4684](psf/black#4684)) - Fix crash when using line ranges excluding indented single line decorated items ([#4670](psf/black#4670)) ##### Preview style - Fix a bug where one-liner functions/conditionals marked with `# fmt: skip` would still be formatted ([#4552](psf/black#4552)) - Improve `multiline_string_handling` with ternaries and dictionaries ([#4657](psf/black#4657)) - Fix a bug where `string_processing` would not split f-strings directly after expressions ([#4680](psf/black#4680)) - Wrap the `in` clause of comprehensions across lines if necessary ([#4699](psf/black#4699)) - Remove parentheses around multiple exception types in `except` and `except*` without `as`. ([#4720](psf/black#4720)) - Add `\r` style newlines to the potential newlines to normalize file newlines both from and to ([#4710](psf/black#4710)) ##### Parser - Rewrite tokenizer to improve performance and compliance ([#4536](psf/black#4536)) - Fix bug where certain unusual expressions (e.g., lambdas) were not accepted in type parameter bounds and defaults. ([#4602](psf/black#4602)) ##### Performance - Avoid using an extra process when running with only one worker ([#4734](psf/black#4734)) ##### Integrations - Fix the version check in the vim file to reject Python 3.8 ([#4567](psf/black#4567)) - Enhance GitHub Action `psf/black` to read Black version from an additional section in pyproject.toml: `[project.dependency-groups]` ([#4606](psf/black#4606)) - Build gallery docker image with python3-slim and reduce image size ([#4686](psf/black#4686)) ##### Documentation - Add FAQ entry for windows emoji not displaying ([#4714](psf/black#4714)) ### [`v25.1.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2510) [Compare Source](psf/black@24.10.0...25.1.0) ##### Highlights This release introduces the new 2025 stable style ([#4558](psf/black#4558)), stabilizing the following changes: - Normalize casing of Unicode escape characters in strings to lowercase ([#2916](psf/black#2916)) - Fix inconsistencies in whether certain strings are detected as docstrings ([#4095](psf/black#4095)) - Consistently add trailing commas to typed function parameters ([#4164](psf/black#4164)) - Remove redundant parentheses in if guards for case blocks ([#4214](psf/black#4214)) - Add parentheses to if clauses in case blocks when the line is too long ([#4269](psf/black#4269)) - Whitespace before `# fmt: skip` comments is no longer normalized ([#4146](psf/black#4146)) - Fix line length computation for certain expressions that involve the power operator ([#4154](psf/black#4154)) - Check if there is a newline before the terminating quotes of a docstring ([#4185](psf/black#4185)) - Fix type annotation spacing between `*` and more complex type variable tuple ([#4440](psf/black#4440)) The following changes were not in any previous release: - Remove parentheses around sole list items ([#4312](psf/black#4312)) - Generic function definitions are now formatted more elegantly: parameters are split over multiple lines first instead of type parameter definitions ([#4553](psf/black#4553)) ##### Stable style - Fix formatting cells in IPython notebooks with magic methods and starting or trailing empty lines ([#4484](psf/black#4484)) - Fix crash when formatting `with` statements containing tuple generators/unpacking ([#4538](psf/black#4538)) ##### Preview style - Fix/remove string merging changing f-string quotes on f-strings with internal quotes ([#4498](psf/black#4498)) - Collapse multiple empty lines after an import into one ([#4489](psf/black#4489)) - Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing parentheses around long dictionary values ([#4377](psf/black#4377)) - Move `wrap_long_dict_values_in_parens` from the unstable to preview style ([#4561](psf/black#4561)) ##### Packaging - Store license identifier inside the `License-Expression` metadata field, see [PEP 639](https://peps.python.org/pep-0639/). ([#4479](psf/black#4479)) ##### Performance - Speed up the `is_fstring_start` function in Black's tokenizer ([#4541](psf/black#4541)) ##### Integrations - If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be formatted. ([#4539](psf/black#4539)) ### [`v24.10.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#24100) [Compare Source](psf/black@24.8.0...24.10.0) ##### Highlights - Black is now officially tested with Python 3.13 and provides Python 3.13 mypyc-compiled wheels. ([#4436](psf/black#4436)) ([#4449](psf/black#4449)) - Black will issue an error when used with Python 3.12.5, due to an upstream memory safety issue in Python 3.12.5 that can cause Black's AST safety checks to fail. Please use Python 3.12.6 or Python 3.12.4 instead. ([#4447](psf/black#4447)) - Black no longer supports running with Python 3.8 ([#4452](psf/black#4452)) ##### Stable style - Fix crashes involving comments in parenthesised return types or `X | Y` style unions. ([#4453](psf/black#4453)) - Fix skipping Jupyter cells with unknown `%%` magic ([#4462](psf/black#4462)) ##### Preview style - Fix type annotation spacing between \* and more complex type variable tuple (i.e. `def fn(*args: *tuple[*Ts, T]) -> None: pass`) ([#4440](psf/black#4440)) ##### Caching - Fix bug where the cache was shared between runs with and without `--unstable` ([#4466](psf/black#4466)) ##### Packaging - Upgrade version of mypyc used to 1.12 beta ([#4450](psf/black#4450)) ([#4449](psf/black#4449)) - `blackd` now requires a newer version of aiohttp. ([#4451](psf/black#4451)) ##### Output - Added Python target version information on parse error ([#4378](psf/black#4378)) - Add information about Black version to internal error messages ([#4457](psf/black#4457)) ### [`v24.8.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2480) [Compare Source](psf/black@24.4.2...24.8.0) ##### Stable style - Fix crash when `# fmt: off` is used before a closing parenthesis or bracket. ([#4363](psf/black#4363)) ##### Packaging - Packaging metadata updated: docs are explictly linked, the issue tracker is now also linked. This improves the PyPI listing for Black. ([#4345](psf/black#4345)) ##### Parser - Fix regression where Black failed to parse a multiline f-string containing another multiline string ([#4339](psf/black#4339)) - Fix regression where Black failed to parse an escaped single quote inside an f-string ([#4401](psf/black#4401)) - Fix bug with Black incorrectly parsing empty lines with a backslash ([#4343](psf/black#4343)) - Fix bugs with Black's tokenizer not handling `\{` inside f-strings very well ([#4422](psf/black#4422)) - Fix incorrect line numbers in the tokenizer for certain tokens within f-strings ([#4423](psf/black#4423)) ##### Performance - Improve performance when a large directory is listed in `.gitignore` ([#4415](psf/black#4415)) ##### *Blackd* - Fix blackd (and all extras installs) for docker container ([#4357](psf/black#4357)) </details> --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  See merge request swiss-armed-forces/cyber-command/cea/loom!235 Co-authored-by: Loom MR Pipeline Trigger <group_103951964_bot_9504bb8dead6d4e406ad817a607f24be@noreply.gitlab.com> Co-authored-by: open-source Pipeline <group_90701827_bot_ed04ae348bc5f40af9966fb8b6867e99@noreply.gitlab.com>

Improve function definition wrapping when containing generic type dec…

3a5f01a

…larations. (psf#4071)

hauntsaninja mentioned this pull request Jan 24, 2025

Setting the 2025 stable style #4522

Closed

undo rename

d59d58d

hauntsaninja and others added 4 commits January 23, 2025 19:50

cosmetic fixes

22d7821

more test cases

fb1d040

.

23a37da

Merge branch 'main' into improve_wrapping_generic_functions

3932179

hauntsaninja reviewed Jan 24, 2025

View reviewed changes

hauntsaninja added 2 commits January 23, 2025 19:57

remove repeated tests

7bf7188

add failing test case

f9eacaa

hauntsaninja added 2 commits January 23, 2025 21:20

fix crash, respect magic trailing comma

642592e

fix ci

73c4c68

JelleZijlstra added 3 commits January 24, 2025 18:08

comment comment comment

6147cf7

Merge remote-tracking branch 'upstream/main' into improve_wrapping_ge…

faf1d7a

…neric_functions

straight to stable

19787ae

hauntsaninja approved these changes Jan 26, 2025

View reviewed changes

hauntsaninja merged commit 459562c into psf:main Jan 26, 2025
46 checks passed

This was referenced Feb 25, 2025

Wrapping lines of a function signature that uses the new python 3.12 generic type parameter syntax #4071

Closed

Trailing commas in function params cause line splits in type params instead #4254

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve function declaration wrapping when it contains generic type definitions #4553

Improve function declaration wrapping when it contains generic type definitions #4553

Uh oh!

Pedro-Muller29 commented Jan 21, 2025

Uh oh!

JelleZijlstra commented Jan 24, 2025

Uh oh!

JelleZijlstra commented Jan 24, 2025

Uh oh!

hauntsaninja left a comment •

edited

Loading

Uh oh!

hauntsaninja commented Jan 24, 2025 •

edited

Loading

Uh oh!

hauntsaninja commented Jan 24, 2025

Uh oh!

JelleZijlstra commented Jan 24, 2025

Uh oh!

Pedro-Muller29 commented Jan 24, 2025

Uh oh!

hauntsaninja left a comment •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Improve function declaration wrapping when it contains generic type definitions #4553

Improve function declaration wrapping when it contains generic type definitions #4553

Uh oh!

Conversation

Pedro-Muller29 commented Jan 21, 2025

Description

Current Behavior

Input:

Current Output:

New Behavior

Improved Output:

Input:

Output:

Implementation details:

Checklist

Uh oh!

JelleZijlstra commented Jan 24, 2025

Uh oh!

JelleZijlstra commented Jan 24, 2025

Uh oh!

hauntsaninja left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hauntsaninja commented Jan 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hauntsaninja commented Jan 24, 2025

Uh oh!

JelleZijlstra commented Jan 24, 2025

Uh oh!

Pedro-Muller29 commented Jan 24, 2025

Uh oh!

hauntsaninja left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hauntsaninja left a comment •

edited

Loading

hauntsaninja commented Jan 24, 2025 •

edited

Loading

hauntsaninja left a comment •

edited

Loading