-
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.
## Summary Adds TRIO110 from the [flake8-trio plugin](https://github.com/Zac-HD/flake8-trio). Relates to: #8451
- Loading branch information
1 parent
fce9f63
commit 0126f74
Showing
8 changed files
with
115 additions
and
1 deletion.
There are no files selected for viewing
16 changes: 16 additions & 0 deletions
16
crates/ruff_linter/resources/test/fixtures/flake8_trio/TRIO110.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,16 @@ | ||
import trio | ||
|
||
|
||
async def func(): | ||
while True: | ||
await trio.sleep(10) | ||
|
||
|
||
async def func(): | ||
while True: | ||
await trio.sleep_until(10) | ||
|
||
|
||
async def func(): | ||
while True: | ||
trio.sleep(10) |
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 |
---|---|---|
@@ -1,7 +1,9 @@ | ||
pub(crate) use sync_call::*; | ||
pub(crate) use timeout_without_await::*; | ||
pub(crate) use unneeded_sleep::*; | ||
pub(crate) use zero_sleep_call::*; | ||
|
||
mod sync_call; | ||
mod timeout_without_await; | ||
mod unneeded_sleep; | ||
mod zero_sleep_call; |
68 changes: 68 additions & 0 deletions
68
crates/ruff_linter/src/rules/flake8_trio/rules/unneeded_sleep.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,68 @@ | ||
use ruff_diagnostics::{Diagnostic, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::{self as ast, Expr, Stmt}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// Checks for the use of `trio.sleep` in a `while` loop. | ||
/// | ||
/// ## Why is this bad? | ||
/// Instead of sleeping in a `while` loop, and waiting for a condition | ||
/// to become true, it's preferable to `wait()` on a `trio.Event`. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// DONE = False | ||
/// | ||
/// | ||
/// async def func(): | ||
/// while not DONE: | ||
/// await trio.sleep(1) | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// DONE = trio.Event() | ||
/// | ||
/// | ||
/// async def func(): | ||
/// await DONE.wait() | ||
/// ``` | ||
#[violation] | ||
pub struct TrioUnneededSleep; | ||
|
||
impl Violation for TrioUnneededSleep { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("Use `trio.Event` instead of awaiting `trio.sleep` in a `while` loop") | ||
} | ||
} | ||
|
||
/// TRIO110 | ||
pub(crate) fn unneeded_sleep(checker: &mut Checker, while_stmt: &ast::StmtWhile) { | ||
// The body should be a single `await` call. | ||
let [stmt] = while_stmt.body.as_slice() else { | ||
return; | ||
}; | ||
let Stmt::Expr(ast::StmtExpr { value, .. }) = stmt else { | ||
return; | ||
}; | ||
let Expr::Await(ast::ExprAwait { value, .. }) = value.as_ref() else { | ||
return; | ||
}; | ||
let Expr::Call(ast::ExprCall { func, .. }) = value.as_ref() else { | ||
return; | ||
}; | ||
|
||
if checker | ||
.semantic() | ||
.resolve_call_path(func.as_ref()) | ||
.is_some_and(|path| matches!(path.as_slice(), ["trio", "sleep" | "sleep_until"])) | ||
{ | ||
checker | ||
.diagnostics | ||
.push(Diagnostic::new(TrioUnneededSleep, while_stmt.range())); | ||
} | ||
} |
22 changes: 22 additions & 0 deletions
22
...les/flake8_trio/snapshots/ruff_linter__rules__flake8_trio__tests__TRIO110_TRIO110.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,22 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/flake8_trio/mod.rs | ||
--- | ||
TRIO110.py:5:5: TRIO110 Use `trio.Event` instead of awaiting `trio.sleep` in a `while` loop | ||
| | ||
4 | async def func(): | ||
5 | while True: | ||
| _____^ | ||
6 | | await trio.sleep(10) | ||
| |____________________________^ TRIO110 | ||
| | ||
|
||
TRIO110.py:10:5: TRIO110 Use `trio.Event` instead of awaiting `trio.sleep` in a `while` loop | ||
| | ||
9 | async def func(): | ||
10 | while True: | ||
| _____^ | ||
11 | | await trio.sleep_until(10) | ||
| |__________________________________^ TRIO110 | ||
| | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.