chore: isolate docformatter cleanup#385
Merged
Merged
Conversation
This was referenced Jun 3, 2026
shaypal5
force-pushed
the
codex/docformatter-comment-cleanup
branch
from
137d26e to
8d412c9
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #385 +/- ##
=======================================
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:
|
2 tasks
shaypal5
pushed a commit
that referenced
this pull request
Jun 7, 2026
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 #376. v1.7.8 also introduces stricter docstring decisions that conflict with ruff-format on a few patterns (see PyCQA/docformatter#354): - 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. The cosmetic docstring/comment cleanup that v1.7.8's defaults surface on already-conformant files was merged separately in #385.
shaypal5
added
AI & Agents
area: agent-workflows
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
1 participant
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
Closes #384.
Validation
ruff check src/cachier/core.py src/cachier/cores/base.py tests/conftest.py tests/test_general.pypytest tests/test_general.py -m "not mongo"pytest tests/test_general.pyThe full
tests/test_general.pyrun passed 32 cases and failed the 4 Mongo-marked cases locally becausepymongo_inmemorytriggers a Python 3.12tarfileDeprecationWarningunder warnings-as-errors while extracting its embedded MongoDB archive.Current CI note
GitHub Actions
pre-commitis currently failing before reaching this cleanup because the existing mutabletyposhook rev (v1) resolves totypos==1.47.1, which is not available on PyPI.pre-commit.ci - prpasses on this branch.Relationship to #381
This PR carries the cosmetic cleanup that docformatter v1.7.8 would otherwise introduce in #381. #381 is stacked on this branch and now shows only the docformatter hook bump/config change.