chore: bump docformatter to v1.7.8#381
Closed
gencurrent wants to merge 2 commits into
Closed
Conversation
gencurrent
force-pushed
the
fix/bump-docformatter-v1.7.8
branch
2 times, most recently
from
953d914 to
bca3a92
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #381 +/- ##
=======================================
Coverage 99.95% 99.95%
=======================================
Files 16 16
Lines 2109 2109
Branches 251 251
=======================================
Hits 2108 2108
Partials 1 1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
Borda
reviewed
May 25, 2026
| - id: docformatter | ||
| additional_dependencies: [tomli] | ||
| args: ["--in-place"] | ||
| # docformatter v1.7.8 disagrees with ruff-format on these files |
shaypal5
force-pushed
the
fix/bump-docformatter-v1.7.8
branch
from
bca3a92 to
3c9d4cb
Compare
This was referenced Jun 3, 2026
shaypal5
added
dependencies
shaypal5
changed the base branch from
master
to
codex/docformatter-comment-cleanup
v1.7.8 drops the unmaintained `untokenize` dependency (replaced by stdlib `tokenize`), which was failing to install on Python 3.12+ runners due to `ast.Constant.s` removal. This unblocks pre-commit.ci without the `ci.skip: [docformatter]` workaround added in python-cachier#376. v1.7.8 also introduced stricter docstring formatting decisions that conflict with ruff-format on a few patterns: - blank lines after docstring-only function bodies (prometheus.py) - blank lines between module docstring and first class (clients.py) - multi-line string literals used as `exec()` arguments that docformatter mistakes for docstrings (test_varargs.py) The 3 affected files are excluded from docformatter via a regex `exclude:` in the hook config until upstream reconciles the conventions or the patterns are restructured. Includes docstring rewrapping in 4 files (core.py, cores/base.py, conftest.py, test_general.py) that v1.7.8's defaults now produce. test_general.py also has misplaced docstring-style strings inside function bodies converted to `#` comments to fix oscillation with ruff-format.
shaypal5
force-pushed
the
fix/bump-docformatter-v1.7.8
branch
from
3502958 to
36423bd
Compare
shaypal5
force-pushed
the
codex/docformatter-comment-cleanup
branch
from
137d26e to
8d412c9
Compare
Member
|
Closed for now because of irrelevant doc fixes bolted on to the PR (I merged those in a separate PR). @gencurrent , please reopen this over an updated main. |
2 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Summary
docformatterfromv1.7.7tov1.7.8in.pre-commit-config.yaml.ci.skip: [docformatter]workaround added in fix(typing): preserve decorated function type signatures with ParamSpec #376.Why
docformatter v1.7.7transitively depended on the unmaintaineduntokenizepackage, whosesetup.pyusesast.Constant.s(removed in Python 3.12+). This caused fresh installs on pre-commit.ci to fail with:PyCQA/docformatter#325 replaced
untokenizewith stdlibtokenize, and that fix shipped inv1.7.8.Relationship to #385
#385 contains the cosmetic docstring/comment cleanup that
docformatter v1.7.8surfaces in existing files. Merge #385 first, then this PR can remain focused on the dependency and hook configuration change.Test plan
pre-commit run docformatter --all-filespre-commit run --all-filespre-commit.ci - prcheck passes