mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-23 13:05:06 +00:00
New AST nodes for f-string elements (#8835)
Rebase of #6365 authored by @davidszotten. ## Summary This PR updates the AST structure for an f-string elements. The main **motivation** behind this change is to have a dedicated node for the string part of an f-string. Previously, the existing `ExprStringLiteral` node was used for this purpose which isn't exactly correct. The `ExprStringLiteral` node should include the quotes as well in the range but the f-string literal element doesn't include the quote as it's a specific part within an f-string. For example, ```python f"foo {x}" # ^^^^ # This is the literal part of an f-string ``` The introduction of `FStringElement` enum is helpful which represent either the literal part or the expression part of an f-string. ### Rule Updates This means that there'll be two nodes representing a string depending on the context. One for a normal string literal while the other is a string literal within an f-string. The AST checker is updated to accommodate this change. The rules which work on string literal are updated to check on the literal part of f-string as well. #### Notes 1. The `Expr::is_literal_expr` method would check for `ExprStringLiteral` and return true if so. But now that we don't represent the literal part of an f-string using that node, this improves the method's behavior and confines to the actual expression. We do have the `FStringElement::is_literal` method. 2. We avoid checking if we're in a f-string context before adding to `string_type_definitions` because the f-string literal is now a dedicated node and not part of `Expr`. 3. Annotations cannot use f-string so we avoid changing any rules which work on annotation and checks for `ExprStringLiteral`. ## Test Plan - All references of `Expr::StringLiteral` were checked to see if any of the rules require updating to account for the f-string literal element node. - New test cases are added for rules which check against the literal part of an f-string. - Check the ecosystem results and ensure it remains unchanged. ## Performance There's a performance penalty in the parser. The reason for this remains unknown as it seems that the generated assembly code is now different for the `__reduce154` function. The reduce function body is just popping the `ParenthesizedExpr` on top of the stack and pushing it with the new location. - The size of `FStringElement` enum is the same as `Expr` which is what it replaces in `FString::format_spec` - The size of `FStringExpressionElement` is the same as `ExprFormattedValue` which is what it replaces I tried reducing the `Expr` enum from 80 bytes to 72 bytes but it hardly resulted in any performance gain. The difference can be seen here: - Original profile: https://share.firefox.dev/3Taa7ES - Profile after boxing some node fields: https://share.firefox.dev/3GsNXpD ### Backtracking I tried backtracking the changes to see if any of the isolated change produced this regression. The problem here is that the overall change is so small that there's only a single checkpoint where I can backtrack and that checkpoint results in the same regression. This checkpoint is to revert using `Expr` to the `FString::format_spec` field. After this point, the change would revert back to the original implementation. ## Review process The review process is similar to #7927. The first set of commits update the node structure, parser, and related AST files. Then, further commits update the linter and formatter part to account for the AST change. --------- Co-authored-by: David Szotten <davidszotten@gmail.com>
This commit is contained in:
parent
fcc08894cf
commit
cdac90ef68
77 changed files with 1714 additions and 1925 deletions
|
@ -1069,18 +1069,6 @@ impl<'a> Generator<'a> {
|
|||
}
|
||||
self.p(")");
|
||||
}
|
||||
Expr::FormattedValue(ast::ExprFormattedValue {
|
||||
value,
|
||||
debug_text,
|
||||
conversion,
|
||||
format_spec,
|
||||
range: _,
|
||||
}) => self.unparse_formatted(
|
||||
value,
|
||||
debug_text.as_ref(),
|
||||
*conversion,
|
||||
format_spec.as_deref(),
|
||||
),
|
||||
Expr::FString(ast::ExprFString { value, .. }) => {
|
||||
self.unparse_f_string_value(value, false);
|
||||
}
|
||||
|
@ -1300,24 +1288,24 @@ impl<'a> Generator<'a> {
|
|||
self.unparse_string_literal(string_literal);
|
||||
}
|
||||
ast::FStringPart::FString(f_string) => {
|
||||
self.unparse_f_string(&f_string.values, is_spec);
|
||||
self.unparse_f_string(&f_string.elements, is_spec);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn unparse_f_string_body(&mut self, values: &[Expr], is_spec: bool) {
|
||||
fn unparse_f_string_body(&mut self, values: &[ast::FStringElement]) {
|
||||
for value in values {
|
||||
self.unparse_f_string_elem(value, is_spec);
|
||||
self.unparse_f_string_element(value);
|
||||
}
|
||||
}
|
||||
|
||||
fn unparse_formatted(
|
||||
fn unparse_f_string_expression_element(
|
||||
&mut self,
|
||||
val: &Expr,
|
||||
debug_text: Option<&DebugText>,
|
||||
conversion: ConversionFlag,
|
||||
spec: Option<&Expr>,
|
||||
spec: Option<&ast::FStringFormatSpec>,
|
||||
) {
|
||||
let mut generator = Generator::new(self.indent, self.quote, self.line_ending);
|
||||
generator.unparse_expr(val, precedence::FORMATTED_VALUE);
|
||||
|
@ -1347,44 +1335,40 @@ impl<'a> Generator<'a> {
|
|||
|
||||
if let Some(spec) = spec {
|
||||
self.p(":");
|
||||
self.unparse_f_string_elem(spec, true);
|
||||
self.unparse_f_string(&spec.elements, true);
|
||||
}
|
||||
|
||||
self.p("}");
|
||||
}
|
||||
|
||||
fn unparse_f_string_elem(&mut self, expr: &Expr, is_spec: bool) {
|
||||
match expr {
|
||||
Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) => {
|
||||
self.unparse_f_string_literal(value.to_str());
|
||||
fn unparse_f_string_element(&mut self, element: &ast::FStringElement) {
|
||||
match element {
|
||||
ast::FStringElement::Literal(ast::FStringLiteralElement { value, .. }) => {
|
||||
self.unparse_f_string_literal_element(value);
|
||||
}
|
||||
Expr::FString(ast::ExprFString { value, .. }) => {
|
||||
self.unparse_f_string_value(value, is_spec);
|
||||
}
|
||||
Expr::FormattedValue(ast::ExprFormattedValue {
|
||||
value,
|
||||
ast::FStringElement::Expression(ast::FStringExpressionElement {
|
||||
expression,
|
||||
debug_text,
|
||||
conversion,
|
||||
format_spec,
|
||||
range: _,
|
||||
}) => self.unparse_formatted(
|
||||
value,
|
||||
}) => self.unparse_f_string_expression_element(
|
||||
expression,
|
||||
debug_text.as_ref(),
|
||||
*conversion,
|
||||
format_spec.as_deref(),
|
||||
),
|
||||
_ => unreachable!(),
|
||||
}
|
||||
}
|
||||
|
||||
fn unparse_f_string_literal(&mut self, s: &str) {
|
||||
fn unparse_f_string_literal_element(&mut self, s: &str) {
|
||||
let s = s.replace('{', "{{").replace('}', "}}");
|
||||
self.p(&s);
|
||||
}
|
||||
|
||||
fn unparse_f_string(&mut self, values: &[Expr], is_spec: bool) {
|
||||
fn unparse_f_string(&mut self, values: &[ast::FStringElement], is_spec: bool) {
|
||||
if is_spec {
|
||||
self.unparse_f_string_body(values, is_spec);
|
||||
self.unparse_f_string_body(values);
|
||||
} else {
|
||||
self.p("f");
|
||||
let mut generator = Generator::new(
|
||||
|
@ -1395,7 +1379,7 @@ impl<'a> Generator<'a> {
|
|||
},
|
||||
self.line_ending,
|
||||
);
|
||||
generator.unparse_f_string_body(values, is_spec);
|
||||
generator.unparse_f_string_body(values);
|
||||
let body = &generator.buffer;
|
||||
self.p_str_repr(body);
|
||||
}
|
||||
|
@ -1716,7 +1700,7 @@ class Foo:
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn self_documenting_f_string() {
|
||||
fn self_documenting_fstring() {
|
||||
assert_round_trip!(r#"f"{ chr(65) = }""#);
|
||||
assert_round_trip!(r#"f"{ chr(65) = !s}""#);
|
||||
assert_round_trip!(r#"f"{ chr(65) = !r}""#);
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue