-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expand expressions to include parentheses in E712
- Loading branch information
1 parent
d9bb51d
commit 658b550
Showing
9 changed files
with
232 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer}; | ||
| use ruff_text_size::{TextRange, TextSize}; | ||
| use std::ops::Sub; | ||
|
|
||
| use crate::node::AnyNodeRef; | ||
| use crate::Ranged; | ||
|
|
||
| /// A wrapper around an expression that may be parenthesized. | ||
| #[derive(Debug)] | ||
| pub struct ParenthesizedExpression<'a> { | ||
| /// The underlying AST node. | ||
| expr: AnyNodeRef<'a>, | ||
| /// The range of the expression including parentheses, if the expression is parenthesized; | ||
| /// or `None`, if the expression is not parenthesized. | ||
| range: Option<TextRange>, | ||
| } | ||
|
|
||
| impl<'a> ParenthesizedExpression<'a> { | ||
| /// Given an expression and its parent, returns a parenthesized expression. | ||
| pub fn from_expr(expr: AnyNodeRef<'a>, parent: AnyNodeRef<'a>, contents: &str) -> Self { | ||
| Self { | ||
| expr, | ||
| range: parenthesized_range(expr, parent, contents), | ||
| } | ||
| } | ||
|
|
||
| /// Returns `true` if the expression is parenthesized. | ||
| pub fn is_parenthesized(&self) -> bool { | ||
| self.range.is_some() | ||
| } | ||
| } | ||
|
|
||
| impl Ranged for ParenthesizedExpression<'_> { | ||
| fn range(&self) -> TextRange { | ||
| self.range.unwrap_or_else(|| self.expr.range()) | ||
| } | ||
| } | ||
|
|
||
| /// Returns the [`TextRange`] of a given expression including parentheses, if the expression is | ||
| /// parenthesized; or `None`, if the expression is not parenthesized. | ||
| fn parenthesized_range(expr: AnyNodeRef, parent: AnyNodeRef, contents: &str) -> Option<TextRange> { | ||
| // If the parent is an `arguments` node, then the range of the expression includes the closing | ||
| // parenthesis, so exclude it from our test range. | ||
| let exclusive_parent_end = if parent.is_arguments() { | ||
| parent.end().sub(TextSize::new(1)) | ||
| } else { | ||
| parent.end() | ||
| }; | ||
|
|
||
| // First, test if there's a closing parenthesis because it tends to be cheaper. | ||
| let tokenizer = | ||
| SimpleTokenizer::new(contents, TextRange::new(expr.end(), exclusive_parent_end)); | ||
| let right = tokenizer.skip_trivia().next()?; | ||
|
|
||
| if right.kind == SimpleTokenKind::RParen { | ||
| // Next, test for the opening parenthesis. | ||
| let mut tokenizer = | ||
| SimpleTokenizer::up_to_without_back_comment(expr.start(), contents).skip_trivia(); | ||
| let left = tokenizer.next_back()?; | ||
| if left.kind == SimpleTokenKind::LParen { | ||
| return Some(TextRange::new(left.start(), right.end())); | ||
| } | ||
| } | ||
|
|
||
| None | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| use ruff_python_ast::parenthesize::ParenthesizedExpression; | ||
| use ruff_python_parser::parse_expression; | ||
|
|
||
| #[test] | ||
| fn test_parenthesized_name() { | ||
| let source_code = r#"(x) + 1"#; | ||
| let expr = parse_expression(source_code, "<filename>").unwrap(); | ||
|
|
||
| let bin_op = expr.as_bin_op_expr().unwrap(); | ||
| let name = bin_op.left.as_ref(); | ||
|
|
||
| let parenthesized = ParenthesizedExpression::from_expr(name.into(), bin_op.into(), source_code); | ||
| assert!(parenthesized.is_parenthesized()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_un_parenthesized_name() { | ||
| let source_code = r#"x + 1"#; | ||
| let expr = parse_expression(source_code, "<filename>").unwrap(); | ||
|
|
||
| let bin_op = expr.as_bin_op_expr().unwrap(); | ||
| let name = bin_op.left.as_ref(); | ||
|
|
||
| let parenthesized = ParenthesizedExpression::from_expr(name.into(), bin_op.into(), source_code); | ||
| assert!(!parenthesized.is_parenthesized()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_parenthesized_argument() { | ||
| let source_code = r#"f((a))"#; | ||
| let expr = parse_expression(source_code, "<filename>").unwrap(); | ||
|
|
||
| let call = expr.as_call_expr().unwrap(); | ||
| let arguments = &call.arguments; | ||
| let argument = arguments.args.first().unwrap(); | ||
|
|
||
| let parenthesized = | ||
| ParenthesizedExpression::from_expr(argument.into(), arguments.into(), source_code); | ||
| assert!(parenthesized.is_parenthesized()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_unparenthesized_argument() { | ||
| let source_code = r#"f(a)"#; | ||
| let expr = parse_expression(source_code, "<filename>").unwrap(); | ||
|
|
||
| let call = expr.as_call_expr().unwrap(); | ||
| let arguments = &call.arguments; | ||
| let argument = arguments.args.first().unwrap(); | ||
|
|
||
| let parenthesized = | ||
| ParenthesizedExpression::from_expr(argument.into(), arguments.into(), source_code); | ||
| assert!(!parenthesized.is_parenthesized()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_parenthesized_tuple_member() { | ||
| let source_code = r#"(a, (b))"#; | ||
| let expr = parse_expression(source_code, "<filename>").unwrap(); | ||
|
|
||
| let tuple = expr.as_tuple_expr().unwrap(); | ||
| let member = tuple.elts.last().unwrap(); | ||
|
|
||
| let parenthesized = | ||
| ParenthesizedExpression::from_expr(member.into(), tuple.into(), source_code); | ||
| assert!(parenthesized.is_parenthesized()); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_unparenthesized_tuple_member() { | ||
| let source_code = r#"(a, b)"#; | ||
| let expr = parse_expression(source_code, "<filename>").unwrap(); | ||
|
|
||
| let tuple = expr.as_tuple_expr().unwrap(); | ||
| let member = tuple.elts.last().unwrap(); | ||
|
|
||
| let parenthesized = | ||
| ParenthesizedExpression::from_expr(member.into(), tuple.into(), source_code); | ||
| assert!(!parenthesized.is_parenthesized()); | ||
| } |