Fix bug where module docstrings would be treated as normal strings if preceded by comments #4764
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…f preceeded by comments This happened because the code didn't account for comments before module doc strings. Since there can be arbitrarily many, this PR pulls the check into a new function so a while loop could go through all the previous blocks until either the start of the file is found, or a non comment block is reached. A new test was also added.
… it always uses unstable)
cobaltt7
approved these changes
Sep 25, 2025
luketainton
pushed a commit
to luketainton/roboluke-tasks
that referenced
this pull request
Nov 10, 2025
This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<25.9.1,>=25.9.0` -> `<25.11.1,>=25.11.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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)) </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:eyJjcmVhdGVkSW5WZXIiOiI0Mi4yLjAiLCJ1cGRhdGVkSW5WZXIiOiI0Mi4yLjAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbInR5cGUvZGVwZW5kZW5jaWVzIl19--> Reviewed-on: https://git.tainton.uk/repos/roboluke/pulls/393 Co-authored-by: renovate[bot] <[email protected]> Co-committed-by: renovate[bot] <[email protected]>
luketainton
pushed a commit
to luketainton/epage
that referenced
this pull request
Nov 10, 2025
This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<25.9.1,>=25.9.0` -> `<25.11.1,>=25.11.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`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)) </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:eyJjcmVhdGVkSW5WZXIiOiI0Mi4yLjAiLCJ1cGRhdGVkSW5WZXIiOiI0Mi4yLjAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbInR5cGUvZGVwZW5kZW5jaWVzIl19--> Reviewed-on: https://git.tainton.uk/repos/epage/pulls/176 Co-authored-by: renovate[bot] <[email protected]> Co-committed-by: renovate[bot] <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This happened because the code didn't account for comments before module docstrings. Since there can be arbitrarily many, this PR pulls the check into a new function so a while loop could go through all the previous blocks until either the start of the file is found, or a non comment block is reached.
A new test was added.
Fixes #4762
Code put in preview to not change the stable style.
Checklist - did you ...
--previewstyle, following thestability policy?
CHANGES.mdif necessary?