Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-12-26 04:53:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

Use explicit in/out list types for vectorized commands (#9742)

Browse source 
# Description
All commands that declared `.vectorizes_over_list(true)` now also
explicitly declare the list form of their scalar types.

- Explicit in/out list signatures for nu-command
- Explicit in/out list signatures for nu-cmd-extra
- Add comments about cellpath behavior that is still unresolved


# User-Facing Changes
Our type signatures will now be more explicit about which commands
support vectorization over lists.
On the downside this is a bit more verbose and less systematic.
This commit is contained in:
Stefan Holderbach 2023-07-23 20:46:53 +02:00 committed by GitHub
parent 4dbdb1fe54
commit 17f8ad7210
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
38 changed files with 247 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
crates/nu-cmd-extra/src/extra/bits/not.rs
View file

@ -24,6 +24,7 @@ impl Command for BitsNot {
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.switch(
"signed",
"always treat input number as a signed number",

9
crates/nu-cmd-extra/src/extra/bytes/add.rs
View file

@ -30,8 +30,15 @@ impl Command for BytesAdd {
fn signature(&self) -> Signature {
Signature::build("bytes add")
.input_output_types(vec![(Type::Binary, Type::Binary)])
.input_output_types(vec![
(Type::Binary, Type::Binary),
(
Type::List(Box::new(Type::Binary)),
Type::List(Box::new(Type::Binary)),
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.required("data", SyntaxShape::Binary, "the binary to add")
.named(
"index",

8
crates/nu-cmd-extra/src/extra/bytes/at.rs
View file

@ -37,7 +37,13 @@ impl Command for BytesAt {
fn signature(&self) -> Signature {
Signature::build("bytes at")
.input_output_types(vec![(Type::Binary, Type::Binary)])
.input_output_types(vec![
(Type::Binary, Type::Binary),
(
Type::List(Box::new(Type::Binary)),
Type::List(Box::new(Type::Binary)),
),
])
.vectorizes_over_list(true)
.required("range", SyntaxShape::Range, "the range to get bytes")
.rest(

9
crates/nu-cmd-extra/src/extra/math/arccos.rs
View file

@ -13,7 +13,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math arccos")
.switch("degrees", "Return degrees instead of radians", Some('d'))
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/arccosh.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math arccosh")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/arcsin.rs
View file

@ -13,7 +13,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math arcsin")
.switch("degrees", "Return degrees instead of radians", Some('d'))
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/arcsinh.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math arcsinh")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/arctan.rs
View file

@ -13,7 +13,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math arctan")
.switch("degrees", "Return degrees instead of radians", Some('d'))
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/arctanh.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math arctanh")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/cosh.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math cosh")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/exp.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math exp")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/ln.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math ln")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/sinh.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math sinh")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

9
crates/nu-cmd-extra/src/extra/math/tanh.rs
View file

@ -12,7 +12,14 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("math tanh")
.input_output_types(vec![(Type::Number, Type::Float)])
.input_output_types(vec![
(Type::Number, Type::Float),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Float)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.category(Category::Math)
}

4
crates/nu-cmd-extra/src/extra/platform/ansi/gradient.rs
View file

@ -46,6 +46,10 @@ impl Command for SubCommand {
)
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)

9
crates/nu-cmd-extra/src/extra/strings/encode_decode/decode_hex.rs
View file

@ -15,7 +15,14 @@ impl Command for DecodeHex {
fn signature(&self) -> Signature {
Signature::build("decode hex")
.input_output_types(vec![(Type::String, Type::Binary)])
.input_output_types(vec![
(Type::String, Type::Binary),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::Binary)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.rest(
"rest",

9
crates/nu-cmd-extra/src/extra/strings/encode_decode/encode_hex.rs
View file

@ -15,7 +15,14 @@ impl Command for EncodeHex {
fn signature(&self) -> Signature {
Signature::build("encode hex")
.input_output_types(vec![(Type::Binary, Type::String)])
.input_output_types(vec![
(Type::Binary, Type::String),
(
Type::List(Box::new(Type::Binary)),
Type::List(Box::new(Type::String)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.rest(
"rest",

7
crates/nu-command/src/conversions/fill.rs
View file

@ -47,8 +47,15 @@ impl Command for Fill {
(Type::Float, Type::String),
(Type::String, Type::String),
(Type::Filesize, Type::String),
(Type::List(Box::new(Type::Int)), Type::List(Box::new(Type::String))),
(Type::List(Box::new(Type::Float)), Type::List(Box::new(Type::String))),
(Type::List(Box::new(Type::String)), Type::List(Box::new(Type::String))),
(Type::List(Box::new(Type::Filesize)), Type::List(Box::new(Type::String))),
// General case for heterogeneous lists
(Type::List(Box::new(Type::Any)), Type::List(Box::new(Type::String))),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.named(
"width",
SyntaxShape::Int,

22
crates/nu-command/src/conversions/into/filesize.rs
View file

@ -22,7 +22,29 @@ impl Command for SubCommand {
(Type::String, Type::Filesize),
(Type::Filesize, Type::Filesize),
(Type::Table(vec![]), Type::Table(vec![])),
(
Type::List(Box::new(Type::Int)),
Type::List(Box::new(Type::Filesize)),
),
(
Type::List(Box::new(Type::Number)),
Type::List(Box::new(Type::Filesize)),
),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::Filesize)),
),
(
Type::List(Box::new(Type::Filesize)),
Type::List(Box::new(Type::Filesize)),
),
// Catch all for heterogeneous lists.
(
Type::List(Box::new(Type::Any)),
Type::List(Box::new(Type::Filesize)),
),
])
.allow_variants_without_examples(true)
.vectorizes_over_list(true)
.rest(
"rest",

1
crates/nu-command/src/math/round.rs
View file

@ -23,6 +23,7 @@ impl Command for SubCommand {
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.named(
"precision",
SyntaxShape::Number,

9
crates/nu-command/src/strings/encode_decode/decode_base64.rs
View file

@ -18,8 +18,17 @@ impl Command for DecodeBase64 {
.input_output_types(vec![
(Type::String, Type::String),
(Type::String, Type::Binary),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::Binary)),
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.named(
"character-set",
SyntaxShape::String,

15
crates/nu-command/src/strings/encode_decode/encode_base64.rs
View file

@ -18,8 +18,23 @@ impl Command for EncodeBase64 {
.input_output_types(vec![
(Type::String, Type::String),
(Type::Binary, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(
Type::List(Box::new(Type::Binary)),
Type::List(Box::new(Type::String)),
),
// Relaxed for heterogeneous list.
// Should be removed as soon as the type system supports better restrictions
(
Type::List(Box::new(Type::Any)),
Type::List(Box::new(Type::String)),
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.named(
"character-set",
SyntaxShape::String,

5
crates/nu-command/src/strings/str_/case/camel_case.rs
View file

@ -19,9 +19,14 @@ impl Command for SubCommand {
Signature::build("str camel-case")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

5
crates/nu-command/src/strings/str_/case/capitalize.rs
View file

@ -17,9 +17,14 @@ impl Command for SubCommand {
Signature::build("str capitalize")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

5
crates/nu-command/src/strings/str_/case/downcase.rs
View file

@ -17,9 +17,14 @@ impl Command for SubCommand {
Signature::build("str downcase")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

5
crates/nu-command/src/strings/str_/case/kebab_case.rs
View file

@ -20,8 +20,13 @@ impl Command for SubCommand {
.input_output_types(vec![
(Type::String, Type::String),
(Type::Table(vec![]), Type::Table(vec![])),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

5
crates/nu-command/src/strings/str_/case/pascal_case.rs
View file

@ -20,8 +20,13 @@ impl Command for SubCommand {
.input_output_types(vec![
(Type::String, Type::String),
(Type::Table(vec![]), Type::Table(vec![])),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

5
crates/nu-command/src/strings/str_/case/screaming_snake_case.rs
View file

@ -18,9 +18,14 @@ impl Command for SubCommand {
Signature::build("str screaming-snake-case")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

5
crates/nu-command/src/strings/str_/case/snake_case.rs
View file

@ -18,9 +18,14 @@ impl Command for SubCommand {
Signature::build("str snake-case")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

5
crates/nu-command/src/strings/str_/case/title_case.rs
View file

@ -19,9 +19,14 @@ impl Command for SubCommand {
Signature::build("str title-case")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.rest(
"rest",
SyntaxShape::CellPath,

4
crates/nu-command/src/strings/str_/case/upcase.rs
View file

@ -16,6 +16,10 @@ impl Command for SubCommand {
Signature::build("str upcase")
.input_output_types(vec![
(Type::String, Type::String),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::String)),
),
(Type::Table(vec![]), Type::Table(vec![])),
])
.vectorizes_over_list(true)

1
crates/nu-command/src/strings/str_/contains.rs
View file

@ -31,6 +31,7 @@ impl Command for SubCommand {
Signature::build("str contains")
.input_output_types(vec![
(Type::String, Type::Bool),
// TODO figure out cell-path type behavior
(Type::Table(vec![]), Type::Table(vec![])),
(Type::List(Box::new(Type::String)), Type::List(Box::new(Type::Bool)))
])

14
crates/nu-command/src/strings/str_/ends_with.rs
View file

@ -28,7 +28,10 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("str ends-with")
.input_output_types(vec![(Type::String, Type::Bool)])
.input_output_types(vec![
(Type::String, Type::Bool),
(Type::List(Box::new(Type::String)), Type::List(Box::new(Type::Bool))),
])
.vectorizes_over_list(true)
.required("string", SyntaxShape::String, "the string to match")
.rest(
@ -73,9 +76,12 @@ impl Command for SubCommand {
result: Some(Value::test_bool(true)),
},
Example {
description: "Checks if string ends with '.txt'",
example: "'my_library.rb' | str ends-with '.txt'",
result: Some(Value::test_bool(false)),
description: "Checks if strings end with '.txt'",
example: "['my_library.rb', 'README.txt'] | str ends-with '.txt'",
result: Some(Value::test_list(vec![
Value::test_bool(false),
Value::test_bool(true),
])),
},
Example {
description: "Checks if string ends with '.RB', case-insensitive",

9
crates/nu-command/src/strings/str_/expand.rs
View file

@ -22,8 +22,15 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("str expand")
.input_output_types(vec![(Type::String, Type::List(Box::new(Type::String)))])
.input_output_types(vec![
(Type::String, Type::List(Box::new(Type::String))),
(
Type::List(Box::new(Type::String)),
Type::List(Box::new(Type::List(Box::new(Type::String)))),
),
])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.category(Category::Strings)
}

3
crates/nu-command/src/strings/str_/index_of.rs
View file

@ -37,8 +37,9 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("str index-of")
.input_output_types(vec![(Type::String, Type::Int)])
.input_output_types(vec![(Type::String, Type::Int),(Type::List(Box::new(Type::String)), Type::List(Box::new(Type::Int)))])
.vectorizes_over_list(true) // TODO: no test coverage
.allow_variants_without_examples(true)
.required("string", SyntaxShape::String, "the string to find in the input")
.switch(
"grapheme-clusters",

1
crates/nu-command/src/strings/str_/replace.rs
View file

@ -36,6 +36,7 @@ impl Command for SubCommand {
Signature::build("str replace")
.input_output_types(vec![
(Type::String, Type::String),
// TODO: clarify behavior with cellpath-rest argument
(Type::Table(vec![]), Type::Table(vec![])),
(
Type::List(Box::new(Type::String)),

3
crates/nu-command/src/strings/str_/starts_with.rs
View file

@ -30,8 +30,9 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("str starts-with")
.input_output_types(vec![(Type::String, Type::Bool)])
.input_output_types(vec![(Type::String, Type::Bool),(Type::List(Box::new(Type::String)), Type::List(Box::new(Type::Bool)))])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.required("string", SyntaxShape::String, "the string to match")
.rest(
"rest",

2
crates/nu-command/src/strings/str_/substring.rs
View file

@ -42,7 +42,7 @@ impl Command for SubCommand {
fn signature(&self) -> Signature {
Signature::build("str substring")
.input_output_types(vec![(Type::String, Type::String), (Type::Table(vec![]), Type::Table(vec![]))])
.input_output_types(vec![(Type::String, Type::String), (Type::List(Box::new(Type::String)), Type::List(Box::new(Type::String))), (Type::Table(vec![]), Type::Table(vec![]))])
.vectorizes_over_list(true)
.allow_variants_without_examples(true)
.switch(