Split Constant to individual literal nodes (#8064)

## Summary

This PR splits the `Constant` enum as individual literal nodes. It
introduces the following new nodes for each variant:
* `ExprStringLiteral`
* `ExprBytesLiteral`
* `ExprNumberLiteral`
* `ExprBooleanLiteral`
* `ExprNoneLiteral`
* `ExprEllipsisLiteral`

The main motivation behind this refactor is to introduce the new AST
node for implicit string concatenation in the coming PR. The elements of
that node will be either a string literal, bytes literal or a f-string
which can be implemented using an enum. This means that a string or
bytes literal cannot be represented by `Constant::Str` /
`Constant::Bytes` which creates an inconsistency.

This PR avoids that inconsistency by splitting the constant nodes into
it's own literal nodes, literal being the more appropriate naming
convention from a static analysis tool perspective.

This also makes working with literals in the linter and formatter much
more ergonomic like, for example, if one would want to check if this is
a string literal, it can be done easily using
`Expr::is_string_literal_expr` or matching against `Expr::StringLiteral`
as oppose to matching against the `ExprConstant` and enum `Constant`. A
few AST helper methods can be simplified as well which will be done in a
follow-up PR.

This introduces a new `Expr::is_literal_expr` method which is the same
as `Expr::is_constant_expr`. There are also intermediary changes related
to implicit string concatenation which are quiet less. This is done so
as to avoid having a huge PR which this already is.

## Test Plan

1. Verify and update all of the existing snapshots (parser, visitor)
2. Verify that the ecosystem check output remains **unchanged** for both
the linter and formatter

### Formatter ecosystem check

#### `main`

| project | similarity index | total files | changed files |

|----------------|------------------:|------------------:|------------------:|
| cpython | 0.75803 | 1799 | 1647 |
| django | 0.99983 | 2772 | 34 |
| home-assistant | 0.99953 | 10596 | 186 |
| poetry | 0.99891 | 317 | 17 |
| transformers | 0.99966 | 2657 | 330 |
| twine | 1.00000 | 33 | 0 |
| typeshed | 0.99978 | 3669 | 20 |
| warehouse | 0.99977 | 654 | 13 |
| zulip | 0.99970 | 1459 | 22 |

#### `dhruv/constant-to-literal`

| project | similarity index | total files | changed files |

|----------------|------------------:|------------------:|------------------:|
| cpython | 0.75803 | 1799 | 1647 |
| django | 0.99983 | 2772 | 34 |
| home-assistant | 0.99953 | 10596 | 186 |
| poetry | 0.99891 | 317 | 17 |
| transformers | 0.99966 | 2657 | 330 |
| twine | 1.00000 | 33 | 0 |
| typeshed | 0.99978 | 3669 | 20 |
| warehouse | 0.99977 | 654 | 13 |
| zulip | 0.99970 | 1459 | 22 |
This commit is contained in:
Dhruv Manilawala 2023-10-30 12:13:23 +05:30 committed by GitHub
parent 78bbf6d403
commit 230c9ce236
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
268 changed files with 6663 additions and 6741 deletions

View file

@ -9,8 +9,8 @@ use ruff_python_ast::visitor::preorder::{
};
use ruff_python_ast::AnyNodeRef;
use ruff_python_ast::{
Alias, BoolOp, CmpOp, Comprehension, Constant, ExceptHandler, Expr, Keyword, MatchCase, Mod,
Operator, Parameter, Parameters, Pattern, Singleton, Stmt, TypeParam, UnaryOp, WithItem,
Alias, BoolOp, CmpOp, Comprehension, ExceptHandler, Expr, Keyword, MatchCase, Mod, Operator,
Parameter, Parameters, Pattern, Singleton, Stmt, TypeParam, UnaryOp, WithItem,
};
use ruff_python_parser::lexer::lex;
use ruff_python_parser::{parse_tokens, Mode};
@ -193,10 +193,6 @@ impl PreorderVisitor<'_> for RecordVisitor {
self.exit_node();
}
fn visit_constant(&mut self, constant: &Constant) {
self.emit(&constant);
}
fn visit_singleton(&mut self, singleton: &Singleton) {
self.emit(&singleton);
}

View file

@ -10,6 +10,5 @@ expression: trace
- TypeParamTypeVarTuple
- TypeParamParamSpec
- StmtExpr
- ExprConstant
- Ellipsis
- ExprEllipsisLiteral

View file

@ -5,11 +5,9 @@ expression: trace
- ModModule
- StmtExpr
- ExprCompare
- ExprConstant
- Int(4)
- ExprNumberLiteral
- Lt
- ExprName
- Lt
- ExprConstant
- Int(5)
- ExprNumberLiteral

View file

@ -9,8 +9,7 @@ expression: trace
- ExprBinOp
- ExprName
- Pow
- ExprConstant
- Int(2)
- ExprNumberLiteral
- Comprehension
- ExprName
- ExprName

View file

@ -9,15 +9,12 @@ expression: trace
- Parameter
- Parameter
- Parameter
- ExprConstant
- Int(20)
- ExprNumberLiteral
- Parameter
- Parameter
- ExprConstant
- Int(5)
- ExprNumberLiteral
- Parameter
- ExprConstant
- Int(20)
- ExprNumberLiteral
- Parameter
- StmtPass

View file

@ -7,11 +7,9 @@ expression: trace
- Parameters
- Parameter
- Parameter
- ExprConstant
- Int(34)
- ExprNumberLiteral
- Parameter
- ExprConstant
- Int(20)
- ExprNumberLiteral
- Parameter
- StmtPass

View file

@ -11,6 +11,5 @@ expression: trace
- TypeParamParamSpec
- Parameters
- StmtExpr
- ExprConstant
- Ellipsis
- ExprEllipsisLiteral

View file

@ -9,27 +9,20 @@ expression: trace
- PatternMatchClass
- ExprName
- PatternMatchValue
- ExprConstant
- Int(0)
- ExprNumberLiteral
- PatternMatchValue
- ExprConstant
- Int(0)
- ExprNumberLiteral
- StmtExpr
- ExprConstant
- Ellipsis
- ExprEllipsisLiteral
- MatchCase
- PatternMatchClass
- ExprName
- PatternMatchValue
- ExprConstant
- Int(0)
- ExprNumberLiteral
- PatternMatchValue
- ExprConstant
- Int(0)
- ExprNumberLiteral
- PatternMatchValue
- ExprConstant
- Int(0)
- ExprNumberLiteral
- StmtExpr
- ExprConstant
- Ellipsis
- ExprEllipsisLiteral

View file

@ -9,5 +9,5 @@ expression: trace
- TypeParamTypeVarTuple
- TypeParamParamSpec
- StmtExpr
- ExprConstant
- ExprEllipsisLiteral

View file

@ -4,9 +4,9 @@ expression: trace
---
- StmtExpr
- ExprCompare
- ExprConstant
- ExprNumberLiteral
- Lt
- Lt
- ExprName
- ExprConstant
- ExprNumberLiteral

View file

@ -11,5 +11,5 @@ expression: trace
- ExprBinOp
- ExprName
- Pow
- ExprConstant
- ExprNumberLiteral

View file

@ -4,9 +4,9 @@ expression: trace
---
- StmtFunctionDef
- Parameters
- ExprConstant
- ExprConstant
- ExprConstant
- ExprNumberLiteral
- ExprNumberLiteral
- ExprNumberLiteral
- Parameter
- Parameter
- Parameter

View file

@ -4,8 +4,8 @@ expression: trace
---
- StmtFunctionDef
- Parameters
- ExprConstant
- ExprConstant
- ExprNumberLiteral
- ExprNumberLiteral
- Parameter
- Parameter
- Parameter

View file

@ -10,5 +10,5 @@ expression: trace
- TypeParamParamSpec
- Parameters
- StmtExpr
- ExprConstant
- ExprEllipsisLiteral

View file

@ -8,20 +8,20 @@ expression: trace
- PatternMatchClass
- ExprName
- PatternMatchValue
- ExprConstant
- ExprNumberLiteral
- PatternMatchValue
- ExprConstant
- ExprNumberLiteral
- StmtExpr
- ExprConstant
- ExprEllipsisLiteral
- MatchCase
- PatternMatchClass
- ExprName
- PatternMatchValue
- ExprConstant
- ExprNumberLiteral
- PatternMatchValue
- ExprConstant
- ExprNumberLiteral
- PatternMatchValue
- ExprConstant
- ExprNumberLiteral
- StmtExpr
- ExprConstant
- ExprEllipsisLiteral