Added documentation for doctest formatting tools by samuelikohn · Pull Request #4916 · psf/black

samuelikohn · 2025-12-24T02:29:44Z

Description

Addresses issue #3083. Adds a documentation page under integration for tools that can apply Black formatting to doctests. This is meant to inform users of 3rd party tools that cover functionality not covered by Black. New doc page includes a brief description of blackdoc and blacken-docs. The integrations index page was also updated to list this new page.

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?
Updated CHANGES.md
Confirmed documentation pages build as expected

…grations index to match (psf#4914)

for more information, see https://pre-commit.ci

…into fix-issue-3083

for more information, see https://pre-commit.ci

cobaltt7 · 2025-12-24T20:59:34Z

I'm a bit hesitant about advertising small third-party tools that integrate directly with Black. One issue that comes to mind (beyond the obvious security concerns) is #4757, where a similar small project started crashing after we changed our public API, which is not stable or covered under semver (see #779).

Do the maintainers of these packages know that we're considering linking to them on our docs?

samuelikohn · 2025-12-26T22:42:06Z

I'm a bit hesitant about advertising small third-party tools that integrate directly with Black. One issue that comes to mind (beyond the obvious security concerns) is #4757, where a similar small project started crashing after we changed our public API, which is not stable or covered under semver (see #779).

Do the maintainers of these packages know that we're considering linking to them on our docs?

That's a fair point. My interpretation of the discussion around #3083 was that this would be a nice-to-have. The wording can certainly be changed, but based on the issues you brought up it may be best to scrap the issue altogether. But afaik the maintainers haven't been contacted.

keewis · 2026-02-15T22:42:18Z

Do the maintainers of these packages know that we're considering linking to them on our docs?

Speaking as the maintainer of blackdoc I'm aware now, and would totally be fine with it.

I'm also aware that black doesn't have a stable public API, such that changes in black may end up causing errors downstream. However, that's nothing new, it has been that way ever since I created blackdoc almost 5 years ago, and would typically cause a brief period of being incompatible with the newest black until I've had the time to merge and release a fix (which thankfully doesn't happen very often, so I didn't have to release much more than once a year).

Also, since I have seen claims that blackdoc is not actively maintained: it is maintained, but reactions may be delayed depending on how much free time I have (I'm maintaining it on my own), although I will try to prioritize anything urgent.

beyond the obvious security concerns

can you say a bit more about what you're referring to with this? Any of the downstream packages are clearly separate packages, and by using them you'd have to trust both black and the downstream project's maintainers.

I would add a note to the docs above stating that these are not officially supported, and any issues should be raised there first.

hauntsaninja

blacken-docs is much more well known / popular, so if we merge this i would prefer if we mention that one first

cobaltt7 · 2026-04-12T18:57:53Z

My main concern was advertising other projects could seem like an endorsement, and I wasn't sure if Black would be in hot water if one of the projects it advertised was turned into some sort of malware. However, I recently realized that Black already advertises projects in this way (see Using Black with other tools and Editor integration) so it's probably fine. Additionally, Black users are probably more technical and more aware of the risks of installing programs compared to the users of other projects I've maintained in the past that I was thinking about when I made my previous comment.

Signed-off-by: cobalt <61329810+cobaltt7@users.noreply.github.com>

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.3.2,>=26.3.1` → `<26.5.1,>=26.5.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.3.1/26.5.0?slim=true) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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 ([#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. ([#5127](psf/black#5127)) ##### Stable style - Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in` clauses ([#4903](psf/black#4903)) - Add syntactic support for Python 3.15 ([#5048](psf/black#5048)) - Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#5097](psf/black#5097)) - Preserve multiline compound statement headers when `# fmt: skip` is placed on the colon line ([#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 ([#5021](psf/black#5021)) - Fix blank lines being removed between a function and a decorated class in `.pyi` stub files ([#5092](psf/black#5092)) - Prevent string merger from creating unsplittable long lines when a pragma comment (e.g. `# type: ignore`) follows the closing bracket ([#5096](psf/black#5096)) ##### Packaging - Run CI on 3.15 ([#5127](psf/black#5127)) ##### Output - Improve parse error readability by showing multi-line output with an error pointer. ([#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 ([#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 ([#5080](psf/black#5080)) ##### Integrations - Added documentation for doctest formatting tools and updated the integrations index to match ([#4916](psf/black#4916)) ##### Documentation - Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs ([#5063](psf/black#5063)) - Note in the editor integrations that the SublimeText `sublack` plugin is archived and unmaintained ([#5082](psf/black#5082)) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/repos/webexmemebot/pulls/585 Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk> Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>

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.3.2,>=26.3.1` → `<26.5.1,>=26.5.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.3.1/26.5.0?slim=true) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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 ([#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. ([#5127](psf/black#5127)) ##### Stable style - Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in` clauses ([#4903](psf/black#4903)) - Add syntactic support for Python 3.15 ([#5048](psf/black#5048)) - Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#5097](psf/black#5097)) - Preserve multiline compound statement headers when `# fmt: skip` is placed on the colon line ([#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 ([#5021](psf/black#5021)) - Fix blank lines being removed between a function and a decorated class in `.pyi` stub files ([#5092](psf/black#5092)) - Prevent string merger from creating unsplittable long lines when a pragma comment (e.g. `# type: ignore`) follows the closing bracket ([#5096](psf/black#5096)) ##### Packaging - Run CI on 3.15 ([#5127](psf/black#5127)) ##### Output - Improve parse error readability by showing multi-line output with an error pointer. ([#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 ([#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 ([#5080](psf/black#5080)) ##### Integrations - Added documentation for doctest formatting tools and updated the integrations index to match ([#4916](psf/black#4916)) ##### Documentation - Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs ([#5063](psf/black#5063)) - Note in the editor integrations that the SublimeText `sublack` plugin is archived and unmaintained ([#5082](psf/black#5082)) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/repos/PwnedPW/pulls/334 Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk> Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>

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.3.2,>=26.3.1` → `<26.5.1,>=26.5.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.3.1/26.5.0?slim=true) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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 ([#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. ([#5127](psf/black#5127)) ##### Stable style - Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in` clauses ([#4903](psf/black#4903)) - Add syntactic support for Python 3.15 ([#5048](psf/black#5048)) - Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#5097](psf/black#5097)) - Preserve multiline compound statement headers when `# fmt: skip` is placed on the colon line ([#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 ([#5021](psf/black#5021)) - Fix blank lines being removed between a function and a decorated class in `.pyi` stub files ([#5092](psf/black#5092)) - Prevent string merger from creating unsplittable long lines when a pragma comment (e.g. `# type: ignore`) follows the closing bracket ([#5096](psf/black#5096)) ##### Packaging - Run CI on 3.15 ([#5127](psf/black#5127)) ##### Output - Improve parse error readability by showing multi-line output with an error pointer. ([#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 ([#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 ([#5080](psf/black#5080)) ##### Integrations - Added documentation for doctest formatting tools and updated the integrations index to match ([#4916](psf/black#4916)) ##### Documentation - Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs ([#5063](psf/black#5063)) - Note in the editor integrations that the SublimeText `sublack` plugin is archived and unmaintained ([#5082](psf/black#5082)) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/repos/epage/pulls/220 Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk> Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>

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.3.2,>=26.3.1` → `<26.5.1,>=26.5.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.3.1/26.5.0?slim=true) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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 ([#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. ([#5127](psf/black#5127)) ##### Stable style - Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in` clauses ([#4903](psf/black#4903)) - Add syntactic support for Python 3.15 ([#5048](psf/black#5048)) - Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#5097](psf/black#5097)) - Preserve multiline compound statement headers when `# fmt: skip` is placed on the colon line ([#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 ([#5021](psf/black#5021)) - Fix blank lines being removed between a function and a decorated class in `.pyi` stub files ([#5092](psf/black#5092)) - Prevent string merger from creating unsplittable long lines when a pragma comment (e.g. `# type: ignore`) follows the closing bracket ([#5096](psf/black#5096)) ##### Packaging - Run CI on 3.15 ([#5127](psf/black#5127)) ##### Output - Improve parse error readability by showing multi-line output with an error pointer. ([#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 ([#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 ([#5080](psf/black#5080)) ##### Integrations - Added documentation for doctest formatting tools and updated the integrations index to match ([#4916](psf/black#4916)) ##### Documentation - Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs ([#5063](psf/black#5063)) - Note in the editor integrations that the SublimeText `sublack` plugin is archived and unmaintained ([#5082](psf/black#5082)) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/luke/instant-msg-api/pulls/258 Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk> Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>

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.3.2,>=26.3.1` → `<26.5.1,>=26.5.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.3.1/26.5.0?slim=true) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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 ([#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. ([#5127](psf/black#5127)) ##### Stable style - Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in` clauses ([#4903](psf/black#4903)) - Add syntactic support for Python 3.15 ([#5048](psf/black#5048)) - Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#5097](psf/black#5097)) - Preserve multiline compound statement headers when `# fmt: skip` is placed on the colon line ([#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 ([#5021](psf/black#5021)) - Fix blank lines being removed between a function and a decorated class in `.pyi` stub files ([#5092](psf/black#5092)) - Prevent string merger from creating unsplittable long lines when a pragma comment (e.g. `# type: ignore`) follows the closing bracket ([#5096](psf/black#5096)) ##### Packaging - Run CI on 3.15 ([#5127](psf/black#5127)) ##### Output - Improve parse error readability by showing multi-line output with an error pointer. ([#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 ([#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 ([#5080](psf/black#5080)) ##### Integrations - Added documentation for doctest formatting tools and updated the integrations index to match ([#4916](psf/black#4916)) ##### Documentation - Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs ([#5063](psf/black#5063)) - Note in the editor integrations that the SublimeText `sublack` plugin is archived and unmaintained ([#5082](psf/black#5082)) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/repos/pypilot/pulls/446 Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk> Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>

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.3.2,>=26.3.1` → `<26.5.1,>=26.5.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.3.1/26.5.0?slim=true) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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 ([#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. ([#5127](psf/black#5127)) ##### Stable style - Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in` clauses ([#4903](psf/black#4903)) - Add syntactic support for Python 3.15 ([#5048](psf/black#5048)) - Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#5097](psf/black#5097)) - Preserve multiline compound statement headers when `# fmt: skip` is placed on the colon line ([#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 ([#5021](psf/black#5021)) - Fix blank lines being removed between a function and a decorated class in `.pyi` stub files ([#5092](psf/black#5092)) - Prevent string merger from creating unsplittable long lines when a pragma comment (e.g. `# type: ignore`) follows the closing bracket ([#5096](psf/black#5096)) ##### Packaging - Run CI on 3.15 ([#5127](psf/black#5127)) ##### Output - Improve parse error readability by showing multi-line output with an error pointer. ([#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 ([#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 ([#5080](psf/black#5080)) ##### Integrations - Added documentation for doctest formatting tools and updated the integrations index to match ([#4916](psf/black#4916)) ##### Documentation - Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs ([#5063](psf/black#5063)) - Note in the editor integrations that the SublimeText `sublack` plugin is archived and unmaintained ([#5082](psf/black#5082)) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/repos/roboluke/pulls/448 Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk> Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>

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[...]`) ([#5130](psf/black#5130)) - Preserve inline comments (including `# type: ignore`) immediately before a `# fmt: skip` line, avoiding AST equivalence failures ([#5139](psf/black#5139)) ##### Packaging - Correct the version in the published executables ([#5137](psf/black#5137)) ##### Documentation - Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches ([#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 ([#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. ([#5127](psf/black#5127)) ##### Stable style - Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in` clauses ([#4903](psf/black#4903)) - Add syntactic support for Python 3.15 ([#5048](psf/black#5048)) - Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#5097](psf/black#5097)) - Preserve multiline compound statement headers when `# fmt: skip` is placed on the colon line ([#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 ([#5021](psf/black#5021)) - Fix blank lines being removed between a function and a decorated class in `.pyi` stub files ([#5092](psf/black#5092)) - Prevent string merger from creating unsplittable long lines when a pragma comment (e.g. `# type: ignore`) follows the closing bracket ([#5096](psf/black#5096)) ##### Packaging - Run CI on 3.15 ([#5127](psf/black#5127)) ##### Output - Improve parse error readability by showing multi-line output with an error pointer. ([#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 ([#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 ([#5080](psf/black#5080)) ##### Integrations - Added documentation for doctest formatting tools and updated the integrations index to match ([#4916](psf/black#4916)) ##### Documentation - Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs ([#5063](psf/black#5063)) - Note in the editor integrations that the SublimeText `sublack` plugin is archived and unmaintained ([#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. ([#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)`). ([#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 ([#1298](pytest-dev/pytest-asyncio#1298)) - Only import `asyncio.AbstractEventLoopPolicy` for type checking to avoid raising a DeprecationWarning. ([#1394](pytest-dev/pytest-asyncio#1394)) - Updated minimum supported pytest version to v8.4.0. ([#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. ([#724](pytest-dev/pytest-asyncio#724)) #### Notes for Downstream Packagers - Added dependency on `sphinx-tabs >= 3.5` to organize documentation examples into tabs. ([#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> --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).  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>

samuelikohn and others added 2 commits December 23, 2025 21:17

Added documentation for doctest formatting tools and updated the inte…

42b03fa

…grations index to match (psf#4914)

[pre-commit.ci] auto fixes from pre-commit.com hooks

216aedf

for more information, see https://pre-commit.ci

samuelikohn changed the title ~~Added documentation for doctest formatting tools and updated the integrations index to match (#4914)~~ Added documentation for doctest formatting tools Dec 24, 2025

samuelikohn and others added 3 commits December 24, 2025 15:22

Fixed PR number in changelog

9b60a18

Merge branch 'fix-issue-3083' of https://github.com/samuelikohn/black …

547612e

…into fix-issue-3083

[pre-commit.ci] auto fixes from pre-commit.com hooks

c725704

for more information, see https://pre-commit.ci

cobaltt7 linked an issue Jan 1, 2026 that may be closed by this pull request

Documentation: mention tools that can do doctests formatting #3083

Closed

samuelikohn closed this Jan 3, 2026

samuelikohn deleted the fix-issue-3083 branch January 3, 2026 02:10

samuelikohn restored the fix-issue-3083 branch January 3, 2026 02:10

samuelikohn reopened this Jan 3, 2026

Merge branch 'main' into fix-issue-3083

a70a650

cobaltt7 mentioned this pull request Feb 15, 2026

Docs: Add documentation for doctest formatting tools #4986

Closed

cobaltt7 mentioned this pull request Mar 6, 2026

Add FAQ entry about doctest formatting #5017

Closed

hauntsaninja reviewed Mar 9, 2026

View reviewed changes

cobaltt7 mentioned this pull request Mar 17, 2026

docs: mention blacken-docs for doctest formatting #5054

Closed

reorder sections

584f0b6

Signed-off-by: cobalt <61329810+cobaltt7@users.noreply.github.com>

cobaltt7 merged commit 06e496a into psf:main Apr 12, 2026
12 checks passed

samuelikohn deleted the fix-issue-3083 branch April 12, 2026 19:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added documentation for doctest formatting tools#4916

Added documentation for doctest formatting tools#4916
cobaltt7 merged 7 commits into
psf:mainfrom
samuelikohn:fix-issue-3083

samuelikohn commented Dec 24, 2025

Uh oh!

cobaltt7 commented Dec 24, 2025 •

edited

Loading

Uh oh!

samuelikohn commented Dec 26, 2025

Uh oh!

keewis commented Feb 15, 2026 •

edited

Loading

Uh oh!

hauntsaninja left a comment

Uh oh!

cobaltt7 commented Apr 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

samuelikohn commented Dec 24, 2025

Description

Checklist - did you ...

Uh oh!

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

Uh oh!

Uh oh!

samuelikohn commented Dec 26, 2025

Uh oh!

keewis commented Feb 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hauntsaninja left a comment

Choose a reason for hiding this comment

Uh oh!

cobaltt7 commented Apr 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cobaltt7 commented Dec 24, 2025 •

edited

Loading

keewis commented Feb 15, 2026 •

edited

Loading