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.

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

[flake8-return] Exempt properties from explicit return rule (RET501) #12243

Merged
merged 6 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ def get(self, key: str) -> str | None:
def get(self, key: str) -> None:
print(f"{key} not found")
return None

@property
def prop(self) -> None:
print("Property not found")
return None
7 changes: 6 additions & 1 deletion crates/ruff_linter/src/checkers/ast/analyze/statement.rs
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,12 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) {
Rule::SuperfluousElseContinue,
Rule::SuperfluousElseBreak,
]) {
flake8_return::rules::function(checker, body, returns.as_ref().map(AsRef::as_ref));
flake8_return::rules::function(
checker,
body,
decorator_list,
returns.as_ref().map(AsRef::as_ref),
);
}
if checker.enabled(Rule::UselessReturn) {
pylint::rules::useless_return(
Expand Down
29 changes: 22 additions & 7 deletions crates/ruff_linter/src/rules/flake8_return/rules/function.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use ruff_python_ast::helpers::{is_const_false, is_const_true};
use ruff_python_ast::stmt_if::elif_else_range;
use ruff_python_ast::visitor::Visitor;
use ruff_python_ast::whitespace::indentation;
use ruff_python_ast::{self as ast, ElifElseClause, Expr, Stmt};
use ruff_python_ast::{self as ast, Decorator, ElifElseClause, Expr, Stmt};
use ruff_python_codegen::Stylist;
use ruff_python_index::Indexer;
use ruff_python_semantic::SemanticModel;
Expand Down Expand Up @@ -364,15 +364,25 @@ impl Violation for SuperfluousElseBreak {
}

/// RET501
fn unnecessary_return_none(checker: &mut Checker, stack: &Stack) {
fn unnecessary_return_none(checker: &mut Checker, decorator_list: &[Decorator], stack: &Stack) {
for stmt in &stack.returns {
let Some(expr) = stmt.value.as_deref() else {
continue;
};
if !expr.is_none_literal_expr() {
continue;
}
let mut diagnostic = Diagnostic::new(UnnecessaryReturnNone, stmt.range);

// Skip properties.
if decorator_list.iter().any(|decorator| {
checker
.semantic()
.match_builtin_expr(&decorator.expression, "property")
}) {
return;
}

let mut diagnostic = Diagnostic::new(UnnecessaryReturnNone, stmt.range());
diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement(
"return".to_string(),
stmt.range(),
Expand All @@ -387,10 +397,10 @@ fn implicit_return_value(checker: &mut Checker, stack: &Stack) {
if stmt.value.is_some() {
continue;
}
let mut diagnostic = Diagnostic::new(ImplicitReturnValue, stmt.range);
let mut diagnostic = Diagnostic::new(ImplicitReturnValue, stmt.range());
diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement(
"return None".to_string(),
stmt.range,
stmt.range(),
)));
checker.diagnostics.push(diagnostic);
}
Expand Down Expand Up @@ -731,7 +741,12 @@ fn superfluous_elif_else(checker: &mut Checker, stack: &Stack) {
}

/// Run all checks from the `flake8-return` plugin.
pub(crate) fn function(checker: &mut Checker, body: &[Stmt], returns: Option<&Expr>) {
pub(crate) fn function(
checker: &mut Checker,
body: &[Stmt],
decorator_list: &[Decorator],
returns: Option<&Expr>,
) {
// Find the last statement in the function.
let Some(last_stmt) = body.last() else {
// Skip empty functions.
Expand Down Expand Up @@ -787,7 +802,7 @@ pub(crate) fn function(checker: &mut Checker, body: &[Stmt], returns: Option<&Ex
if checker.enabled(Rule::UnnecessaryReturnNone) {
// Skip functions that have a return annotation that is not `None`.
if returns.map_or(true, Expr::is_none_literal_expr) {
unnecessary_return_none(checker, &stack);
unnecessary_return_none(checker, decorator_list, &stack);
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ RET501.py:14:9: RET501 [*] Do not explicitly `return None` in function if it is
13 | print(f"{key} not found")
14 | return None
| ^^^^^^^^^^^ RET501
15 |
16 | @property
|
= help: Remove explicit `return None`

Expand All @@ -35,5 +37,6 @@ RET501.py:14:9: RET501 [*] Do not explicitly `return None` in function if it is
13 13 | print(f"{key} not found")
14 |- return None
14 |+ return


15 15 |
16 16 | @property
17 17 | def prop(self) -> None:
Loading