Fix type annotations on template decorators #1211
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
alicederyn
requested review from
flaviuvadan,
sambhav and
elliotgunton
as code owners
alicederyn
added
semver:patch
Use `Concatenate` to add the missing `self` parameter to the class methods annotated with `@_add_type_hints` in `TemplateDecoratorFuncsMixin`. Without this, mypy raises a `misc` error on usage, complaining that the method "does not accept self argument". Signed-off-by: Alice Purcell <alicederyn@gmail.com>
alicederyn
force-pushed
the
fix.template.decorator.annotation
branch
from
02f7c4e to
884a6cc
Compare
alicederyn
commented
Sep 25, 2024
| @@ -474,7 +475,10 @@ def _add_type_hints( | |||
| ) -> Callable[ | |||
| ..., | |||
| Callable[ | |||
| PydanticKwargs, # this adds type hints to the underlying *library* function kwargs | |||
| Concatenate[ | |||
| object, # this is the `self` parameter | |||
There was a problem hiding this comment.
I tried to capture the correct class type from the decorated function, but couldn't find a way to do it that didn't break both mypy and pyright. I verified that both mypy and pyright are happy with object. (Any also seems to work if that's preferred.)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1211 +/- ##
=======================================
+ Coverage 81.7% 86.0% +4.2%
=======================================
Files 54 60 +6
Lines 4208 4040 -168
Branches 889 840 -49
=======================================
+ Hits 3439 3475 +36
+ Misses 574 392 -182
+ Partials 195 173 -22 ☔ View full report in Codecov by Sentry. |
elliotgunton
approved these changes
Sep 27, 2024
elliotgunton
added
type:task
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.
Pull Request Checklist
Description of PR
Currently, mypy raises a
miscerror when using a decorator fromTemplateDecoratorFuncsMixin, complaining that the method "does not accept self argument".This PR uses
Concatenateto add the missing parameter.