[pylint] Implement singledispatch-method (E1519)#10140
Merged
charliermarsh merged 4 commits intoMar 1, 2024
Merged
Conversation
Glyphack
force-pushed
the
pytlint/singledispatch-method-E1519
branch
2 times, most recently
from
bf7f97b to
3a5e666
Compare
Glyphack
changed the title
Glyphack
force-pushed
the
pytlint/singledispatch-method-E1519
branch
from
3a5e666 to
3111e95
Compare
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| PLR0917 | 2 | 0 | 2 | 0 | 0 |
| PLR0904 | 1 | 0 | 1 | 0 | 0 |
sbrugman
reviewed
Feb 29, 2024
| /// Checks for singledispatch decorators on class methods. | ||
| /// | ||
| /// ## Why is this bad? | ||
| /// Single dispatch must happen on the type of first non self argument |
Contributor
There was a problem hiding this comment.
Example code is helpful here. Take a look at other rules to see the format. The pylint docs contains examples to use.
You can also link the Python documentation of singledispatchmethod
|
|
||
| @singledispatch # [singledispatch-method] | ||
| def move(self, position): | ||
| pass |
Contributor
There was a problem hiding this comment.
Is it possible to catch @funcname.register as the pylint rule does?
Even if not, it would be good to include those examples in the tests in case we can do it in the future.
Member
There was a problem hiding this comment.
Probably a bit harder (but possible) to catch @funcname.register, but agree we should add tests for it with commentary.
charliermarsh
added
rule
charliermarsh
changed the title
pylint] Implement singledispatch-method (E1519)
Member
|
Gonna address feedback and merge. |
charliermarsh
force-pushed
the
pytlint/singledispatch-method-E1519
branch
from
1c52b00 to
1dbb6ae
Compare
charliermarsh
approved these changes
Mar 1, 2024
charliermarsh
force-pushed
the
pytlint/singledispatch-method-E1519
branch
from
1dbb6ae to
6702c4d
Compare
charliermarsh
force-pushed
the
pytlint/singledispatch-method-E1519
branch
from
3d75d73 to
c814776
Compare
Contributor
Author
|
Thanks for addressing the comments 😃 |
nkxxll
pushed a commit
to nkxxll/ruff
that referenced
this pull request
Mar 10, 2024
Implementing the rule https://pylint.readthedocs.io/en/stable/user_guide/messages/error/singledispatch-method.html#singledispatch-method-e1519 Implementation simply checks the function type and name of the decorators.
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.
Implementing the rule
https://pylint.readthedocs.io/en/stable/user_guide/messages/error/singledispatch-method.html#singledispatch-method-e1519
Implementation simply checks the function type and name of the decorators.