From bcae0b0760b650fc1234fdd7155e40a677b6c7ce Mon Sep 17 00:00:00 2001 From: dylwil3 Date: Mon, 17 Nov 2025 14:21:26 -0600 Subject: [PATCH] use new method instead of has_skip_comment everywhere else --- crates/ruff_python_formatter/src/context.rs | 7 ++----- crates/ruff_python_formatter/src/other/decorator.rs | 12 +++--------- .../src/statement/stmt_ann_assign.rs | 12 +++--------- .../src/statement/stmt_assert.rs | 12 +++--------- .../src/statement/stmt_assign.rs | 11 +++-------- .../src/statement/stmt_aug_assign.rs | 12 +++--------- .../src/statement/stmt_break.rs | 12 +++--------- .../src/statement/stmt_continue.rs | 12 +++--------- .../src/statement/stmt_delete.rs | 13 ++++--------- .../src/statement/stmt_expr.rs | 13 +++---------- .../src/statement/stmt_global.rs | 11 ++--------- .../src/statement/stmt_import.rs | 12 +++--------- .../src/statement/stmt_import_from.rs | 11 ++--------- .../src/statement/stmt_ipy_escape_command.rs | 12 +++--------- .../src/statement/stmt_nonlocal.rs | 11 ++--------- .../src/statement/stmt_pass.rs | 12 +++--------- .../src/statement/stmt_raise.rs | 12 +++--------- .../src/statement/stmt_return.rs | 12 +++--------- .../src/statement/stmt_type_alias.rs | 12 +++--------- 19 files changed, 54 insertions(+), 167 deletions(-) diff --git a/crates/ruff_python_formatter/src/context.rs b/crates/ruff_python_formatter/src/context.rs index 2da4ff582b..82518fcabe 100644 --- a/crates/ruff_python_formatter/src/context.rs +++ b/crates/ruff_python_formatter/src/context.rs @@ -114,11 +114,8 @@ impl<'a> PyFormatContext<'a> { self.options.preview().is_enabled() } - /// Returns `true` if node is a suppressed statement. - pub(crate) fn is_suppressed_statement_node(&self, node: AnyNodeRef<'_>) -> bool { - if !node.is_statement() { - return false; - } + /// Returns `true` if node is suppressed via skip comment. + pub(crate) fn is_suppressed(&self, node: AnyNodeRef<'_>) -> bool { has_skip_comment(self.comments().trailing(node), self.source()) } } diff --git a/crates/ruff_python_formatter/src/other/decorator.rs b/crates/ruff_python_formatter/src/other/decorator.rs index 0c1719b991..94e228dfc8 100644 --- a/crates/ruff_python_formatter/src/other/decorator.rs +++ b/crates/ruff_python_formatter/src/other/decorator.rs @@ -1,10 +1,9 @@ use ruff_formatter::write; use ruff_python_ast::Decorator; -use crate::comments::SourceComment; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatDecorator; @@ -25,12 +24,7 @@ impl FormatNodeRule for FormatDecorator { ] ) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &Decorator, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_ann_assign.rs b/crates/ruff_python_formatter/src/statement/stmt_ann_assign.rs index 1de79a6b07..77ef7c3ce7 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_ann_assign.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_ann_assign.rs @@ -1,14 +1,13 @@ use ruff_formatter::write; use ruff_python_ast::StmtAnnAssign; -use crate::comments::SourceComment; use crate::expression::is_splittable_expression; use crate::expression::parentheses::Parentheses; +use crate::prelude::*; use crate::statement::stmt_assign::{ AnyAssignmentOperator, AnyBeforeOperator, FormatStatementsLastExpression, }; use crate::statement::trailing_semicolon; -use crate::{has_skip_comment, prelude::*}; #[derive(Default)] pub struct FormatStmtAnnAssign; @@ -84,12 +83,7 @@ impl FormatNodeRule for FormatStmtAnnAssign { Ok(()) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtAnnAssign, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_assert.rs b/crates/ruff_python_formatter/src/statement/stmt_assert.rs index fc2aba9701..5d30ad561b 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_assert.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_assert.rs @@ -2,10 +2,9 @@ use ruff_formatter::prelude::{space, token}; use ruff_formatter::write; use ruff_python_ast::StmtAssert; -use crate::comments::SourceComment; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtAssert; @@ -41,12 +40,7 @@ impl FormatNodeRule for FormatStmtAssert { Ok(()) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtAssert, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_assign.rs b/crates/ruff_python_formatter/src/statement/stmt_assign.rs index b9fbe6b7a3..e49688a2bc 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_assign.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_assign.rs @@ -18,13 +18,13 @@ use crate::expression::{ maybe_parenthesize_expression, }; use crate::other::interpolated_string::InterpolatedStringLayout; +use crate::prelude::*; use crate::statement::trailing_semicolon; use crate::string::StringLikeExtensions; use crate::string::implicit::{ FormatImplicitConcatenatedStringExpanded, FormatImplicitConcatenatedStringFlat, ImplicitConcatenatedLayout, }; -use crate::{has_skip_comment, prelude::*}; #[derive(Default)] pub struct FormatStmtAssign; @@ -102,13 +102,8 @@ impl FormatNodeRule for FormatStmtAssign { Ok(()) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtAssign, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs b/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs index 58ac4b34e5..2e7f0ae891 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_aug_assign.rs @@ -1,15 +1,14 @@ use ruff_formatter::write; use ruff_python_ast::StmtAugAssign; -use crate::comments::SourceComment; use crate::expression::parentheses::is_expression_parenthesized; +use crate::prelude::*; use crate::statement::stmt_assign::{ AnyAssignmentOperator, AnyBeforeOperator, FormatStatementsLastExpression, has_target_own_parentheses, }; use crate::statement::trailing_semicolon; use crate::{AsFormat, FormatNodeRule}; -use crate::{has_skip_comment, prelude::*}; #[derive(Default)] pub struct FormatStmtAugAssign; @@ -62,12 +61,7 @@ impl FormatNodeRule for FormatStmtAugAssign { Ok(()) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtAugAssign, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_break.rs b/crates/ruff_python_formatter/src/statement/stmt_break.rs index 1e94c01f8b..48de82a799 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_break.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_break.rs @@ -1,7 +1,6 @@ use ruff_python_ast::StmtBreak; -use crate::comments::SourceComment; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtBreak; @@ -10,12 +9,7 @@ impl FormatNodeRule for FormatStmtBreak { fn fmt_fields(&self, _item: &StmtBreak, f: &mut PyFormatter) -> FormatResult<()> { token("break").fmt(f) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtBreak, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_continue.rs b/crates/ruff_python_formatter/src/statement/stmt_continue.rs index 39e14b5116..c1bdb9c871 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_continue.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_continue.rs @@ -1,7 +1,6 @@ use ruff_python_ast::StmtContinue; -use crate::comments::SourceComment; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtContinue; @@ -10,12 +9,7 @@ impl FormatNodeRule for FormatStmtContinue { fn fmt_fields(&self, _item: &StmtContinue, f: &mut PyFormatter) -> FormatResult<()> { token("continue").fmt(f) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtContinue, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_delete.rs b/crates/ruff_python_formatter/src/statement/stmt_delete.rs index fa3a27bb6f..978e5a858c 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_delete.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_delete.rs @@ -3,10 +3,10 @@ use ruff_python_ast::StmtDelete; use ruff_text_size::Ranged; use crate::builders::{PyFormatterExtensions, parenthesize_if_expands}; -use crate::comments::{SourceComment, dangling_node_comments}; +use crate::comments::dangling_node_comments; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtDelete; @@ -57,12 +57,7 @@ impl FormatNodeRule for FormatStmtDelete { } } } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtDelete, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_expr.rs b/crates/ruff_python_formatter/src/statement/stmt_expr.rs index 79f9c48abb..ffff3e7c14 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_expr.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_expr.rs @@ -1,12 +1,10 @@ use ruff_python_ast as ast; use ruff_python_ast::{Expr, Operator, StmtExpr}; -use crate::comments::SourceComment; - use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; +use crate::prelude::*; use crate::statement::trailing_semicolon; -use crate::{has_skip_comment, prelude::*}; #[derive(Default)] pub struct FormatStmtExpr; @@ -30,13 +28,8 @@ impl FormatNodeRule for FormatStmtExpr { Ok(()) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtExpr, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_global.rs b/crates/ruff_python_formatter/src/statement/stmt_global.rs index dd31d31106..460e80867a 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_global.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_global.rs @@ -1,8 +1,6 @@ use ruff_formatter::{format_args, write}; use ruff_python_ast::StmtGlobal; -use crate::comments::SourceComment; -use crate::has_skip_comment; use crate::prelude::*; #[derive(Default)] @@ -47,12 +45,7 @@ impl FormatNodeRule for FormatStmtGlobal { ) } } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtGlobal, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_import.rs b/crates/ruff_python_formatter/src/statement/stmt_import.rs index c44b8ffd49..02dba3485f 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_import.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_import.rs @@ -1,8 +1,7 @@ use ruff_formatter::{format_args, write}; use ruff_python_ast::StmtImport; -use crate::comments::SourceComment; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtImport; @@ -21,12 +20,7 @@ impl FormatNodeRule for FormatStmtImport { }); write!(f, [token("import"), space(), names]) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtImport, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_import_from.rs b/crates/ruff_python_formatter/src/statement/stmt_import_from.rs index 341adc64d2..c82fc2c31d 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_import_from.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_import_from.rs @@ -3,9 +3,7 @@ use ruff_python_ast::StmtImportFrom; use ruff_text_size::Ranged; use crate::builders::{PyFormatterExtensions, TrailingComma, parenthesize_if_expands}; -use crate::comments::SourceComment; use crate::expression::parentheses::parenthesized; -use crate::has_skip_comment; use crate::other::identifier::DotDelimitedIdentifier; use crate::prelude::*; @@ -72,12 +70,7 @@ impl FormatNodeRule for FormatStmtImportFrom { .fmt(f) } } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtImportFrom, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_ipy_escape_command.rs b/crates/ruff_python_formatter/src/statement/stmt_ipy_escape_command.rs index 66d52739db..57cafa7052 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_ipy_escape_command.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_ipy_escape_command.rs @@ -1,8 +1,7 @@ use ruff_python_ast::StmtIpyEscapeCommand; use ruff_text_size::Ranged; -use crate::comments::SourceComment; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtIpyEscapeCommand; @@ -11,12 +10,7 @@ impl FormatNodeRule for FormatStmtIpyEscapeCommand { fn fmt_fields(&self, item: &StmtIpyEscapeCommand, f: &mut PyFormatter) -> FormatResult<()> { source_text_slice(item.range()).fmt(f) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtIpyEscapeCommand, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs b/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs index 666adbacae..52969f83a7 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_nonlocal.rs @@ -1,8 +1,6 @@ use ruff_formatter::{format_args, write}; use ruff_python_ast::StmtNonlocal; -use crate::comments::SourceComment; -use crate::has_skip_comment; use crate::prelude::*; #[derive(Default)] @@ -47,12 +45,7 @@ impl FormatNodeRule for FormatStmtNonlocal { ) } } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtNonlocal, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_pass.rs b/crates/ruff_python_formatter/src/statement/stmt_pass.rs index bd542ec74b..33df20215c 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_pass.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_pass.rs @@ -1,7 +1,6 @@ use ruff_python_ast::StmtPass; -use crate::comments::SourceComment; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtPass; @@ -10,12 +9,7 @@ impl FormatNodeRule for FormatStmtPass { fn fmt_fields(&self, _item: &StmtPass, f: &mut PyFormatter) -> FormatResult<()> { token("pass").fmt(f) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtPass, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_raise.rs b/crates/ruff_python_formatter/src/statement/stmt_raise.rs index bfb73d00af..de184989a3 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_raise.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_raise.rs @@ -1,10 +1,9 @@ use ruff_formatter::write; use ruff_python_ast::StmtRaise; -use crate::comments::SourceComment; use crate::expression::maybe_parenthesize_expression; use crate::expression::parentheses::Parenthesize; -use crate::{has_skip_comment, prelude::*}; +use crate::prelude::*; #[derive(Default)] pub struct FormatStmtRaise; @@ -43,12 +42,7 @@ impl FormatNodeRule for FormatStmtRaise { } Ok(()) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtRaise, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_return.rs b/crates/ruff_python_formatter/src/statement/stmt_return.rs index fbeb9488e4..517f184aee 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_return.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_return.rs @@ -1,10 +1,9 @@ use ruff_formatter::write; use ruff_python_ast::{Expr, StmtReturn}; -use crate::comments::SourceComment; use crate::expression::expr_tuple::TupleParentheses; +use crate::prelude::*; use crate::statement::stmt_assign::FormatStatementsLastExpression; -use crate::{has_skip_comment, prelude::*}; #[derive(Default)] pub struct FormatStmtReturn; @@ -43,12 +42,7 @@ impl FormatNodeRule for FormatStmtReturn { None => Ok(()), } } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtReturn, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } } diff --git a/crates/ruff_python_formatter/src/statement/stmt_type_alias.rs b/crates/ruff_python_formatter/src/statement/stmt_type_alias.rs index a66b4f64be..b05c7b8d95 100644 --- a/crates/ruff_python_formatter/src/statement/stmt_type_alias.rs +++ b/crates/ruff_python_formatter/src/statement/stmt_type_alias.rs @@ -1,11 +1,10 @@ use ruff_formatter::write; use ruff_python_ast::StmtTypeAlias; -use crate::comments::SourceComment; +use crate::prelude::*; use crate::statement::stmt_assign::{ AnyAssignmentOperator, AnyBeforeOperator, FormatStatementsLastExpression, }; -use crate::{has_skip_comment, prelude::*}; #[derive(Default)] pub struct FormatStmtTypeAlias; @@ -42,12 +41,7 @@ impl FormatNodeRule for FormatStmtTypeAlias { ] ) } - - fn is_suppressed( - &self, - trailing_comments: &[SourceComment], - context: &PyFormatContext, - ) -> bool { - has_skip_comment(trailing_comments, context.source()) + fn is_suppressed(&self, node: &StmtTypeAlias, context: &PyFormatContext) -> bool { + context.is_suppressed(node.into()) } }