language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-06 18:40:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Move is_tuple_parenthesized from the formatter to ruff_python_ast (#9533)

Browse source 
This allows it to be used in the linter as well as the formatter. It
will be useful in #9474
This commit is contained in:
Alex Waygood 2024-01-15 16:10:40 +00:00 • committed by GitHub
parent 64aac5d526
commit a1e65a92bd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 38 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

38
crates/ruff_python_formatter/src/expression/expr_tuple.rs
View file

@ -1,8 +1,7 @@
use ruff_formatter::{format_args, write, FormatRuleWithOptions};
use ruff_python_ast::AnyNodeRef;
use ruff_python_ast::ExprTuple;
use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer};
use ruff_text_size::{Ranged, TextRange};
use ruff_text_size::Ranged;
use crate::builders::parenthesize_if_expands;
use crate::comments::SourceComment;
@ -137,9 +136,7 @@ impl FormatNodeRule<ExprTuple> for FormatExprTuple {
return empty_parenthesized("(", dangling, ")").fmt(f);
}
[single] => match self.parentheses {
TupleParentheses::Preserve
if !is_tuple_parenthesized(item, f.context().source()) =>
{
TupleParentheses::Preserve if !item.is_parenthesized(f.context().source()) => {
write!(f, [single.format(), token(",")])
}
_ =>
@ -155,7 +152,7 @@ impl FormatNodeRule<ExprTuple> for FormatExprTuple {
//
// Unlike other expression parentheses, tuple parentheses are part of the range of the
// tuple itself.
_ if is_tuple_parenthesized(item, f.context().source())
_ if item.is_parenthesized(f.context().source())
&& !(self.parentheses == TupleParentheses::NeverPreserve
&& dangling.is_empty()) =>
{
@ -223,32 +220,3 @@ impl NeedsParentheses for ExprTuple {
OptionalParentheses::Never
}
}
/// Return `true` if a tuple is parenthesized in the source code.
pub(crate) fn is_tuple_parenthesized(tuple: &ExprTuple, source: &str) -> bool {
let Some(elt) = tuple.elts.first() else {
return true;
};
// Count the number of open parentheses between the start of the tuple and the first element.
let open_parentheses_count =
SimpleTokenizer::new(source, TextRange::new(tuple.start(), elt.start()))
.skip_trivia()
.filter(|token| token.kind() == SimpleTokenKind::LParen)
.count();
if open_parentheses_count == 0 {
return false;
}
// Count the number of parentheses between the end of the first element and its trailing comma.
let close_parentheses_count =
SimpleTokenizer::new(source, TextRange::new(elt.end(), tuple.end()))
.skip_trivia()
.take_while(|token| token.kind() != SimpleTokenKind::Comma)
.filter(|token| token.kind() == SimpleTokenKind::RParen)
.count();
// If the number of open parentheses is greater than the number of close parentheses, the tuple
// is parenthesized.
open_parentheses_count > close_parentheses_count
}