mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-17 13:57:25 +00:00
[syntax-errors]: break outside loop F701 (#20556)
Some checks are pending
CI / cargo clippy (push) Blocked by required conditions
CI / cargo test (linux) (push) Blocked by required conditions
CI / cargo test (linux, release) (push) Blocked by required conditions
CI / cargo test (windows) (push) Blocked by required conditions
CI / cargo test (wasm) (push) Blocked by required conditions
CI / cargo build (release) (push) Waiting to run
CI / cargo build (msrv) (push) Blocked by required conditions
CI / cargo fuzz build (push) Blocked by required conditions
CI / fuzz parser (push) Blocked by required conditions
CI / test scripts (push) Blocked by required conditions
CI / ecosystem (push) Blocked by required conditions
CI / Fuzz for new ty panics (push) Blocked by required conditions
CI / cargo shear (push) Blocked by required conditions
CI / ty completion evaluation (push) Blocked by required conditions
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / formatter instabilities and black similarity (push) Blocked by required conditions
CI / test ruff-lsp (push) Blocked by required conditions
CI / check playground (push) Blocked by required conditions
CI / benchmarks instrumented (ruff) (push) Blocked by required conditions
CI / cargo fmt (push) Waiting to run
CI / Determine changes (push) Waiting to run
CI / benchmarks instrumented (ty) (push) Blocked by required conditions
CI / benchmarks walltime (medium|multithreaded) (push) Blocked by required conditions
CI / benchmarks walltime (small|large) (push) Blocked by required conditions
[ty Playground] Release / publish (push) Waiting to run
Some checks are pending
CI / cargo clippy (push) Blocked by required conditions
CI / cargo test (linux) (push) Blocked by required conditions
CI / cargo test (linux, release) (push) Blocked by required conditions
CI / cargo test (windows) (push) Blocked by required conditions
CI / cargo test (wasm) (push) Blocked by required conditions
CI / cargo build (release) (push) Waiting to run
CI / cargo build (msrv) (push) Blocked by required conditions
CI / cargo fuzz build (push) Blocked by required conditions
CI / fuzz parser (push) Blocked by required conditions
CI / test scripts (push) Blocked by required conditions
CI / ecosystem (push) Blocked by required conditions
CI / Fuzz for new ty panics (push) Blocked by required conditions
CI / cargo shear (push) Blocked by required conditions
CI / ty completion evaluation (push) Blocked by required conditions
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / formatter instabilities and black similarity (push) Blocked by required conditions
CI / test ruff-lsp (push) Blocked by required conditions
CI / check playground (push) Blocked by required conditions
CI / benchmarks instrumented (ruff) (push) Blocked by required conditions
CI / cargo fmt (push) Waiting to run
CI / Determine changes (push) Waiting to run
CI / benchmarks instrumented (ty) (push) Blocked by required conditions
CI / benchmarks walltime (medium|multithreaded) (push) Blocked by required conditions
CI / benchmarks walltime (small|large) (push) Blocked by required conditions
[ty Playground] Release / publish (push) Waiting to run
<!-- Thank you for contributing to Ruff/ty! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? (Please prefix with `[ty]` for ty pull requests.) - Does this pull request include references to any relevant issues? --> ## Summary <!-- What's the purpose of the change? What does it do, and why? --> This PR implements https://docs.astral.sh/ruff/rules/break-outside-loop/ (F701) as a semantic syntax error. ## Test Plan <!-- How was it tested? --> --------- Signed-off-by: 11happy <soni5happy@gmail.com> Co-authored-by: Brent Westbrook <brentrwestbrook@gmail.com>
This commit is contained in:
parent
4b8e278a88
commit
2b729b4d52
6 changed files with 51 additions and 41 deletions
|
@ -50,15 +50,6 @@ pub(crate) fn statement(stmt: &Stmt, checker: &mut Checker) {
|
||||||
pylint::rules::nonlocal_and_global(checker, nonlocal);
|
pylint::rules::nonlocal_and_global(checker, nonlocal);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Stmt::Break(_) => {
|
|
||||||
if checker.is_rule_enabled(Rule::BreakOutsideLoop) {
|
|
||||||
pyflakes::rules::break_outside_loop(
|
|
||||||
checker,
|
|
||||||
stmt,
|
|
||||||
&mut checker.semantic.current_statements().skip(1),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Stmt::Continue(_) => {
|
Stmt::Continue(_) => {
|
||||||
if checker.is_rule_enabled(Rule::ContinueOutsideLoop) {
|
if checker.is_rule_enabled(Rule::ContinueOutsideLoop) {
|
||||||
pyflakes::rules::continue_outside_loop(
|
pyflakes::rules::continue_outside_loop(
|
||||||
|
|
|
@ -697,6 +697,7 @@ impl SemanticSyntaxContext for Checker<'_> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
SemanticSyntaxErrorKind::FutureFeatureNotDefined(name) => {
|
SemanticSyntaxErrorKind::FutureFeatureNotDefined(name) => {
|
||||||
|
// F407
|
||||||
if self.is_rule_enabled(Rule::FutureFeatureNotDefined) {
|
if self.is_rule_enabled(Rule::FutureFeatureNotDefined) {
|
||||||
self.report_diagnostic(
|
self.report_diagnostic(
|
||||||
pyflakes::rules::FutureFeatureNotDefined { name },
|
pyflakes::rules::FutureFeatureNotDefined { name },
|
||||||
|
@ -704,6 +705,12 @@ impl SemanticSyntaxContext for Checker<'_> {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
SemanticSyntaxErrorKind::BreakOutsideLoop => {
|
||||||
|
// F701
|
||||||
|
if self.is_rule_enabled(Rule::BreakOutsideLoop) {
|
||||||
|
self.report_diagnostic(pyflakes::rules::BreakOutsideLoop, error.range);
|
||||||
|
}
|
||||||
|
}
|
||||||
SemanticSyntaxErrorKind::ReboundComprehensionVariable
|
SemanticSyntaxErrorKind::ReboundComprehensionVariable
|
||||||
| SemanticSyntaxErrorKind::DuplicateTypeParameter
|
| SemanticSyntaxErrorKind::DuplicateTypeParameter
|
||||||
| SemanticSyntaxErrorKind::MultipleCaseAssignment(_)
|
| SemanticSyntaxErrorKind::MultipleCaseAssignment(_)
|
||||||
|
@ -811,19 +818,40 @@ impl SemanticSyntaxContext for Checker<'_> {
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn in_loop_context(&self) -> bool {
|
||||||
|
let mut child = self.semantic.current_statement();
|
||||||
|
|
||||||
|
for parent in self.semantic.current_statements().skip(1) {
|
||||||
|
match parent {
|
||||||
|
Stmt::For(ast::StmtFor { orelse, .. })
|
||||||
|
| Stmt::While(ast::StmtWhile { orelse, .. }) => {
|
||||||
|
if !orelse.contains(child) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Stmt::FunctionDef(_) | Stmt::ClassDef(_) => {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
|
}
|
||||||
|
child = parent;
|
||||||
|
}
|
||||||
|
false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> Visitor<'a> for Checker<'a> {
|
impl<'a> Visitor<'a> for Checker<'a> {
|
||||||
fn visit_stmt(&mut self, stmt: &'a Stmt) {
|
fn visit_stmt(&mut self, stmt: &'a Stmt) {
|
||||||
|
// Step 0: Pre-processing
|
||||||
|
self.semantic.push_node(stmt);
|
||||||
|
|
||||||
// For functions, defer semantic syntax error checks until the body of the function is
|
// For functions, defer semantic syntax error checks until the body of the function is
|
||||||
// visited
|
// visited
|
||||||
if !stmt.is_function_def_stmt() {
|
if !stmt.is_function_def_stmt() {
|
||||||
self.with_semantic_checker(|semantic, context| semantic.visit_stmt(stmt, context));
|
self.with_semantic_checker(|semantic, context| semantic.visit_stmt(stmt, context));
|
||||||
}
|
}
|
||||||
|
|
||||||
// Step 0: Pre-processing
|
|
||||||
self.semantic.push_node(stmt);
|
|
||||||
|
|
||||||
// For Jupyter Notebooks, we'll reset the `IMPORT_BOUNDARY` flag when
|
// For Jupyter Notebooks, we'll reset the `IMPORT_BOUNDARY` flag when
|
||||||
// we encounter a cell boundary.
|
// we encounter a cell boundary.
|
||||||
if self.source_type.is_ipynb()
|
if self.source_type.is_ipynb()
|
||||||
|
|
|
@ -1,9 +1,6 @@
|
||||||
use ruff_python_ast::{self as ast, Stmt};
|
|
||||||
|
|
||||||
use ruff_macros::{ViolationMetadata, derive_message_formats};
|
use ruff_macros::{ViolationMetadata, derive_message_formats};
|
||||||
use ruff_text_size::Ranged;
|
|
||||||
|
|
||||||
use crate::{Violation, checkers::ast::Checker};
|
use crate::Violation;
|
||||||
|
|
||||||
/// ## What it does
|
/// ## What it does
|
||||||
/// Checks for `break` statements outside of loops.
|
/// Checks for `break` statements outside of loops.
|
||||||
|
@ -29,28 +26,3 @@ impl Violation for BreakOutsideLoop {
|
||||||
"`break` outside loop".to_string()
|
"`break` outside loop".to_string()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// F701
|
|
||||||
pub(crate) fn break_outside_loop<'a>(
|
|
||||||
checker: &Checker,
|
|
||||||
stmt: &'a Stmt,
|
|
||||||
parents: &mut impl Iterator<Item = &'a Stmt>,
|
|
||||||
) {
|
|
||||||
let mut child = stmt;
|
|
||||||
for parent in parents {
|
|
||||||
match parent {
|
|
||||||
Stmt::For(ast::StmtFor { orelse, .. }) | Stmt::While(ast::StmtWhile { orelse, .. }) => {
|
|
||||||
if !orelse.contains(child) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Stmt::FunctionDef(_) | Stmt::ClassDef(_) => {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
child = parent;
|
|
||||||
}
|
|
||||||
|
|
||||||
checker.report_diagnostic(BreakOutsideLoop, stmt.range());
|
|
||||||
}
|
|
||||||
|
|
|
@ -224,6 +224,11 @@ impl SemanticSyntaxChecker {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Stmt::Break(ast::StmtBreak { range, .. }) => {
|
||||||
|
if !ctx.in_loop_context() {
|
||||||
|
Self::add_error(ctx, SemanticSyntaxErrorKind::BreakOutsideLoop, *range);
|
||||||
|
}
|
||||||
|
}
|
||||||
_ => {}
|
_ => {}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1125,6 +1130,7 @@ impl Display for SemanticSyntaxError {
|
||||||
SemanticSyntaxErrorKind::FutureFeatureNotDefined(name) => {
|
SemanticSyntaxErrorKind::FutureFeatureNotDefined(name) => {
|
||||||
write!(f, "Future feature `{name}` is not defined")
|
write!(f, "Future feature `{name}` is not defined")
|
||||||
}
|
}
|
||||||
|
SemanticSyntaxErrorKind::BreakOutsideLoop => f.write_str("`break` outside loop"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1498,6 +1504,9 @@ pub enum SemanticSyntaxErrorKind {
|
||||||
|
|
||||||
/// Represents the use of a `__future__` feature that is not defined.
|
/// Represents the use of a `__future__` feature that is not defined.
|
||||||
FutureFeatureNotDefined(String),
|
FutureFeatureNotDefined(String),
|
||||||
|
|
||||||
|
/// Represents the use of a `break` statement outside of a loop.
|
||||||
|
BreakOutsideLoop,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, get_size2::GetSize)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, get_size2::GetSize)]
|
||||||
|
@ -1979,6 +1988,8 @@ pub trait SemanticSyntaxContext {
|
||||||
fn in_notebook(&self) -> bool;
|
fn in_notebook(&self) -> bool;
|
||||||
|
|
||||||
fn report_semantic_error(&self, error: SemanticSyntaxError);
|
fn report_semantic_error(&self, error: SemanticSyntaxError);
|
||||||
|
|
||||||
|
fn in_loop_context(&self) -> bool;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Modified version of [`std::str::EscapeDefault`] that does not escape single or double quotes.
|
/// Modified version of [`std::str::EscapeDefault`] that does not escape single or double quotes.
|
||||||
|
|
|
@ -571,6 +571,10 @@ impl SemanticSyntaxContext for SemanticSyntaxCheckerVisitor<'_> {
|
||||||
fn in_generator_scope(&self) -> bool {
|
fn in_generator_scope(&self) -> bool {
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn in_loop_context(&self) -> bool {
|
||||||
|
true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Visitor<'_> for SemanticSyntaxCheckerVisitor<'_> {
|
impl Visitor<'_> for SemanticSyntaxCheckerVisitor<'_> {
|
||||||
|
|
|
@ -2785,6 +2785,10 @@ impl SemanticSyntaxContext for SemanticIndexBuilder<'_, '_> {
|
||||||
self.semantic_syntax_errors.borrow_mut().push(error);
|
self.semantic_syntax_errors.borrow_mut().push(error);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn in_loop_context(&self) -> bool {
|
||||||
|
true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Copy, Clone, Debug, PartialEq)]
|
#[derive(Copy, Clone, Debug, PartialEq)]
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue