mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 10:48:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Visit Identifier node as part of the SourceOrderVisitor (#17110)
Some checks are pending
CI / Determine changes (push) Waiting to run
Details
CI / cargo fmt (push) Waiting to run
Details
CI / cargo clippy (push) Blocked by required conditions
Details
CI / cargo test (linux) (push) Blocked by required conditions
Details
CI / cargo test (linux, release) (push) Blocked by required conditions
Details
CI / cargo test (windows) (push) Blocked by required conditions
Details
CI / cargo test (wasm) (push) Blocked by required conditions
Details
CI / cargo build (release) (push) Waiting to run
Details
CI / cargo build (msrv) (push) Blocked by required conditions
Details
CI / cargo fuzz build (push) Blocked by required conditions
Details
CI / fuzz parser (push) Blocked by required conditions
Details
CI / test scripts (push) Blocked by required conditions
Details
CI / ecosystem (push) Blocked by required conditions
Details
CI / cargo shear (push) Blocked by required conditions
Details
CI / python package (push) Waiting to run
Details
CI / pre-commit (push) Waiting to run
Details
CI / mkdocs (push) Waiting to run
Details
CI / formatter instabilities and black similarity (push) Blocked by required conditions
Details
CI / test ruff-lsp (push) Blocked by required conditions
Details
CI / check playground (push) Blocked by required conditions
Details
CI / benchmarks (push) Blocked by required conditions
Details
[Knot Playground] Release / publish (push) Waiting to run
Details

Browse source 
## Summary

I don't remember exactly when we made `Identifier` a node but it is now
considered a node (it implements `AnyNodeRef`, it has a range). However,
we never updated
the `SourceOrderVisitor` to visit identifiers because we never had a use
case for it and visiting new nodes can change how the formatter
associates comments (breaking change!).
This PR updates the `SourceOrderVisitor` to visit identifiers and
changes the formatter comment visitor to skip identifiers (updating the
visitor might be desired because it could help simplifying some comment
placement logic but this is out of scope for this PR).

## Test Plan

Tests, updated snapshot tests
This commit is contained in:
Micha Reiser 2025-04-01 16:58:09 +02:00 • committed by GitHub
parent 49c25993eb
commit 5a876ed25e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 142 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

6
crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__class_type_parameters.snap
View file

@ -1,15 +1,19 @@
---
source: crates/ruff_python_ast_integration_tests/tests/source_order.rs
expression: trace
snapshot_kind: text
---
- ModModule
- StmtClassDef
- Identifier
- TypeParams
- TypeParamTypeVar
- Identifier
- ExprName
- TypeParamTypeVar
- Identifier
- TypeParamTypeVarTuple
- Identifier
- TypeParamParamSpec
- Identifier
- StmtExpr
- ExprEllipsisLiteral

3
crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__decorators.snap
View file

@ -1,15 +1,16 @@
---
source: crates/ruff_python_ast_integration_tests/tests/source_order.rs
expression: trace
snapshot_kind: text
---
- ModModule
- StmtFunctionDef
- Decorator
- ExprName
- Identifier
- Parameters
- StmtPass
- StmtClassDef
- Decorator
- ExprName
- Identifier
- StmtPass

10
crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_arguments.snap
View file

@ -1,26 +1,34 @@
---
source: crates/ruff_python_ast_integration_tests/tests/source_order.rs
expression: trace
snapshot_kind: text
---
- ModModule
- StmtFunctionDef
- Identifier
- Parameters
- ParameterWithDefault
- Parameter
- Identifier
- ParameterWithDefault
- Parameter
- Identifier
- ParameterWithDefault
- Parameter
- Identifier
- ParameterWithDefault
- Parameter
- Identifier
- ExprNumberLiteral
- Parameter
- Identifier
- ParameterWithDefault
- Parameter
- Identifier
- ExprNumberLiteral
- ParameterWithDefault
- Parameter
- Identifier
- ExprNumberLiteral
- Parameter
- Identifier
- StmtPass

6
crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_positional_only_with_default.snap
View file

@ -1,18 +1,22 @@
---
source: crates/ruff_python_ast_integration_tests/tests/source_order.rs
expression: trace
snapshot_kind: text
---
- ModModule
- StmtFunctionDef
- Identifier
- Parameters
- ParameterWithDefault
- Parameter
- Identifier
- ParameterWithDefault
- Parameter
- Identifier
- ExprNumberLiteral
- ParameterWithDefault
- Parameter
- Identifier
- ExprNumberLiteral
- Parameter
- Identifier
- StmtPass

6
crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__function_type_parameters.snap
View file

@ -1,16 +1,20 @@
---
source: crates/ruff_python_ast_integration_tests/tests/source_order.rs
expression: trace
snapshot_kind: text
---
- ModModule
- StmtFunctionDef
- Identifier
- TypeParams
- TypeParamTypeVar
- Identifier
- ExprName
- TypeParamTypeVar
- Identifier
- TypeParamTypeVarTuple
- Identifier
- TypeParamParamSpec
- Identifier
- Parameters
- StmtExpr
- ExprEllipsisLiteral

5
crates/ruff_python_ast_integration_tests/tests/snapshots/source_order__type_aliases.snap
View file

@ -1,17 +1,20 @@
---
source: crates/ruff_python_ast_integration_tests/tests/source_order.rs
expression: trace
snapshot_kind: text
---
- ModModule
- StmtTypeAlias
- ExprName
- TypeParams
- TypeParamTypeVar
- Identifier
- ExprName
- TypeParamTypeVar
- Identifier
- TypeParamTypeVarTuple
- Identifier
- TypeParamParamSpec
- Identifier
- ExprSubscript
- ExprName
- ExprName