Skip to content

Preserve comments before fmt: skip lines#5139

Merged
cobaltt7 merged 2 commits into
psf:mainfrom
cyphercodes:fix-fmtskip-type-ignore-5138
May 18, 2026
Merged

Preserve comments before fmt: skip lines#5139
cobaltt7 merged 2 commits into
psf:mainfrom
cyphercodes:fix-fmtskip-type-ignore-5138

Conversation

@cyphercodes

Copy link
Copy Markdown
Contributor

Description

Fixes #5138.

When # fmt: skip converts a line into a standalone comment leaf, the backwards scan to find the start of that physical line could clear the prefix on the preceding NEWLINE/INDENT boundary. If the previous line had an inline comment such as # type: ignore, that comment was lost in the formatted output, causing Black's AST equivalence check to fail because the TypeIgnore node disappeared.

This preserves prefixes on the boundary leaf when they contain comments, while still clearing comment-free whitespace prefixes. A regression case covers the two-line reproducer from the issue.

Tests

  • black --check repro_5138.py (local reproducer)
  • python -m pytest tests/test_format.py -k fmtskip_type_ignore -q
  • python -m pytest tests/test_format.py -k 'fmtskip or type_ignore' -q
  • python -m pytest tests/test_format.py -q
  • black --check src/black/comments.py tests/data/cases/fmtskip_type_ignore.py

Checklist - did you ...

  • Implement any code style changes under the --preview style, following the stability policy?
  • Add an entry in CHANGES.md if necessary?
  • Add / update tests if necessary?
  • Add new / update outdated documentation?

@github-actions

github-actions Bot commented May 18, 2026

Copy link
Copy Markdown
Contributor

diff-shades results comparing this PR (89f2438) to main (5809338):

--preview style: no changes

--stable style: no changes


What is this? | Workflow run | diff-shades documentation

@cobaltt7 cobaltt7 merged commit c970a49 into psf:main May 18, 2026
57 checks passed
luketainton pushed a commit to luketainton/repos_roboluke that referenced this pull request May 23, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<26.5.1,>=26.5.0` → `<26.5.2,>=26.5.1` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.1?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.5.0/26.5.1?slim=true) |

---

### Release Notes

<details>
<summary>psf/black (black)</summary>

### [`v26.5.1`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2651)

[Compare Source](psf/black@26.5.0...26.5.1)

##### Stable style

- Fix unstable formatting of annotated assignments whose subscript annotation contains
  an inline comment (e.g. `x: list[  # pyright: ignore[...]`) ([#&#8203;5130](psf/black#5130))
- Preserve inline comments (including `# type: ignore`) immediately before a
  `# fmt: skip` line, avoiding AST equivalence failures ([#&#8203;5139](psf/black#5139))

##### Packaging

- Correct the version in the published executables ([#&#8203;5137](psf/black#5137))

##### Documentation

- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
  ([#&#8203;5124](psf/black#5124))

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Enabled.

♻ **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 [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xODMuMSIsInVwZGF0ZWRJblZlciI6IjQzLjE4My4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJ0eXBlL2RlcGVuZGVuY2llcyJdfQ==-->

Reviewed-on: https://git.tainton.uk/repos/roboluke/pulls/450
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>
luketainton pushed a commit to luketainton/luke_instant-msg-api that referenced this pull request May 23, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<26.5.1,>=26.5.0` → `<26.5.2,>=26.5.1` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.1?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.5.0/26.5.1?slim=true) |

---

### Release Notes

<details>
<summary>psf/black (black)</summary>

### [`v26.5.1`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2651)

[Compare Source](psf/black@26.5.0...26.5.1)

##### Stable style

- Fix unstable formatting of annotated assignments whose subscript annotation contains
  an inline comment (e.g. `x: list[  # pyright: ignore[...]`) ([#&#8203;5130](psf/black#5130))
- Preserve inline comments (including `# type: ignore`) immediately before a
  `# fmt: skip` line, avoiding AST equivalence failures ([#&#8203;5139](psf/black#5139))

##### Packaging

- Correct the version in the published executables ([#&#8203;5137](psf/black#5137))

##### Documentation

- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
  ([#&#8203;5124](psf/black#5124))

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Enabled.

♻ **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 [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xODMuMSIsInVwZGF0ZWRJblZlciI6IjQzLjE4My4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJ0eXBlL2RlcGVuZGVuY2llcyJdfQ==-->

Reviewed-on: https://git.tainton.uk/luke/instant-msg-api/pulls/260
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 pushed a commit to Swiss-Armed-Forces/Loom that referenced this pull request Jun 6, 2026
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 | minor | `26.3.1` → `26.5.1` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/psf/black/badge)](https://securityscorecards.dev/viewer/?uri=github.com/psf/black) |
| [pytest-asyncio](https://github.com/pytest-dev/pytest-asyncio) ([changelog](https://pytest-asyncio.readthedocs.io/en/stable/reference/changelog.html)) | test | minor | `1.3.0` → `1.4.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/pytest-dev/pytest-asyncio/badge)](https://securityscorecards.dev/viewer/?uri=github.com/pytest-dev/pytest-asyncio) |
| [python-gitlab](https://github.com/python-gitlab/python-gitlab) ([changelog](https://github.com/python-gitlab/python-gitlab/blob/main/CHANGELOG.md)) | dev | minor | `8.3.0` → `8.4.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/python-gitlab/python-gitlab/badge)](https://securityscorecards.dev/viewer/?uri=github.com/python-gitlab/python-gitlab) |

---

### Release Notes

<details>
<summary>psf/black (black)</summary>

### [`v26.5.1`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2651)

[Compare Source](psf/black@26.5.0...26.5.1)

##### Stable style

- Fix unstable formatting of annotated assignments whose subscript annotation contains
  an inline comment (e.g. `x: list[  # pyright: ignore[...]`) ([#&#8203;5130](psf/black#5130))
- Preserve inline comments (including `# type: ignore`) immediately before a
  `# fmt: skip` line, avoiding AST equivalence failures ([#&#8203;5139](psf/black#5139))

##### Packaging

- Correct the version in the published executables ([#&#8203;5137](psf/black#5137))

##### Documentation

- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
  ([#&#8203;5124](psf/black#5124))

### [`v26.5.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2650)

[Compare Source](psf/black@26.3.1...26.5.0)

##### Highlights

- Add support for unpacking in comprehensions (PEP 798) and for lazy imports (PEP 810),
  both new syntactic features in Python 3.15 ([#&#8203;5048](psf/black#5048))
- Python 3.15 is now supported. Compiled wheels are not yet provided for Python 3.15, so
  performance may be slower than on existing Python versions. Wheels will be provided
  once Python 3.15 is later in its release cycle. ([#&#8203;5127](psf/black#5127))

##### Stable style

- Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in`
  clauses ([#&#8203;4903](psf/black#4903))
- Add syntactic support for Python 3.15 ([#&#8203;5048](psf/black#5048))
- Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#&#8203;5097](psf/black#5097))
- Preserve multiline compound statement headers when `# fmt: skip` is placed on the
  colon line ([#&#8203;5117](psf/black#5117))

##### Preview style

- Improve heuristics around whether blank lines should appear before, within and after
  groups of same-name decorated functions (such as `@overload` groups) in `.pyi` stub
  files ([#&#8203;5021](psf/black#5021))
- Fix blank lines being removed between a function and a decorated class in `.pyi` stub
  files ([#&#8203;5092](psf/black#5092))
- Prevent string merger from creating unsplittable long lines when a pragma comment
  (e.g. `# type: ignore`) follows the closing bracket ([#&#8203;5096](psf/black#5096))

##### Packaging

- Run CI on 3.15 ([#&#8203;5127](psf/black#5127))

##### Output

- Improve parse error readability by showing multi-line output with an error pointer.
  ([#&#8203;5068](psf/black#5068))
- Add `SourceASTParseError` to distinguish source parse failures from internal safety
  errors, improving error reporting when Black's lenient parser accepts input that
  `ast.parse()` rejects ([#&#8203;5080](psf/black#5080))

##### *Blackd*

- Return HTTP 400 (Bad Request) for source parse failures instead of HTTP 500, keeping
  HTTP 500 only for genuine internal safety errors ([#&#8203;5080](psf/black#5080))

##### Integrations

- Added documentation for doctest formatting tools and updated the integrations index to
  match ([#&#8203;4916](psf/black#4916))

##### Documentation

- Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs
  ([#&#8203;5063](psf/black#5063))
- Note in the editor integrations that the SublimeText `sublack` plugin is archived and
  unmaintained ([#&#8203;5082](psf/black#5082))

</details>

<details>
<summary>pytest-dev/pytest-asyncio (pytest-asyncio)</summary>

### [`v1.4.0`](https://github.com/pytest-dev/pytest-asyncio/releases/tag/v1.4.0): pytest-asyncio v1.4.0

[Compare Source](pytest-dev/pytest-asyncio@v1.3.0...v1.4.0)

### [1.4.0](https://github.com/pytest-dev/pytest-asyncio/tree/1.4.0) - 2026-05-26

#### Deprecated

- Overriding the *event\_loop\_policy* fixture is deprecated. Use the `pytest_asyncio_loop_factories` hook instead. ([#&#8203;1419](pytest-dev/pytest-asyncio#1419))

#### Added

- Added the `pytest_asyncio_loop_factories` hook to parametrize asyncio tests with custom event loop factories.

  The hook returns a mapping of factory names to loop factories, and `pytest.mark.asyncio(loop_factories=[...])` selects a subset of configured factories per test. When a single factory is configured, test names are unchanged.

  Synchronous `@pytest_asyncio.fixture` functions now see the correct event loop when custom loop factories are configured, even when test code disrupts the current event loop (e.g., via `asyncio.run()` or `asyncio.set_event_loop(None)`). ([#&#8203;1164](pytest-dev/pytest-asyncio#1164))

#### Changed

- Improved the readability of the warning message that is displayed when `asyncio_default_fixture_loop_scope` is unset ([#&#8203;1298](pytest-dev/pytest-asyncio#1298))
- Only import `asyncio.AbstractEventLoopPolicy` for type checking to avoid raising
  a DeprecationWarning. ([#&#8203;1394](pytest-dev/pytest-asyncio#1394))
- Updated minimum supported pytest version to v8.4.0. ([#&#8203;1397](pytest-dev/pytest-asyncio#1397))

#### Fixed

- Fixed a `ResourceWarning: unclosed event loop` warning that could occur when a synchronous test called `asyncio.run()` or otherwise unset the current event loop after pytest-asyncio had run an async test or fixture. ([#&#8203;724](pytest-dev/pytest-asyncio#724))

#### Notes for Downstream Packagers

- Added dependency on `sphinx-tabs >= 3.5` to organize documentation examples into tabs. ([#&#8203;1395](pytest-dev/pytest-asyncio#1395))

</details>

<details>
<summary>python-gitlab/python-gitlab (python-gitlab)</summary>

### [`v8.4.0`](https://github.com/python-gitlab/python-gitlab/blob/HEAD/CHANGELOG.md#v840-2026-05-28)

[Compare Source](python-gitlab/python-gitlab@v8.3.0...v8.4.0)

##### Features

- **const**: Add new Security Manager role
  ([`3738bb2`](python-gitlab/python-gitlab@3738bb2))

##### Testing

- **const**: Add tests for AccessLevel
  ([`2ab6d9f`](python-gitlab/python-gitlab@2ab6d9f))

</details>

---

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

---

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

See merge request swiss-armed-forces/cyber-command/cea/loom!526

Co-authored-by: Loom MR Pipeline Trigger <group_103951964_bot_9504bb8dead6d4e406ad817a607f24be@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.

INTERNAL ERROR on 26.5.0

2 participants