[pylint] removed dunder methods in Python 3 (PLW3201) #13194
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
Add message for when the dunder method name is no longer valid in Python 3.
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| PLW3201 | 230 | 115 | 115 | 0 | 0 |
AlexWaygood
changed the title
|
|
MichaReiser
added
rule
MichaReiser
approved these changes
Sep 2, 2024
crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs
Outdated
Show resolved
Hide resolved
|
Thanks, this is looking great |
|
Shocked this isn't already covered by a pyupgrade rule |
MichaReiser
reviewed
Sep 3, 2024
| match kind { | ||
| Kind::Misspelled => format!("Bad or misspelled dunder method name `{name}`"), | ||
| Kind::RemovedInPython3 => { | ||
| format!("Python 2 or older only dunder method name `{name}`") |
There was a problem hiding this comment.
@AlexWaygood any suggestion on how to improve the wording here? It's kind of hard to read
There was a problem hiding this comment.
I think removing the 'only' makes it read a bit smoother, but it might change the meaning slightly.
There was a problem hiding this comment.
Maybe something like this?
Suggested change
| format!("Python 2 or older only dunder method name `{name}`") | |
| format!("Dunder method `{name}` has no special meaning in Python 3") |
Though actually, that's a pretty good description of what the problem is in both cases. I wonder if we need to distinguish between misspelled dunder methods and those that were removed in Python 3 at all, or if we could just improve the docs (like this PR already does) and use a better error message here that applies to both cases? In both cases -- whether you've misspelled a dunder or you're using one that had its special semantics removed in Python 3 -- it's not going to cause any kind of exception to define the dunder method. It's just probably not going to do what you want, because it doesn't have any special semantics attached to it anymore.
There was a problem hiding this comment.
@MichaReiser What do you think about a single message for both cases?
There was a problem hiding this comment.
A bit dissatisfying after all the hard work you put into this but I do like the suggested message.
There was a problem hiding this comment.
No problem, I also agree 😄
MichaReiser
reviewed
Sep 3, 2024
crates/ruff_linter/resources/test/fixtures/pylint/bad_dunder_method_name.py
Outdated
Show resolved
Hide resolved
MichaReiser
reviewed
Sep 3, 2024
...s/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW3201_bad_dunder_method_name.py.snap
Outdated
Show resolved
Hide resolved
MichaReiser
approved these changes
Sep 3, 2024
MichaReiser
changed the title
MichaReiser
added
preview
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Summary
Add message for deprecated dunder methods not supported in Python 3
This PR addresses issue #12883 by adding custom messages in
PLW3201for dunder methods that were deprecated in Python 2 and are no longer valid in Python 3. The message is displayed for the dunder methods listed in #12607 and additional methods that are no longer part of Python 3 documentation:__iop____rop____op__fixes #12883
Test Plan
New snapshot added and
cargo test