Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pylint] removed dunder methods in Python 3 (PLW3201) #13194

Merged
merged 7 commits into from
Sep 4, 2024
+19 −10
Merged

[pylint] removed dunder methods in Python 3 (PLW3201) #13194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a945357
[pylint] depracted dunder methods in Python 3 (PLW3201)
iamlucasvieira Sep 1, 2024
824a3a4
Remove placeholder dunder methods
iamlucasvieira Sep 2, 2024
f5d5a4b
Add enum for dunder method type
iamlucasvieira Sep 2, 2024
fc9744e
Remove comma in documentation
iamlucasvieira Sep 2, 2024
9fff288
Apply suggestions from code review
MichaReiser Sep 3, 2024
086f6c5
Sort dunder methods by name
MichaReiser Sep 3, 2024
f075343
Remove distinction between mispelled and removed dunder methods
iamlucasvieira Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/pylint/bad_dunder_method_name.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ def __prepare__():
def __mro_entries__(self, bases):
pass

# Removed with Python 3
def __unicode__(self):
pass

def __foo_bar__(): # this is not checked by the [bad-dunder-name] rule
...
6 changes: 3 additions & 3 deletions crates/ruff_linter/src/rules/pylint/rules/bad_dunder_method_name.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ use crate::checkers::ast::Checker;
use crate::rules::pylint::helpers::is_known_dunder_method;

/// ## What it does
/// Checks for misspelled and unknown dunder names in method definitions.
/// Checks for dunder methods that have no special meaning in Python 3.
///
/// ## Why is this bad?
/// Misspelled dunder name methods may cause your code to not function
/// Misspelled or no longer supported dunder name methods may cause your code to not function
/// as expected.
///
/// Since dunder methods are associated with customizing the behavior
Expand Down Expand Up @@ -51,7 +51,7 @@ impl Violation for BadDunderMethodName {
#[derive_message_formats]
fn message(&self) -> String {
let BadDunderMethodName { name } = self;
format!("Bad or misspelled dunder method name `{name}`")
format!("Dunder method `{name}` has no special meaning in Python 3")
}
}

Expand Down
20 changes: 13 additions & 7 deletions ...ylint/snapshots/ruff_linter__rules__pylint__tests__PLW3201_bad_dunder_method_name.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
source: crates/ruff_linter/src/rules/pylint/mod.rs
---
bad_dunder_method_name.py:5:9: PLW3201 Bad or misspelled dunder method name `_init_`
bad_dunder_method_name.py:5:9: PLW3201 Dunder method `_init_` has no special meaning in Python 3
|
4 | class Apples:
5 | def _init_(self): # [bad-dunder-name]
| ^^^^^^ PLW3201
6 | pass
|

bad_dunder_method_name.py:8:9: PLW3201 Bad or misspelled dunder method name `__hello__`
bad_dunder_method_name.py:8:9: PLW3201 Dunder method `__hello__` has no special meaning in Python 3
|
6 | pass
7 |
Expand All @@ -18,7 +18,7 @@ bad_dunder_method_name.py:8:9: PLW3201 Bad or misspelled dunder method name `__h
9 | print("hello")
|

bad_dunder_method_name.py:11:9: PLW3201 Bad or misspelled dunder method name `__init_`
bad_dunder_method_name.py:11:9: PLW3201 Dunder method `__init_` has no special meaning in Python 3
|
9 | print("hello")
10 |
Expand All @@ -28,7 +28,7 @@ bad_dunder_method_name.py:11:9: PLW3201 Bad or misspelled dunder method name `__
13 | pass
|

bad_dunder_method_name.py:15:9: PLW3201 Bad or misspelled dunder method name `_init_`
bad_dunder_method_name.py:15:9: PLW3201 Dunder method `_init_` has no special meaning in Python 3
|
13 | pass
14 |
Expand All @@ -38,7 +38,7 @@ bad_dunder_method_name.py:15:9: PLW3201 Bad or misspelled dunder method name `_i
17 | pass
|

bad_dunder_method_name.py:19:9: PLW3201 Bad or misspelled dunder method name `___neg__`
bad_dunder_method_name.py:19:9: PLW3201 Dunder method `___neg__` has no special meaning in Python 3
|
17 | pass
18 |
Expand All @@ -48,7 +48,7 @@ bad_dunder_method_name.py:19:9: PLW3201 Bad or misspelled dunder method name `__
21 | pass
|

bad_dunder_method_name.py:23:9: PLW3201 Bad or misspelled dunder method name `__inv__`
bad_dunder_method_name.py:23:9: PLW3201 Dunder method `__inv__` has no special meaning in Python 3
|
21 | pass
22 |
Expand All @@ -58,4 +58,10 @@ bad_dunder_method_name.py:23:9: PLW3201 Bad or misspelled dunder method name `__
25 | pass
|


bad_dunder_method_name.py:98:9: PLW3201 Dunder method `__unicode__` has no special meaning in Python 3
|
97 | # Removed with Python 3
98 | def __unicode__(self):
| ^^^^^^^^^^^ PLW3201
99 | pass
|
Loading