Rename Arguments to Parameters in the AST (#6253)

## Summary

This PR renames a few AST nodes for clarity:

- `Arguments` is now `Parameters`
- `Arg` is now `Parameter`
- `ArgWithDefault` is now `ParameterWithDefault`

For now, the attribute names that reference `Parameters` directly are
changed (e.g., on `StmtFunctionDef`), but the attributes on `Parameters`
itself are not (e.g., `vararg`). We may revisit that decision in the
future.

For context, the AST node formerly known as `Arguments` is used in
function definitions. Formally (outside of the Python context),
"arguments" typically refers to "the values passed to a function", while
"parameters" typically refers to "the variables used in a function
definition". E.g., if you Google "arguments vs parameters", you'll get
some explanation like:

> A parameter is a variable in a function definition. It is a
placeholder and hence does not have a concrete value. An argument is a
value passed during function invocation.

We're thus deviating from Python's nomenclature in favor of a scheme
that we find to be more precise.
This commit is contained in:
Charlie Marsh 2023-08-01 13:53:28 -04:00 committed by GitHub
parent a82eb9544c
commit adc8bb7821
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
102 changed files with 2585 additions and 2529 deletions

View file

@ -11,15 +11,15 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..17,
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "a",
@ -29,9 +29,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..13,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "b",
@ -41,9 +41,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 15..16,
def: Arg {
def: Parameter {
range: 15..16,
arg: Identifier {
id: "c",

View file

@ -11,15 +11,15 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..23,
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "a",
@ -29,9 +29,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..16,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "b",
@ -51,9 +51,9 @@ Ok(
),
),
},
ArgWithDefault {
ParameterWithDefault {
range: 18..22,
def: Arg {
def: Parameter {
range: 18..19,
arg: Identifier {
id: "c",

View file

@ -11,7 +11,7 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..7,
posonlyargs: [],
args: [],

View file

@ -11,7 +11,7 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..7,
posonlyargs: [],
args: [],

View file

@ -11,13 +11,13 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..26,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 6..7,
def: Arg {
def: Parameter {
range: 6..7,
arg: Identifier {
id: "a",
@ -27,9 +27,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "b",
@ -39,9 +39,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..13,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "c",
@ -54,9 +54,9 @@ Ok(
],
vararg: None,
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 18..19,
def: Arg {
def: Parameter {
range: 18..19,
arg: Identifier {
id: "d",
@ -66,9 +66,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 21..22,
def: Arg {
def: Parameter {
range: 21..22,
arg: Identifier {
id: "e",
@ -78,9 +78,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 24..25,
def: Arg {
def: Parameter {
range: 24..25,
arg: Identifier {
id: "f",

View file

@ -11,13 +11,13 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..32,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 6..7,
def: Arg {
def: Parameter {
range: 6..7,
arg: Identifier {
id: "a",
@ -27,9 +27,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "b",
@ -39,9 +39,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..13,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "c",
@ -54,9 +54,9 @@ Ok(
],
vararg: None,
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 18..19,
def: Arg {
def: Parameter {
range: 18..19,
arg: Identifier {
id: "d",
@ -66,9 +66,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 21..25,
def: Arg {
def: Parameter {
range: 21..22,
arg: Identifier {
id: "e",
@ -88,9 +88,9 @@ Ok(
),
),
},
ArgWithDefault {
ParameterWithDefault {
range: 27..31,
def: Arg {
def: Parameter {
range: 27..28,
arg: Identifier {
id: "f",

View file

@ -11,13 +11,13 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..36,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 6..7,
def: Arg {
def: Parameter {
range: 6..7,
arg: Identifier {
id: "a",
@ -27,9 +27,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "b",
@ -39,9 +39,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..13,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "c",
@ -53,7 +53,7 @@ Ok(
},
],
vararg: Some(
Arg {
Parameter {
range: 16..20,
arg: Identifier {
id: "args",
@ -63,9 +63,9 @@ Ok(
},
),
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 22..23,
def: Arg {
def: Parameter {
range: 22..23,
arg: Identifier {
id: "d",
@ -75,9 +75,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 25..29,
def: Arg {
def: Parameter {
range: 25..26,
arg: Identifier {
id: "e",
@ -97,9 +97,9 @@ Ok(
),
),
},
ArgWithDefault {
ParameterWithDefault {
range: 31..35,
def: Arg {
def: Parameter {
range: 31..32,
arg: Identifier {
id: "f",

View file

@ -11,13 +11,13 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..46,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 6..7,
def: Arg {
def: Parameter {
range: 6..7,
arg: Identifier {
id: "a",
@ -27,9 +27,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "b",
@ -39,9 +39,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..13,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "c",
@ -53,7 +53,7 @@ Ok(
},
],
vararg: Some(
Arg {
Parameter {
range: 16..20,
arg: Identifier {
id: "args",
@ -63,9 +63,9 @@ Ok(
},
),
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 22..23,
def: Arg {
def: Parameter {
range: 22..23,
arg: Identifier {
id: "d",
@ -75,9 +75,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 25..29,
def: Arg {
def: Parameter {
range: 25..26,
arg: Identifier {
id: "e",
@ -97,9 +97,9 @@ Ok(
),
),
},
ArgWithDefault {
ParameterWithDefault {
range: 31..35,
def: Arg {
def: Parameter {
range: 31..32,
arg: Identifier {
id: "f",
@ -121,7 +121,7 @@ Ok(
},
],
kwarg: Some(
Arg {
Parameter {
range: 39..45,
arg: Identifier {
id: "kwargs",

View file

@ -11,13 +11,13 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..14,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 6..7,
def: Arg {
def: Parameter {
range: 6..7,
arg: Identifier {
id: "a",
@ -27,9 +27,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "b",
@ -39,9 +39,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..13,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "c",

View file

@ -11,13 +11,13 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..20,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 6..7,
def: Arg {
def: Parameter {
range: 6..7,
arg: Identifier {
id: "a",
@ -27,9 +27,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 9..13,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "b",
@ -49,9 +49,9 @@ Ok(
),
),
},
ArgWithDefault {
ParameterWithDefault {
range: 15..19,
def: Arg {
def: Parameter {
range: 15..16,
arg: Identifier {
id: "c",

View file

@ -11,13 +11,13 @@ Ok(
id: "f",
range: 4..5,
},
args: Arguments {
parameters: Parameters {
range: 5..14,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 6..7,
def: Arg {
def: Parameter {
range: 6..7,
arg: Identifier {
id: "a",
@ -27,9 +27,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "b",
@ -39,9 +39,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 12..13,
def: Arg {
def: Parameter {
range: 12..13,
arg: Identifier {
id: "c",

View file

@ -10,15 +10,15 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..20,
args: Arguments {
parameters: Parameters {
range: 7..17,
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 10..11,
def: Arg {
def: Parameter {
range: 10..11,
arg: Identifier {
id: "a",
@ -28,9 +28,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 13..14,
def: Arg {
def: Parameter {
range: 13..14,
arg: Identifier {
id: "b",
@ -40,9 +40,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 16..17,
def: Arg {
def: Parameter {
range: 16..17,
arg: Identifier {
id: "c",

View file

@ -10,15 +10,15 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..26,
args: Arguments {
parameters: Parameters {
range: 7..23,
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 10..11,
def: Arg {
def: Parameter {
range: 10..11,
arg: Identifier {
id: "a",
@ -28,9 +28,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 13..17,
def: Arg {
def: Parameter {
range: 13..14,
arg: Identifier {
id: "b",
@ -50,9 +50,9 @@ Ok(
),
),
},
ArgWithDefault {
ParameterWithDefault {
range: 19..23,
def: Arg {
def: Parameter {
range: 19..20,
arg: Identifier {
id: "c",

View file

@ -10,7 +10,7 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..9,
args: Arguments {
parameters: Parameters {
range: 6..6,
posonlyargs: [],
args: [],

View file

@ -10,13 +10,13 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..26,
args: Arguments {
parameters: Parameters {
range: 7..23,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 7..8,
def: Arg {
def: Parameter {
range: 7..8,
arg: Identifier {
id: "a",
@ -26,9 +26,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 10..11,
def: Arg {
def: Parameter {
range: 10..11,
arg: Identifier {
id: "b",
@ -38,9 +38,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 13..14,
def: Arg {
def: Parameter {
range: 13..14,
arg: Identifier {
id: "c",
@ -53,9 +53,9 @@ Ok(
],
vararg: None,
kwonlyargs: [
ArgWithDefault {
ParameterWithDefault {
range: 19..20,
def: Arg {
def: Parameter {
range: 19..20,
arg: Identifier {
id: "d",
@ -65,9 +65,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 22..23,
def: Arg {
def: Parameter {
range: 22..23,
arg: Identifier {
id: "e",

View file

@ -10,13 +10,13 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..17,
args: Arguments {
parameters: Parameters {
range: 7..14,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 7..8,
def: Arg {
def: Parameter {
range: 7..8,
arg: Identifier {
id: "a",
@ -26,9 +26,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 10..11,
def: Arg {
def: Parameter {
range: 10..11,
arg: Identifier {
id: "b",
@ -38,9 +38,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 13..14,
def: Arg {
def: Parameter {
range: 13..14,
arg: Identifier {
id: "c",

View file

@ -10,13 +10,13 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..23,
args: Arguments {
parameters: Parameters {
range: 7..20,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 7..8,
def: Arg {
def: Parameter {
range: 7..8,
arg: Identifier {
id: "a",
@ -26,9 +26,9 @@ Ok(
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 10..14,
def: Arg {
def: Parameter {
range: 10..11,
arg: Identifier {
id: "b",
@ -48,9 +48,9 @@ Ok(
),
),
},
ArgWithDefault {
ParameterWithDefault {
range: 16..20,
def: Arg {
def: Parameter {
range: 16..17,
arg: Identifier {
id: "c",

View file

@ -10,7 +10,7 @@ expression: parse_ast
id: "test",
range: 18..22,
},
args: Arguments {
parameters: Parameters {
range: 22..24,
posonlyargs: [],
args: [],

View file

@ -129,7 +129,7 @@ Module(
id: "foo",
range: 570..573,
},
args: Arguments {
parameters: Parameters {
range: 573..575,
posonlyargs: [],
args: [],

View file

@ -1,6 +1,6 @@
---
source: crates/ruff_python_parser/src/parser.rs
expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
expression: "parse_suite(source, \"<test>\").unwrap()"
---
[
Expr(
@ -709,13 +709,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
value: Lambda(
ExprLambda {
range: 591..619,
args: Arguments {
parameters: Parameters {
range: 598..603,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 598..603,
def: Arg {
def: Parameter {
range: 598..603,
arg: Identifier {
id: "query",

View file

@ -1,6 +1,6 @@
---
source: crates/ruff_python_parser/src/parser.rs
expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
expression: "parse_suite(source, \"<test>\").unwrap()"
---
[
ClassDef(
@ -35,13 +35,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "__init__",
range: 22..30,
},
args: Arguments {
parameters: Parameters {
range: 30..36,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 31..35,
def: Arg {
def: Parameter {
range: 31..35,
arg: Identifier {
id: "self",
@ -75,13 +75,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "method_with_default",
range: 50..69,
},
args: Arguments {
parameters: Parameters {
range: 69..90,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 70..74,
def: Arg {
def: Parameter {
range: 70..74,
arg: Identifier {
id: "self",
@ -91,9 +91,9 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 76..89,
def: Arg {
def: Parameter {
range: 76..79,
arg: Identifier {
id: "arg",

View file

@ -1,6 +1,6 @@
---
source: crates/ruff_python_parser/src/parser.rs
expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
expression: "parse_suite(source, \"<test>\").unwrap()"
---
[
FunctionDef(
@ -10,13 +10,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "func",
range: 4..8,
},
args: Arguments {
parameters: Parameters {
range: 8..11,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 9..10,
def: Arg {
def: Parameter {
range: 9..10,
arg: Identifier {
id: "a",
@ -57,13 +57,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "func",
range: 26..30,
},
args: Arguments {
parameters: Parameters {
range: 33..39,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 34..38,
def: Arg {
def: Parameter {
range: 34..38,
arg: Identifier {
id: "a",
@ -131,13 +131,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "func",
range: 59..63,
},
args: Arguments {
parameters: Parameters {
range: 71..77,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 72..76,
def: Arg {
def: Parameter {
range: 72..76,
arg: Identifier {
id: "a",
@ -213,13 +213,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "func",
range: 97..101,
},
args: Arguments {
parameters: Parameters {
range: 118..124,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 119..123,
def: Arg {
def: Parameter {
range: 119..123,
arg: Identifier {
id: "a",
@ -310,12 +310,12 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "func",
range: 144..148,
},
args: Arguments {
parameters: Parameters {
range: 153..162,
posonlyargs: [],
args: [],
vararg: Some(
Arg {
Parameter {
range: 155..161,
arg: Identifier {
id: "a",
@ -377,12 +377,12 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "func",
range: 177..181,
},
args: Arguments {
parameters: Parameters {
range: 186..221,
posonlyargs: [],
args: [],
vararg: Some(
Arg {
Parameter {
range: 188..200,
arg: Identifier {
id: "args",
@ -411,7 +411,7 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
),
kwonlyargs: [],
kwarg: Some(
Arg {
Parameter {
range: 204..220,
arg: Identifier {
id: "kwargs",
@ -475,7 +475,7 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
id: "func",
range: 236..240,
},
args: Arguments {
parameters: Parameters {
range: 261..263,
posonlyargs: [],
args: [],

View file

@ -9,13 +9,13 @@ expression: parse_ast
value: Lambda(
ExprLambda {
range: 0..18,
args: Arguments {
parameters: Parameters {
range: 7..11,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 7..8,
def: Arg {
def: Parameter {
range: 7..8,
arg: Identifier {
id: "x",
@ -25,9 +25,9 @@ expression: parse_ast
},
default: None,
},
ArgWithDefault {
ParameterWithDefault {
range: 10..11,
def: Arg {
def: Parameter {
range: 10..11,
arg: Identifier {
id: "y",

View file

@ -9,7 +9,7 @@ expression: parse_ast
value: Lambda(
ExprLambda {
range: 0..9,
args: Arguments {
parameters: Parameters {
range: 6..6,
posonlyargs: [],
args: [],

View file

@ -1,6 +1,6 @@
---
source: crates/ruff_python_parser/src/parser.rs
expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
expression: "parse_suite(source, \"<test>\").unwrap()"
---
[
Expr(
@ -645,13 +645,13 @@ expression: "ast::Suite::parse(source, \"<test>\").unwrap()"
value: Lambda(
ExprLambda {
range: 507..535,
args: Arguments {
parameters: Parameters {
range: 514..519,
posonlyargs: [],
args: [
ArgWithDefault {
ParameterWithDefault {
range: 514..519,
def: Arg {
def: Parameter {
range: 514..519,
arg: Identifier {
id: "query",

View file

@ -10,12 +10,12 @@ expression: parse_ast
id: "args_to_tuple",
range: 5..18,
},
args: Arguments {
parameters: Parameters {
range: 18..30,
posonlyargs: [],
args: [],
vararg: Some(
Arg {
Parameter {
range: 20..29,
arg: Identifier {
id: "args",