Skip to content

Conversation

@kastkeepitjumpinlikekangaroos
Copy link
Contributor

Description

Hey! Trying to contribute for the first time to the project so let me know if I'm missing anything :)

I've implemented changes to address this issue #2020 where there's some inconsistency around how many lines are added after an import. I've added 2 test cases showing that if there is more than 1 blank line between the import and the next line that it is now being reduced to one. One test case was failing because it had in its expected outout 2 lines between the import and following statement, so I think modifying the test case now that it should always be one makes sense.

Checklist - did you ...

  • Add an entry in CHANGES.md if necessary?
  • Add / update tests if necessary?
  • Add new / update outdated documentation?

@kastkeepitjumpinlikekangaroos
Copy link
Contributor Author

I got an email about this job failure but looks like all the checks are passing on the PR https://github.com/psf/black/actions/runs/11377698063/job/31652281800 is this something that needs to be addressed?

@JelleZijlstra
Copy link
Collaborator

Interesting, I suspect some change to how GitHub handles artifacts. Not sure why it doesn't show up here.

@kastkeepitjumpinlikekangaroos
Copy link
Contributor Author

kastkeepitjumpinlikekangaroos commented Oct 25, 2024

I got an email about this job failure but looks like all the checks are passing on the PR https://github.com/psf/black/actions/runs/11377698063/job/31652281800 is this something that needs to be addressed?

I got this same error again on the rerun of the workflows https://github.com/psf/black/actions/runs/11483099904/job/31957735676 and seems to be because there's no artifact in this workflow https://github.com/psf/black/actions/runs/11412528080 with the file name .pr-comment.json. If I'm understanding correctly it looks like this is because these tasks which call comment-body (which produces .pr-comment.json https://github.com/psf/black/blob/main/scripts/diff_shades_gha_helper.py#L167) only executes when the matrix mode is preview-changes and the above diff-shades workflow has a matrix mode of analysis

https://github.com/psf/black/blob/main/.github/workflows/diff_shades.yml#L130:

      - name: Generate summary file (PR only)
        if: github.event_name == 'pull_request' && matrix.mode == 'preview-changes'
        run: >
          python helper.py comment-body
          ${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }}
          ${{ matrix.baseline-sha }} ${{ matrix.target-sha }}
          ${{ github.event.pull_request.number }}

      - name: Upload summary file (PR only)
        if: github.event_name == 'pull_request' && matrix.mode == 'preview-changes'
        uses: actions/upload-artifact@v3
        with:
          name: .pr-comment.json
          path: .pr-comment.json

@kastkeepitjumpinlikekangaroos
Copy link
Contributor Author

hey @JelleZijlstra ! :) just bumping this PR - do the changes look good or are there other modifications you'd like to see?

Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this looks reasonable

One nit: could you move the logic down next to

black/src/black/lines.py

Lines 674 to 680 in c98fc0c

if (
self.previous_line.is_import
and not current_line.is_import
and not current_line.is_fmt_pass_converted(first_leaf_matches=is_import)
and depth == self.previous_line.depth
):
return (before or 1), 0
and also add a test case for when imports are within a function?

@kastkeepitjumpinlikekangaroos
Copy link
Contributor Author

Thanks, this looks reasonable

One nit: could you move the logic down next to

black/src/black/lines.py

Lines 674 to 680 in c98fc0c

if (
self.previous_line.is_import
and not current_line.is_import
and not current_line.is_fmt_pass_converted(first_leaf_matches=is_import)
and depth == self.previous_line.depth
):
return (before or 1), 0

and also add a test case for when imports are within a function?

@hauntsaninja for sure, let me know if where I moved the logic is what you were thinking!

also moved all the case cases to a single file, added a test case for imports inside a function, and expanded some existing test cases

Copy link
Collaborator

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, just some wordsmithing

@JelleZijlstra JelleZijlstra merged commit e54f86b into psf:main Dec 4, 2024
45 checks passed
luketainton pushed a commit to luketainton/repos_PwnedPW that referenced this pull request Feb 10, 2025
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 ([#&#8203;4558](psf/black#4558)), stabilizing
the following changes:

-   Normalize casing of Unicode escape characters in strings to lowercase ([#&#8203;2916](psf/black#2916))
-   Fix inconsistencies in whether certain strings are detected as docstrings ([#&#8203;4095](psf/black#4095))
-   Consistently add trailing commas to typed function parameters ([#&#8203;4164](psf/black#4164))
-   Remove redundant parentheses in if guards for case blocks ([#&#8203;4214](psf/black#4214))
-   Add parentheses to if clauses in case blocks when the line is too long ([#&#8203;4269](psf/black#4269))
-   Whitespace before `# fmt: skip` comments is no longer normalized ([#&#8203;4146](psf/black#4146))
-   Fix line length computation for certain expressions that involve the power operator ([#&#8203;4154](psf/black#4154))
-   Check if there is a newline before the terminating quotes of a docstring ([#&#8203;4185](psf/black#4185))
-   Fix type annotation spacing between `*` and more complex type variable tuple ([#&#8203;4440](psf/black#4440))

The following changes were not in any previous release:

-   Remove parentheses around sole list items ([#&#8203;4312](psf/black#4312))
-   Generic function definitions are now formatted more elegantly: parameters are
    split over multiple lines first instead of type parameter definitions ([#&#8203;4553](psf/black#4553))

##### Stable style

-   Fix formatting cells in IPython notebooks with magic methods and starting or trailing
    empty lines ([#&#8203;4484](psf/black#4484))
-   Fix crash when formatting `with` statements containing tuple generators/unpacking
    ([#&#8203;4538](psf/black#4538))

##### Preview style

-   Fix/remove string merging changing f-string quotes on f-strings with internal quotes
    ([#&#8203;4498](psf/black#4498))
-   Collapse multiple empty lines after an import into one ([#&#8203;4489](psf/black#4489))
-   Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing
    parentheses around long dictionary values ([#&#8203;4377](psf/black#4377))
-   Move `wrap_long_dict_values_in_parens` from the unstable to preview style ([#&#8203;4561](psf/black#4561))

##### Packaging

-   Store license identifier inside the `License-Expression` metadata field, see
    [PEP 639](https://peps.python.org/pep-0639/). ([#&#8203;4479](psf/black#4479))

##### Performance

-   Speed up the `is_fstring_start` function in Black's tokenizer ([#&#8203;4541](psf/black#4541))

##### Integrations

-   If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be
    formatted. ([#&#8203;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.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xNjQuMSIsInVwZGF0ZWRJblZlciI6IjM5LjE2NC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJsaW50aW5nIl19-->

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>
736-c41-2c1-e464fc974 added a commit to Swiss-Armed-Forces/Loom that referenced this pull request Dec 30, 2025
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 ([#&#8203;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 ([#&#8203;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 ([#&#8203;4872](psf/black#4872))
- Fix possible crash when `fmt: ` directives aren't on the top level ([#&#8203;4856](psf/black#4856))

##### Preview style

- Fix `fmt: skip` skipping the line after instead of the line it's on ([#&#8203;4855](psf/black#4855))
- Remove unnecessary parentheses from the left-hand side of assignments while preserving
  magic trailing commas and intentional multiline formatting ([#&#8203;4865](psf/black#4865))
- Fix `fix_fmt_skip_in_one_liners` crashing on `with` statements ([#&#8203;4853](psf/black#4853))
- Fix `fix_fmt_skip_in_one_liners` crashing on annotated parameters ([#&#8203;4854](psf/black#4854))
- Fix new lines being added after imports with `# fmt: skip` on them ([#&#8203;4894](psf/black#4894))

##### Packaging

- Releases now include arm64 Windows binaries and wheels ([#&#8203;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 ([#&#8203;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 ([#&#8203;4804](psf/black#4804))
- Add support for the new Python 3.14 t-string syntax introduced by PEP 750 ([#&#8203;4805](psf/black#4805))

##### Stable style

- Fix bug where comments between `# fmt: off` and `# fmt: on` were reformatted ([#&#8203;4811](psf/black#4811))
- Comments containing fmt directives now preserve their exact formatting instead of
  being normalized ([#&#8203;4811](psf/black#4811))

##### Preview style

- Move `multiline_string_handling` from `--unstable` to `--preview` ([#&#8203;4760](psf/black#4760))
- Fix bug where module docstrings would be treated as normal strings if preceded by
  comments ([#&#8203;4764](psf/black#4764))
- Fix bug where python 3.12 generics syntax split line happens weirdly ([#&#8203;4777](psf/black#4777))
- Standardize type comments to form `# type: <value>` ([#&#8203;4645](psf/black#4645))
- Fix `fix_fmt_skip_in_one_liners` preview feature to respect `# fmt: skip` for compound
  statements with semicolon-separated bodies ([#&#8203;4800](psf/black#4800))

##### Configuration

- Add `no_cache` option to control caching behavior. ([#&#8203;4803](psf/black#4803))

##### Packaging

- Releases now include arm64 Linux binaries ([#&#8203;4773](psf/black#4773))

##### Output

- Write unchanged content to stdout when excluding formatting from stdin using pipes
  ([#&#8203;4610](psf/black#4610))

##### *Blackd*

- Implemented BlackDClient. This simple python client allows to easily send formatting
  requests to blackd ([#&#8203;4774](psf/black#4774))

##### Integrations

- Enable 3.14 base CI ([#&#8203;4804](psf/black#4804))
- Enhance GitHub Action `psf/black` to support the `required-version` major-version-only
  "stability" format when using pyproject.toml ([#&#8203;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 ([#&#8203;4772](psf/black#4772))
- Vim: Print the import paths when importing black fails ([#&#8203;4675](psf/black#4675))
- Vim: Fix handling of virtualenvs that have a different Python version ([#&#8203;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
  ([#&#8203;4676](psf/black#4676))

##### Stable style

- Fix crash while formatting a long `del` statement containing tuples ([#&#8203;4628](psf/black#4628))
- Fix crash while formatting expressions using the walrus operator in complex `with`
  statements ([#&#8203;4630](psf/black#4630))
- Handle `# fmt: skip` followed by a comment at the end of file ([#&#8203;4635](psf/black#4635))
- Fix crash when a tuple appears in the `as` clause of a `with` statement ([#&#8203;4634](psf/black#4634))
- Fix crash when tuple is used as a context manager inside a `with` statement ([#&#8203;4646](psf/black#4646))
- Fix crash when formatting a `\` followed by a `\r` followed by a comment ([#&#8203;4663](psf/black#4663))
- Fix crash on a `\\r\n` ([#&#8203;4673](psf/black#4673))
- Fix crash on `await ...` (where `...` is a literal `Ellipsis`) ([#&#8203;4676](psf/black#4676))
- Fix crash on parenthesized expression inside a type parameter bound ([#&#8203;4684](psf/black#4684))
- Fix crash when using line ranges excluding indented single line decorated items
  ([#&#8203;4670](psf/black#4670))

##### Preview style

- Fix a bug where one-liner functions/conditionals marked with `# fmt: skip` would still
  be formatted ([#&#8203;4552](psf/black#4552))
- Improve `multiline_string_handling` with ternaries and dictionaries ([#&#8203;4657](psf/black#4657))
- Fix a bug where `string_processing` would not split f-strings directly after
  expressions ([#&#8203;4680](psf/black#4680))
- Wrap the `in` clause of comprehensions across lines if necessary ([#&#8203;4699](psf/black#4699))
- Remove parentheses around multiple exception types in `except` and `except*` without
  `as`. ([#&#8203;4720](psf/black#4720))
- Add `\r` style newlines to the potential newlines to normalize file newlines both from
  and to ([#&#8203;4710](psf/black#4710))

##### Parser

- Rewrite tokenizer to improve performance and compliance ([#&#8203;4536](psf/black#4536))
- Fix bug where certain unusual expressions (e.g., lambdas) were not accepted in type
  parameter bounds and defaults. ([#&#8203;4602](psf/black#4602))

##### Performance

- Avoid using an extra process when running with only one worker ([#&#8203;4734](psf/black#4734))

##### Integrations

- Fix the version check in the vim file to reject Python 3.8 ([#&#8203;4567](psf/black#4567))
- Enhance GitHub Action `psf/black` to read Black version from an additional section in
  pyproject.toml: `[project.dependency-groups]` ([#&#8203;4606](psf/black#4606))
- Build gallery docker image with python3-slim and reduce image size ([#&#8203;4686](psf/black#4686))

##### Documentation

- Add FAQ entry for windows emoji not displaying ([#&#8203;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 ([#&#8203;4558](psf/black#4558)), stabilizing the following
changes:

- Normalize casing of Unicode escape characters in strings to lowercase ([#&#8203;2916](psf/black#2916))
- Fix inconsistencies in whether certain strings are detected as docstrings ([#&#8203;4095](psf/black#4095))
- Consistently add trailing commas to typed function parameters ([#&#8203;4164](psf/black#4164))
- Remove redundant parentheses in if guards for case blocks ([#&#8203;4214](psf/black#4214))
- Add parentheses to if clauses in case blocks when the line is too long ([#&#8203;4269](psf/black#4269))
- Whitespace before `# fmt: skip` comments is no longer normalized ([#&#8203;4146](psf/black#4146))
- Fix line length computation for certain expressions that involve the power operator
  ([#&#8203;4154](psf/black#4154))
- Check if there is a newline before the terminating quotes of a docstring ([#&#8203;4185](psf/black#4185))
- Fix type annotation spacing between `*` and more complex type variable tuple ([#&#8203;4440](psf/black#4440))

The following changes were not in any previous release:

- Remove parentheses around sole list items ([#&#8203;4312](psf/black#4312))
- Generic function definitions are now formatted more elegantly: parameters are split
  over multiple lines first instead of type parameter definitions ([#&#8203;4553](psf/black#4553))

##### Stable style

- Fix formatting cells in IPython notebooks with magic methods and starting or trailing
  empty lines ([#&#8203;4484](psf/black#4484))
- Fix crash when formatting `with` statements containing tuple generators/unpacking
  ([#&#8203;4538](psf/black#4538))

##### Preview style

- Fix/remove string merging changing f-string quotes on f-strings with internal quotes
  ([#&#8203;4498](psf/black#4498))
- Collapse multiple empty lines after an import into one ([#&#8203;4489](psf/black#4489))
- Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing
  parentheses around long dictionary values ([#&#8203;4377](psf/black#4377))
- Move `wrap_long_dict_values_in_parens` from the unstable to preview style ([#&#8203;4561](psf/black#4561))

##### Packaging

- Store license identifier inside the `License-Expression` metadata field, see
  [PEP 639](https://peps.python.org/pep-0639/). ([#&#8203;4479](psf/black#4479))

##### Performance

- Speed up the `is_fstring_start` function in Black's tokenizer ([#&#8203;4541](psf/black#4541))

##### Integrations

- If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be
  formatted. ([#&#8203;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. ([#&#8203;4436](psf/black#4436)) ([#&#8203;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. ([#&#8203;4447](psf/black#4447))
- Black no longer supports running with Python 3.8 ([#&#8203;4452](psf/black#4452))

##### Stable style

- Fix crashes involving comments in parenthesised return types or `X | Y` style unions.
  ([#&#8203;4453](psf/black#4453))
- Fix skipping Jupyter cells with unknown `%%` magic ([#&#8203;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`) ([#&#8203;4440](psf/black#4440))

##### Caching

- Fix bug where the cache was shared between runs with and without `--unstable` ([#&#8203;4466](psf/black#4466))

##### Packaging

- Upgrade version of mypyc used to 1.12 beta ([#&#8203;4450](psf/black#4450)) ([#&#8203;4449](psf/black#4449))
- `blackd` now requires a newer version of aiohttp. ([#&#8203;4451](psf/black#4451))

##### Output

- Added Python target version information on parse error ([#&#8203;4378](psf/black#4378))
- Add information about Black version to internal error messages ([#&#8203;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. ([#&#8203;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. ([#&#8203;4345](psf/black#4345))

##### Parser

- Fix regression where Black failed to parse a multiline f-string containing another
  multiline string ([#&#8203;4339](psf/black#4339))
- Fix regression where Black failed to parse an escaped single quote inside an f-string
  ([#&#8203;4401](psf/black#4401))
- Fix bug with Black incorrectly parsing empty lines with a backslash ([#&#8203;4343](psf/black#4343))
- Fix bugs with Black's tokenizer not handling `\{` inside f-strings very well ([#&#8203;4422](psf/black#4422))
- Fix incorrect line numbers in the tokenizer for certain tokens within f-strings
  ([#&#8203;4423](psf/black#4423))

##### Performance

- Improve performance when a large directory is listed in `.gitignore` ([#&#8203;4415](psf/black#4415))

##### *Blackd*

- Fix blackd (and all extras installs) for docker container ([#&#8203;4357](psf/black#4357))

</details>

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi4yNy4xIiwidXBkYXRlZEluVmVyIjoiNDIuNjAuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIiwicmVub3ZhdGUiXX0=-->

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>
736-c41-2c1-e464fc974 added a commit to Swiss-Armed-Forces/Loom that referenced this pull request Dec 30, 2025
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 ([#&#8203;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 ([#&#8203;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 ([#&#8203;4872](psf/black#4872))
- Fix possible crash when `fmt: ` directives aren't on the top level ([#&#8203;4856](psf/black#4856))

##### Preview style

- Fix `fmt: skip` skipping the line after instead of the line it's on ([#&#8203;4855](psf/black#4855))
- Remove unnecessary parentheses from the left-hand side of assignments while preserving
  magic trailing commas and intentional multiline formatting ([#&#8203;4865](psf/black#4865))
- Fix `fix_fmt_skip_in_one_liners` crashing on `with` statements ([#&#8203;4853](psf/black#4853))
- Fix `fix_fmt_skip_in_one_liners` crashing on annotated parameters ([#&#8203;4854](psf/black#4854))
- Fix new lines being added after imports with `# fmt: skip` on them ([#&#8203;4894](psf/black#4894))

##### Packaging

- Releases now include arm64 Windows binaries and wheels ([#&#8203;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 ([#&#8203;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 ([#&#8203;4804](psf/black#4804))
- Add support for the new Python 3.14 t-string syntax introduced by PEP 750 ([#&#8203;4805](psf/black#4805))

##### Stable style

- Fix bug where comments between `# fmt: off` and `# fmt: on` were reformatted ([#&#8203;4811](psf/black#4811))
- Comments containing fmt directives now preserve their exact formatting instead of
  being normalized ([#&#8203;4811](psf/black#4811))

##### Preview style

- Move `multiline_string_handling` from `--unstable` to `--preview` ([#&#8203;4760](psf/black#4760))
- Fix bug where module docstrings would be treated as normal strings if preceded by
  comments ([#&#8203;4764](psf/black#4764))
- Fix bug where python 3.12 generics syntax split line happens weirdly ([#&#8203;4777](psf/black#4777))
- Standardize type comments to form `# type: <value>` ([#&#8203;4645](psf/black#4645))
- Fix `fix_fmt_skip_in_one_liners` preview feature to respect `# fmt: skip` for compound
  statements with semicolon-separated bodies ([#&#8203;4800](psf/black#4800))

##### Configuration

- Add `no_cache` option to control caching behavior. ([#&#8203;4803](psf/black#4803))

##### Packaging

- Releases now include arm64 Linux binaries ([#&#8203;4773](psf/black#4773))

##### Output

- Write unchanged content to stdout when excluding formatting from stdin using pipes
  ([#&#8203;4610](psf/black#4610))

##### *Blackd*

- Implemented BlackDClient. This simple python client allows to easily send formatting
  requests to blackd ([#&#8203;4774](psf/black#4774))

##### Integrations

- Enable 3.14 base CI ([#&#8203;4804](psf/black#4804))
- Enhance GitHub Action `psf/black` to support the `required-version` major-version-only
  "stability" format when using pyproject.toml ([#&#8203;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 ([#&#8203;4772](psf/black#4772))
- Vim: Print the import paths when importing black fails ([#&#8203;4675](psf/black#4675))
- Vim: Fix handling of virtualenvs that have a different Python version ([#&#8203;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
  ([#&#8203;4676](psf/black#4676))

##### Stable style

- Fix crash while formatting a long `del` statement containing tuples ([#&#8203;4628](psf/black#4628))
- Fix crash while formatting expressions using the walrus operator in complex `with`
  statements ([#&#8203;4630](psf/black#4630))
- Handle `# fmt: skip` followed by a comment at the end of file ([#&#8203;4635](psf/black#4635))
- Fix crash when a tuple appears in the `as` clause of a `with` statement ([#&#8203;4634](psf/black#4634))
- Fix crash when tuple is used as a context manager inside a `with` statement ([#&#8203;4646](psf/black#4646))
- Fix crash when formatting a `\` followed by a `\r` followed by a comment ([#&#8203;4663](psf/black#4663))
- Fix crash on a `\\r\n` ([#&#8203;4673](psf/black#4673))
- Fix crash on `await ...` (where `...` is a literal `Ellipsis`) ([#&#8203;4676](psf/black#4676))
- Fix crash on parenthesized expression inside a type parameter bound ([#&#8203;4684](psf/black#4684))
- Fix crash when using line ranges excluding indented single line decorated items
  ([#&#8203;4670](psf/black#4670))

##### Preview style

- Fix a bug where one-liner functions/conditionals marked with `# fmt: skip` would still
  be formatted ([#&#8203;4552](psf/black#4552))
- Improve `multiline_string_handling` with ternaries and dictionaries ([#&#8203;4657](psf/black#4657))
- Fix a bug where `string_processing` would not split f-strings directly after
  expressions ([#&#8203;4680](psf/black#4680))
- Wrap the `in` clause of comprehensions across lines if necessary ([#&#8203;4699](psf/black#4699))
- Remove parentheses around multiple exception types in `except` and `except*` without
  `as`. ([#&#8203;4720](psf/black#4720))
- Add `\r` style newlines to the potential newlines to normalize file newlines both from
  and to ([#&#8203;4710](psf/black#4710))

##### Parser

- Rewrite tokenizer to improve performance and compliance ([#&#8203;4536](psf/black#4536))
- Fix bug where certain unusual expressions (e.g., lambdas) were not accepted in type
  parameter bounds and defaults. ([#&#8203;4602](psf/black#4602))

##### Performance

- Avoid using an extra process when running with only one worker ([#&#8203;4734](psf/black#4734))

##### Integrations

- Fix the version check in the vim file to reject Python 3.8 ([#&#8203;4567](psf/black#4567))
- Enhance GitHub Action `psf/black` to read Black version from an additional section in
  pyproject.toml: `[project.dependency-groups]` ([#&#8203;4606](psf/black#4606))
- Build gallery docker image with python3-slim and reduce image size ([#&#8203;4686](psf/black#4686))

##### Documentation

- Add FAQ entry for windows emoji not displaying ([#&#8203;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 ([#&#8203;4558](psf/black#4558)), stabilizing the following
changes:

- Normalize casing of Unicode escape characters in strings to lowercase ([#&#8203;2916](psf/black#2916))
- Fix inconsistencies in whether certain strings are detected as docstrings ([#&#8203;4095](psf/black#4095))
- Consistently add trailing commas to typed function parameters ([#&#8203;4164](psf/black#4164))
- Remove redundant parentheses in if guards for case blocks ([#&#8203;4214](psf/black#4214))
- Add parentheses to if clauses in case blocks when the line is too long ([#&#8203;4269](psf/black#4269))
- Whitespace before `# fmt: skip` comments is no longer normalized ([#&#8203;4146](psf/black#4146))
- Fix line length computation for certain expressions that involve the power operator
  ([#&#8203;4154](psf/black#4154))
- Check if there is a newline before the terminating quotes of a docstring ([#&#8203;4185](psf/black#4185))
- Fix type annotation spacing between `*` and more complex type variable tuple ([#&#8203;4440](psf/black#4440))

The following changes were not in any previous release:

- Remove parentheses around sole list items ([#&#8203;4312](psf/black#4312))
- Generic function definitions are now formatted more elegantly: parameters are split
  over multiple lines first instead of type parameter definitions ([#&#8203;4553](psf/black#4553))

##### Stable style

- Fix formatting cells in IPython notebooks with magic methods and starting or trailing
  empty lines ([#&#8203;4484](psf/black#4484))
- Fix crash when formatting `with` statements containing tuple generators/unpacking
  ([#&#8203;4538](psf/black#4538))

##### Preview style

- Fix/remove string merging changing f-string quotes on f-strings with internal quotes
  ([#&#8203;4498](psf/black#4498))
- Collapse multiple empty lines after an import into one ([#&#8203;4489](psf/black#4489))
- Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing
  parentheses around long dictionary values ([#&#8203;4377](psf/black#4377))
- Move `wrap_long_dict_values_in_parens` from the unstable to preview style ([#&#8203;4561](psf/black#4561))

##### Packaging

- Store license identifier inside the `License-Expression` metadata field, see
  [PEP 639](https://peps.python.org/pep-0639/). ([#&#8203;4479](psf/black#4479))

##### Performance

- Speed up the `is_fstring_start` function in Black's tokenizer ([#&#8203;4541](psf/black#4541))

##### Integrations

- If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be
  formatted. ([#&#8203;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. ([#&#8203;4436](psf/black#4436)) ([#&#8203;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. ([#&#8203;4447](psf/black#4447))
- Black no longer supports running with Python 3.8 ([#&#8203;4452](psf/black#4452))

##### Stable style

- Fix crashes involving comments in parenthesised return types or `X | Y` style unions.
  ([#&#8203;4453](psf/black#4453))
- Fix skipping Jupyter cells with unknown `%%` magic ([#&#8203;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`) ([#&#8203;4440](psf/black#4440))

##### Caching

- Fix bug where the cache was shared between runs with and without `--unstable` ([#&#8203;4466](psf/black#4466))

##### Packaging

- Upgrade version of mypyc used to 1.12 beta ([#&#8203;4450](psf/black#4450)) ([#&#8203;4449](psf/black#4449))
- `blackd` now requires a newer version of aiohttp. ([#&#8203;4451](psf/black#4451))

##### Output

- Added Python target version information on parse error ([#&#8203;4378](psf/black#4378))
- Add information about Black version to internal error messages ([#&#8203;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. ([#&#8203;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. ([#&#8203;4345](psf/black#4345))

##### Parser

- Fix regression where Black failed to parse a multiline f-string containing another
  multiline string ([#&#8203;4339](psf/black#4339))
- Fix regression where Black failed to parse an escaped single quote inside an f-string
  ([#&#8203;4401](psf/black#4401))
- Fix bug with Black incorrectly parsing empty lines with a backslash ([#&#8203;4343](psf/black#4343))
- Fix bugs with Black's tokenizer not handling `\{` inside f-strings very well ([#&#8203;4422](psf/black#4422))
- Fix incorrect line numbers in the tokenizer for certain tokens within f-strings
  ([#&#8203;4423](psf/black#4423))

##### Performance

- Improve performance when a large directory is listed in `.gitignore` ([#&#8203;4415](psf/black#4415))

##### *Blackd*

- Fix blackd (and all extras installs) for docker container ([#&#8203;4357](psf/black#4357))

</details>

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi4yNy4xIiwidXBkYXRlZEluVmVyIjoiNDIuNjAuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIiwicmVub3ZhdGUiXX0=-->

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants