mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-29 13:25:17 +00:00
fc89976c24
## Summary The motivation here is that this enables us to implement `Ranged` in crates that don't depend on `ruff_python_ast`. Largely a mechanical refactor with a lot of regex, Clippy help, and manual fixups. ## Test Plan `cargo test`
48 lines
2.2 KiB
Rust
48 lines
2.2 KiB
Rust
use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer};
|
|
use ruff_text_size::{Ranged, TextRange, TextSize};
|
|
|
|
use crate::node::AnyNodeRef;
|
|
use crate::ExpressionRef;
|
|
|
|
/// Returns the [`TextRange`] of a given expression including parentheses, if the expression is
|
|
/// parenthesized; or `None`, if the expression is not parenthesized.
|
|
pub fn parenthesized_range(
|
|
expr: ExpressionRef,
|
|
parent: AnyNodeRef,
|
|
source: &str,
|
|
) -> Option<TextRange> {
|
|
// If the parent is a node that brings its own parentheses, exclude the closing parenthesis
|
|
// from our search range. Otherwise, we risk matching on calls, like `func(x)`, for which
|
|
// the open and close parentheses are part of the `Arguments` node.
|
|
//
|
|
// There are a few other nodes that may have their own parentheses, but are fine to exclude:
|
|
// - `Parameters`: The parameters to a function definition. Any expressions would represent
|
|
// default arguments, and so must be preceded by _at least_ the parameter name. As such,
|
|
// we won't mistake any parentheses for the opening and closing parentheses on the
|
|
// `Parameters` node itself.
|
|
// - `Tuple`: The elements of a tuple. The only risk is a single-element tuple (e.g., `(x,)`),
|
|
// which must have a trailing comma anyway.
|
|
let exclusive_parent_end = if parent.is_arguments() {
|
|
parent.end() - TextSize::new(1)
|
|
} else {
|
|
parent.end()
|
|
};
|
|
|
|
let right_tokenizer =
|
|
SimpleTokenizer::new(source, TextRange::new(expr.end(), exclusive_parent_end))
|
|
.skip_trivia()
|
|
.take_while(|token| token.kind == SimpleTokenKind::RParen);
|
|
|
|
let left_tokenizer = SimpleTokenizer::up_to_without_back_comment(expr.start(), source)
|
|
.skip_trivia()
|
|
.rev()
|
|
.take_while(|token| token.kind == SimpleTokenKind::LParen);
|
|
|
|
// Zip closing parenthesis with opening parenthesis. The order is intentional, as testing for
|
|
// closing parentheses is cheaper, and `zip` will avoid progressing the `left_tokenizer` if
|
|
// the `right_tokenizer` is exhausted.
|
|
right_tokenizer
|
|
.zip(left_tokenizer)
|
|
.last()
|
|
.map(|(right, left)| TextRange::new(left.start(), right.end()))
|
|
}
|