Add pre-commit check for docstring param types #21398
Merged
Conversation
This file contains 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
dstandish
requested review from
ashb,
jedcunningham,
mik-laj,
potiuk and
turbaszek
as code owners
boring-cyborg
bot
added
area:dev-tools
area:providers
provider:google
|
Hats off to @ashb for the original find! |
ashb
reviewed
Feb 7, 2022
ashb
approved these changes
Feb 7, 2022
github-actions
bot
added
the
full tests needed
|
The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease. |
jedcunningham
approved these changes
Feb 7, 2022
potiuk
approved these changes
Feb 7, 2022
dstandish
force-pushed
the
docstring-type-pre-commit
branch
from
df7569d
to
1d1c196
Compare
mik-laj
reviewed
Feb 7, 2022
|
|
||
| def _check_file(file: Path) -> list: | ||
| content = file.read_text() | ||
| return re.findall(r' +\:type .+?\:', content) |
There was a problem hiding this comment.
Can you add a check for rtype (return type) also?
There was a problem hiding this comment.
Apparently we can't do rtype at this time because not supported by sphinx
I'll try and link relevant pr comment later
There was a problem hiding this comment.
see description here #21014 (comment)
dstandish
force-pushed
the
docstring-type-pre-commit
branch
from
1d1c196
to
3883007
Compare
Param types can now be inferred by sphinx from type annotations, so we no longer need them in docstrings. This pre-commit check fails when type declarations are included in docstrings, and seems to do a reasonable job of not catching false positives.
dstandish
force-pushed
the
docstring-type-pre-commit
branch
from
3883007
to
4dc66b6
Compare
jedcunningham
added
the
changelog:skip
84 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Param types can now be inferred by sphinx from type annotations, so we no longer need them in docstrings.
This pre-commit check fails when type declarations are included in docstrings, and seems to do a reasonable job of not catching false positives.
@josh-fell your catches inspired me