-
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) (#7961)
## Summary ### 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") ``` ## Test Plan Added unit test and snapshot. Manually compared ruff and pylint outputs on pylint's tests. ## References - [pylint documentation](https://pylint.pycqa.org/en/stable/user_guide/messages/error/misplaced-bare-raise.html) - [pylint implementation](https://github.com/pylint-dev/pylint/blob/main/pylint/checkers/exceptions.py#L339)
- Loading branch information
Showing
12 changed files
with
254 additions
and
7 deletions.
There are no files selected for viewing
71 changes: 71 additions & 0 deletions
71
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,71 @@ | ||
# 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] | ||
|
||
try: | ||
pass | ||
except: | ||
def i(): | ||
raise # [misplaced-bare-raise] | ||
|
||
try: | ||
pass | ||
except: | ||
class C: | ||
raise # [misplaced-bare-raise] | ||
|
||
try: | ||
pass | ||
except: | ||
pass | ||
finally: | ||
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
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
70 changes: 70 additions & 0 deletions
70
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,70 @@ | ||
use ruff_diagnostics::{Diagnostic, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast as ast; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
use crate::rules::pylint::helpers::in_dunder_method; | ||
|
||
/// ## What it does | ||
/// Checks for bare `raise` statements outside of exception handlers. | ||
/// | ||
/// ## Why is this bad? | ||
/// A bare `raise` statement without an exception object will re-raise the last | ||
/// exception that was active in the current scope, and is typically used | ||
/// within an exception handler to re-raise the caught exception. | ||
/// | ||
/// If a bare `raise` is used outside of an exception handler, it will generate | ||
/// an error due to the lack of an active exception. | ||
/// | ||
/// Note that a bare `raise` within a `finally` block will work in some cases | ||
/// (namely, when the exception is raised within the `try` block), but should | ||
/// be avoided as it can lead to confusing behavior. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// from typing import Any | ||
/// | ||
/// | ||
/// def is_some(obj: Any) -> bool: | ||
/// if obj is None: | ||
/// raise | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// from typing import Any | ||
/// | ||
/// | ||
/// def is_some(obj: Any) -> bool: | ||
/// if obj is None: | ||
/// raise ValueError("`obj` cannot be `None`") | ||
/// ``` | ||
#[violation] | ||
pub struct MisplacedBareRaise; | ||
|
||
impl Violation for MisplacedBareRaise { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("Bare `raise` statement is not inside an exception handler") | ||
} | ||
} | ||
|
||
/// PLE0704 | ||
pub(crate) fn misplaced_bare_raise(checker: &mut Checker, raise: &ast::StmtRaise) { | ||
if raise.exc.is_some() { | ||
return; | ||
} | ||
|
||
if checker.semantic().in_exception_handler() { | ||
return; | ||
} | ||
|
||
if in_dunder_method("__exit__", checker.semantic(), checker.settings) { | ||
return; | ||
} | ||
|
||
checker | ||
.diagnostics | ||
.push(Diagnostic::new(MisplacedBareRaise, raise.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
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
90 changes: 90 additions & 0 deletions
90
.../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,90 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/pylint/mod.rs | ||
--- | ||
misplaced_bare_raise.py:30:5: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
29 | try: | ||
30 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
31 | except Exception: | ||
32 | pass | ||
| | ||
|
||
misplaced_bare_raise.py:36:9: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
34 | def f(): | ||
35 | try: | ||
36 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
37 | except Exception: | ||
38 | pass | ||
| | ||
|
||
misplaced_bare_raise.py:41:5: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
40 | def g(): | ||
41 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
42 | | ||
43 | def h(): | ||
| | ||
|
||
misplaced_bare_raise.py:47:17: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
45 | if True: | ||
46 | def i(): | ||
47 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
48 | except Exception: | ||
49 | pass | ||
| | ||
|
||
misplaced_bare_raise.py:50:5: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
48 | except Exception: | ||
49 | pass | ||
50 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
51 | | ||
52 | raise # [misplaced-bare-raise] | ||
| | ||
|
||
misplaced_bare_raise.py:52:1: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
50 | raise # [misplaced-bare-raise] | ||
51 | | ||
52 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
53 | | ||
54 | try: | ||
| | ||
|
||
misplaced_bare_raise.py:58:9: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
56 | except: | ||
57 | def i(): | ||
58 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
59 | | ||
60 | try: | ||
| | ||
|
||
misplaced_bare_raise.py:64:9: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
62 | except: | ||
63 | class C: | ||
64 | raise # [misplaced-bare-raise] | ||
| ^^^^^ PLE0704 | ||
65 | | ||
66 | try: | ||
| | ||
|
||
misplaced_bare_raise.py:71:5: PLE0704 Bare `raise` statement is not inside an exception handler | ||
| | ||
69 | pass | ||
70 | finally: | ||
71 | 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.