mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-03 18:28:56 +00:00
add DebugText for self-documenting f-strings (#6167)
This commit is contained in:
David Szotten
GitHub
parent
44a8d1c644
commit
ba990b676f
26 changed files with 148 additions and 155 deletions
|
|
@ -112,6 +112,7 @@ expression: parse_ast
|
|||
keywords: [],
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
@ -199,6 +200,7 @@ expression: parse_ast
|
|||
keywords: [],
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -216,6 +216,7 @@ expression: parse_ast
|
|||
keywords: [],
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
@ -249,6 +250,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
@ -336,6 +338,7 @@ expression: parse_ast
|
|||
keywords: [],
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
@ -369,6 +372,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
@ -52,6 +53,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -3,24 +3,6 @@ source: crates/ruff_python_parser/src/string.rs
|
|||
expression: parse_ast
|
||||
---
|
||||
[
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..9,
|
||||
value: Str(
|
||||
"user=",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..9,
|
||||
value: Str(
|
||||
"",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
FormattedValue(
|
||||
ExprFormattedValue {
|
||||
range: 2..9,
|
||||
|
|
@ -31,7 +13,13 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
conversion: Repr,
|
||||
debug_text: Some(
|
||||
DebugText {
|
||||
leading: "",
|
||||
trailing: "=",
|
||||
},
|
||||
),
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
),
|
||||
|
|
|
|||
|
|
@ -12,24 +12,6 @@ expression: parse_ast
|
|||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 6..13,
|
||||
value: Str(
|
||||
"user=",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 6..13,
|
||||
value: Str(
|
||||
"",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
FormattedValue(
|
||||
ExprFormattedValue {
|
||||
range: 6..13,
|
||||
|
|
@ -40,7 +22,13 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
conversion: Repr,
|
||||
debug_text: Some(
|
||||
DebugText {
|
||||
leading: "",
|
||||
trailing: "=",
|
||||
},
|
||||
),
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
),
|
||||
|
|
@ -53,24 +41,6 @@ expression: parse_ast
|
|||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 28..37,
|
||||
value: Str(
|
||||
"second=",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 28..37,
|
||||
value: Str(
|
||||
"",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
FormattedValue(
|
||||
ExprFormattedValue {
|
||||
range: 28..37,
|
||||
|
|
@ -81,7 +51,13 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
conversion: Repr,
|
||||
debug_text: Some(
|
||||
DebugText {
|
||||
leading: "",
|
||||
trailing: "=",
|
||||
},
|
||||
),
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
),
|
||||
|
|
|
|||
|
|
@ -3,24 +3,6 @@ source: crates/ruff_python_parser/src/string.rs
|
|||
expression: parse_ast
|
||||
---
|
||||
[
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..13,
|
||||
value: Str(
|
||||
"user=",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..13,
|
||||
value: Str(
|
||||
"",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
FormattedValue(
|
||||
ExprFormattedValue {
|
||||
range: 2..13,
|
||||
|
|
@ -31,6 +13,12 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: Some(
|
||||
DebugText {
|
||||
leading: "",
|
||||
trailing: "=",
|
||||
},
|
||||
),
|
||||
conversion: None,
|
||||
format_spec: Some(
|
||||
JoinedStr(
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ expression: parse_ast
|
|||
kind: None,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
@ -27,6 +28,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ expression: parse_ast
|
|||
],
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: Some(
|
||||
JoinedStr(
|
||||
|
|
@ -29,6 +30,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ expression: parse_ast
|
|||
],
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: Some(
|
||||
JoinedStr(
|
||||
|
|
|
|||
|
|
@ -3,24 +3,6 @@ source: crates/ruff_python_parser/src/string.rs
|
|||
expression: parse_ast
|
||||
---
|
||||
[
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..9,
|
||||
value: Str(
|
||||
"x =",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..9,
|
||||
value: Str(
|
||||
"",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
FormattedValue(
|
||||
ExprFormattedValue {
|
||||
range: 2..9,
|
||||
|
|
@ -31,7 +13,13 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
conversion: Repr,
|
||||
debug_text: Some(
|
||||
DebugText {
|
||||
leading: "",
|
||||
trailing: " =",
|
||||
},
|
||||
),
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
),
|
||||
|
|
|
|||
|
|
@ -3,24 +3,6 @@ source: crates/ruff_python_parser/src/string.rs
|
|||
expression: parse_ast
|
||||
---
|
||||
[
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..9,
|
||||
value: Str(
|
||||
"x=",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
Constant(
|
||||
ExprConstant {
|
||||
range: 2..9,
|
||||
value: Str(
|
||||
" ",
|
||||
),
|
||||
kind: None,
|
||||
},
|
||||
),
|
||||
FormattedValue(
|
||||
ExprFormattedValue {
|
||||
range: 2..9,
|
||||
|
|
@ -31,7 +13,13 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
conversion: Repr,
|
||||
debug_text: Some(
|
||||
DebugText {
|
||||
leading: "",
|
||||
trailing: "= ",
|
||||
},
|
||||
),
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
),
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ expression: parse_ast
|
|||
value: None,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@ expression: parse_ast
|
|||
ctx: Load,
|
||||
},
|
||||
),
|
||||
debug_text: None,
|
||||
conversion: None,
|
||||
format_spec: None,
|
||||
},
|
||||
|
|
|
|||
|
|
@ -182,11 +182,15 @@ impl<'a> StringParser<'a> {
|
|||
};
|
||||
|
||||
let mut expression = String::new();
|
||||
// for self-documenting strings we also store the `=` and any trailing space inside
|
||||
// expression (because we want to combine it with any trailing spaces before the equal
|
||||
// sign). the expression_length is the length of the actual expression part that we pass to
|
||||
// `parse_fstring_expr`
|
||||
let mut expression_length = 0;
|
||||
let mut spec = None;
|
||||
let mut delimiters = Vec::new();
|
||||
let mut conversion = ConversionFlag::None;
|
||||
let mut self_documenting = false;
|
||||
let mut trailing_seq = String::new();
|
||||
let start_location = self.get_pos();
|
||||
|
||||
assert_eq!(self.next_char(), Some('{'));
|
||||
|
|
@ -230,6 +234,8 @@ impl<'a> StringParser<'a> {
|
|||
// match a python 3.8 self documenting expression
|
||||
// format '{' PYTHON_EXPRESSION '=' FORMAT_SPECIFIER? '}'
|
||||
'=' if self.peek() != Some('=') && delimiters.is_empty() => {
|
||||
expression_length = expression.len();
|
||||
expression.push(ch);
|
||||
self_documenting = true;
|
||||
}
|
||||
|
||||
|
|
@ -304,40 +310,28 @@ impl<'a> StringParser<'a> {
|
|||
}
|
||||
|
||||
let ret = if self_documenting {
|
||||
// TODO: range is wrong but `self_documenting` needs revisiting beyond
|
||||
// ranges: https://github.com/astral-sh/ruff/issues/5970
|
||||
vec![
|
||||
Expr::from(ast::ExprConstant {
|
||||
value: Constant::Str(expression.clone() + "="),
|
||||
kind: None,
|
||||
range: self.range(start_location),
|
||||
let value =
|
||||
parse_fstring_expr(&expression[..expression_length], start_location)
|
||||
.map_err(|e| {
|
||||
FStringError::new(
|
||||
InvalidExpression(Box::new(e.error)),
|
||||
start_location,
|
||||
)
|
||||
})?;
|
||||
let leading =
|
||||
&expression[..usize::from(value.range().start() - start_location) - 1];
|
||||
let trailing =
|
||||
&expression[usize::from(value.range().end() - start_location) - 1..];
|
||||
vec![Expr::from(ast::ExprFormattedValue {
|
||||
value: Box::new(value),
|
||||
debug_text: Some(ast::DebugText {
|
||||
leading: leading.to_string(),
|
||||
trailing: trailing.to_string(),
|
||||
}),
|
||||
Expr::from(ast::ExprConstant {
|
||||
value: trailing_seq.into(),
|
||||
kind: None,
|
||||
range: self.range(start_location),
|
||||
}),
|
||||
Expr::from(ast::ExprFormattedValue {
|
||||
value: Box::new(
|
||||
parse_fstring_expr(&expression, start_location).map_err(
|
||||
|e| {
|
||||
FStringError::new(
|
||||
InvalidExpression(Box::new(e.error)),
|
||||
start_location,
|
||||
)
|
||||
},
|
||||
)?,
|
||||
),
|
||||
conversion: if conversion == ConversionFlag::None && spec.is_none()
|
||||
{
|
||||
ConversionFlag::Repr
|
||||
} else {
|
||||
conversion
|
||||
},
|
||||
format_spec: spec,
|
||||
range: self.range(start_location),
|
||||
}),
|
||||
]
|
||||
conversion,
|
||||
format_spec: spec,
|
||||
range: self.range(start_location),
|
||||
})]
|
||||
} else {
|
||||
vec![Expr::from(ast::ExprFormattedValue {
|
||||
value: Box::new(
|
||||
|
|
@ -348,6 +342,7 @@ impl<'a> StringParser<'a> {
|
|||
)
|
||||
})?,
|
||||
),
|
||||
debug_text: None,
|
||||
conversion,
|
||||
format_spec: spec,
|
||||
range: self.range(start_location),
|
||||
|
|
@ -369,9 +364,7 @@ impl<'a> StringParser<'a> {
|
|||
}
|
||||
}
|
||||
}
|
||||
' ' if self_documenting => {
|
||||
trailing_seq.push(ch);
|
||||
}
|
||||
' ' if self_documenting => expression.push(ch),
|
||||
'\\' => return Err(FStringError::new(UnterminatedString, self.get_pos()).into()),
|
||||
_ => {
|
||||
if self_documenting {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue