-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[pylint] Implement misplaced-bare-raise (E0704)
- Loading branch information
Showing
8 changed files
with
224 additions
and
0 deletions.
There are no files selected for viewing
52 changes: 52 additions & 0 deletions
52
crates/ruff_linter/resources/test/fixtures/pylint/misplaced_bare_raise.py
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 |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# bare raise is an except block | ||
try: | ||
pass | ||
except Exception: | ||
raise | ||
|
||
try: | ||
pass | ||
except Exception: | ||
if True: | ||
raise | ||
|
||
# bare raise is in a finally block which is in an except block | ||
try: | ||
raise Exception | ||
except Exception: | ||
try: | ||
raise Exception | ||
finally: | ||
raise | ||
|
||
# bare raise is in an __exit__ method | ||
class ContextManager: | ||
def __enter__(self): | ||
return self | ||
def __exit__(self, *args): | ||
raise | ||
|
||
try: | ||
raise # [misplaced-bare-raise] | ||
except Exception: | ||
pass | ||
|
||
def f(): | ||
try: | ||
raise # [misplaced-bare-raise] | ||
except Exception: | ||
pass | ||
|
||
def g(): | ||
raise # [misplaced-bare-raise] | ||
|
||
def h(): | ||
try: | ||
if True: | ||
def i(): | ||
raise # [misplaced-bare-raise] | ||
except Exception: | ||
pass | ||
raise # [misplaced-bare-raise] | ||
|
||
raise # [misplaced-bare-raise] |
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
100 changes: 100 additions & 0 deletions
100
crates/ruff_linter/src/rules/pylint/rules/misplaced_bare_raise.rs
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 |
---|---|---|
@@ -0,0 +1,100 @@ | ||
use ruff_diagnostics::{Diagnostic, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::statement_visitor::StatementVisitor; | ||
use ruff_python_ast::{statement_visitor, Stmt}; | ||
use ruff_python_semantic::NodeRef; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// | ||
/// This rule triggers an error when a bare raise statement is not in an except or finally block. | ||
/// | ||
/// ## Why is this bad? | ||
/// | ||
/// If raise statement is not in an except or finally block, there is no active exception to | ||
/// re-raise, so it will fail with a `RuntimeError` exception. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// def validate_positive(x): | ||
/// if x <= 0: | ||
/// raise | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// def validate_positive(x): | ||
/// if x <= 0: | ||
/// raise ValueError(f"{x} is not positive") | ||
/// ``` | ||
#[violation] | ||
pub struct MisplacedBareRaise; | ||
|
||
impl Violation for MisplacedBareRaise { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("The raise statement is not inside an except clause") | ||
} | ||
} | ||
|
||
#[derive(Default)] | ||
struct RaiseFinder<'a> { | ||
raises: Vec<&'a Stmt>, | ||
} | ||
|
||
impl<'a, 'b> StatementVisitor<'b> for RaiseFinder<'a> | ||
where | ||
'b: 'a, | ||
{ | ||
fn visit_stmt(&mut self, stmt: &'b Stmt) { | ||
match stmt { | ||
Stmt::Raise(_) => self.raises.push(stmt), | ||
_ => statement_visitor::walk_stmt(self, stmt), | ||
} | ||
} | ||
} | ||
|
||
/// PLE0704 | ||
pub(crate) fn misplaced_bare_raise(checker: &mut Checker, raise_stmt: &Stmt) { | ||
for id in checker.semantic().current_statement_ids() { | ||
let node = checker.semantic().node(id); | ||
if let NodeRef::Stmt(stmt) = node { | ||
match stmt { | ||
Stmt::Try(try_stmt) => { | ||
// check whether the raise is in the except handlers | ||
let mut raise_finder = RaiseFinder::default(); | ||
for handler in &try_stmt.handlers { | ||
raise_finder.visit_except_handler(handler); | ||
} | ||
if raise_finder.raises.contains(&raise_stmt) { | ||
return; | ||
} | ||
|
||
// if the raise is in the finally block, it might be ok if that finally is in | ||
// an except block | ||
let mut raise_finder = RaiseFinder::default(); | ||
raise_finder.visit_body(try_stmt.finalbody.as_slice()); | ||
if raise_finder.raises.contains(&raise_stmt) { | ||
continue; | ||
} | ||
break; | ||
} | ||
Stmt::FunctionDef(fd) => { | ||
// allow bare raise in __exit__ methods | ||
if let Some(Stmt::ClassDef(_)) = checker.semantic().parent_statement(id) { | ||
if fd.name.as_str() == "__exit__" { | ||
return; | ||
} | ||
} | ||
break; | ||
} | ||
_ => {} | ||
} | ||
} | ||
} | ||
checker | ||
.diagnostics | ||
.push(Diagnostic::new(MisplacedBareRaise, raise_stmt.range())); | ||
} |
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
60 changes: 60 additions & 0 deletions
60
.../pylint/snapshots/ruff_linter__rules__pylint__tests__PLE0704_misplaced_bare_raise.py.snap
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 |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/pylint/mod.rs | ||
--- | ||
misplaced_bare_raise.py:30:5: PLE0704 The raise statement is not inside an except clause | ||
| | ||
29 | try: | ||
30 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
31 | except Exception: | ||
32 | pass | ||
| | ||
|
||
misplaced_bare_raise.py:36:9: PLE0704 The raise statement is not inside an except clause | ||
| | ||
34 | def f(): | ||
35 | try: | ||
36 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
37 | except Exception: | ||
38 | pass | ||
| | ||
|
||
misplaced_bare_raise.py:41:5: PLE0704 The raise statement is not inside an except clause | ||
| | ||
40 | def g(): | ||
41 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
42 | | ||
43 | def h(): | ||
| | ||
|
||
misplaced_bare_raise.py:47:17: PLE0704 The raise statement is not inside an except clause | ||
| | ||
45 | if True: | ||
46 | def i(): | ||
47 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
48 | except Exception: | ||
49 | pass | ||
| | ||
|
||
misplaced_bare_raise.py:50:5: PLE0704 The raise statement is not inside an except clause | ||
| | ||
48 | except Exception: | ||
49 | pass | ||
50 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
51 | | ||
52 | raise # [misplaced-bare-raise] | ||
| | ||
|
||
misplaced_bare_raise.py:52:1: PLE0704 The raise statement is not inside an except clause | ||
| | ||
50 | raise # [misplaced-bare-raise] | ||
51 | | ||
52 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
| | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.