-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
[Ruff 0.6] Stabilise 9 pylint rules #12857
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,30 +11,36 @@ use crate::checkers::ast::Checker; | |
/// Checks for assignment of `self` and `cls` in instance and class methods respectively. | ||
/// | ||
/// ## Why is this bad? | ||
/// The identifiers `self` and `cls` are conventional in Python for the first argument of instance | ||
/// methods and class methods, respectively. | ||
/// The identifiers `self` and `cls` are conventional in Python for the first parameter of instance | ||
/// methods and class methods, respectively. Assigning new values to these variables can be | ||
/// confusing for others reading your code; using a different variable name can lead to clearer | ||
/// code. | ||
/// | ||
/// ## Example | ||
/// | ||
/// ```python | ||
/// class Versions: | ||
/// def add(self, version): | ||
/// self = version | ||
/// class Version: | ||
/// def add(self, other): | ||
/// self = self + other | ||
/// return self | ||
/// | ||
/// @classmethod | ||
/// def from_list(cls, versions): | ||
/// cls = versions | ||
/// def superclass(cls): | ||
/// cls = cls.__mro__[-1] | ||
/// return cls | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// class Versions: | ||
/// def add(self, version): | ||
/// self.versions.append(version) | ||
/// class Version: | ||
/// def add(self, other): | ||
/// new_version = self + other | ||
/// return new_version | ||
/// | ||
/// @classmethod | ||
/// def from_list(cls, versions): | ||
/// return cls(versions) | ||
/// def superclass(cls): | ||
/// supercls = cls.__mro__[-1] | ||
/// return supercls | ||
/// ``` | ||
#[violation] | ||
pub struct SelfOrClsAssignment { | ||
|
@@ -47,10 +53,14 @@ impl Violation for SelfOrClsAssignment { | |
let SelfOrClsAssignment { method_type } = self; | ||
|
||
format!( | ||
"Invalid assignment to `{}` argument in {method_type} method", | ||
"Confusing assignment to `{}` argument in {method_type} method", | ||
method_type.arg_name(), | ||
) | ||
} | ||
|
||
fn fix_title(&self) -> Option<String> { | ||
Some("Consider using a different variable name".to_string()) | ||
} | ||
Comment on lines
+60
to
+63
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is clever ;) |
||
} | ||
|
||
/// PLW0127 | ||
|
@@ -130,7 +140,7 @@ enum MethodType { | |
} | ||
|
||
impl MethodType { | ||
fn arg_name(self) -> &'static str { | ||
const fn arg_name(self) -> &'static str { | ||
match self { | ||
MethodType::Instance => "self", | ||
MethodType::Class => "cls", | ||
|
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another option could be "Re-assigned
{}
argument in {method_type} method"There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, that's better. Much more descriptive. I'll make another PR 😄