mirror of
https://github.com/nushell/nushell
synced 2024-12-29 06:23:11 +00:00
53beba7acc
# Description Currently, all four of these commands return a (rather-confusing) spanless error when passed an empty list: ``` > [] | sort Error: × no values to work with help: no values to work with ``` This PR changes these commands to always output `[]` if the input is `[]`. ``` > [] | sort ╭────────────╮ │ empty list │ ╰────────────╯ > [] | uniq-by foo ╭────────────╮ │ empty list │ ╰────────────╯ ``` I'm not sure what the original logic was here, but in the case of `sort` and `uniq`, I think the current behavior is straightforwardly wrong. `sort-by` and `uniq-by` are a bit more complicated, since they currently try to perform some validation that the specified column name is present in the input (see #8667 for problems with this validation, where a possible outcome is removing the validation entirely). When passed `[]`, it's not possible to do any validation because there are no records. This opens up the possibility for situations like the following: ``` > [[foo]; [5] [6]] | where foo < 3 | sort-by bar ╭────────────╮ │ empty list │ ╰────────────╯ ``` I think there's a strong argument that `[]` is the best output for these commands as well, since it makes pipelines like `$table | filter $condition | sort-by $column` more predictable. Currently, this pipeline will throw an error if `filter` evaluates to `[]`, but work fine otherwise. This makes it difficult to write reliable code, especially since users are not likely to encounter the `filter -> []` case in testing (issue #5957). The only workaround is to insert manual checks for an empty result. IMO, this is significantly worse than the "you can typo a column name without getting an error" problem shown above. Other commands that take column arguments (`get`, `select`, `rename`, etc) already have `[] -> []`, so there's existing precedent for this behavior. The core question here is "what columns does `[]` have"? The current behavior of `sort-by` is "no columns", while the current behavior of `select` is "all possible columns". Both answers lead to accepting some likely-buggy code without throwing on error, but in order to do better here we would need something like `Value::Table` that tracks columns on empty tables. If other people disagree with this logic, I'm happy to split out the `sort-by` and `uniq-by` changes into another PR. # User-Facing Changes `sort`, `uniq`, `sort-by`, and `uniq-by` now return `[]` instead of throwing an error when input is `[]`. # After Submitting > If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. The existing behavior was not documented, and the new behavior is what you would expect by default, so I don't think we need to update documentation. --------- Co-authored-by: Reilly Wood <reilly.wood@icloud.com>
127 lines
2.7 KiB
Rust
127 lines
2.7 KiB
Rust
use nu_test_support::{nu, pipeline};
|
|
|
|
#[test]
|
|
fn by_invalid_types() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats", pipeline(
|
|
r#"
|
|
open cargo_sample.toml --raw
|
|
| echo ["foo" 1]
|
|
| sort
|
|
| to json -r
|
|
"#
|
|
));
|
|
|
|
let json_output = r#"[1,"foo"]"#;
|
|
assert_eq!(actual.out, json_output);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_primitive_values() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats", pipeline(
|
|
r#"
|
|
open cargo_sample.toml --raw
|
|
| lines
|
|
| skip 1
|
|
| first 6
|
|
| sort
|
|
| first
|
|
"#
|
|
));
|
|
|
|
assert_eq!(actual.out, "authors = [\"The Nushell Project Developers\"]");
|
|
}
|
|
|
|
#[test]
|
|
fn sort_different_types() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats", pipeline(
|
|
r#"
|
|
[a, 1, b, 2, c, 3, [4, 5, 6], d, 4, [1, 2, 3]] | sort | to json --raw
|
|
"#
|
|
));
|
|
|
|
let json_output = r#"[1,2,3,4,"a","b","c","d",[1,2,3],[4,5,6]]"#;
|
|
assert_eq!(actual.out, json_output);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_natural() {
|
|
let actual = nu!(
|
|
cwd: ".", pipeline(
|
|
r#"['1' '2' '3' '4' '5' '10' '100'] | sort -n | to nuon"#
|
|
));
|
|
|
|
assert_eq!(actual.out, r#"["1", "2", "3", "4", "5", "10", "100"]"#);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_record_natural() {
|
|
let actual = nu!(
|
|
cwd: ".", pipeline(
|
|
r#"{10:0,99:0,1:0,9:0,100:0} | sort -n | to nuon"#
|
|
));
|
|
|
|
assert_eq!(
|
|
actual.out,
|
|
r#"{"1": 0, "9": 0, "10": 0, "99": 0, "100": 0}"#
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_record_insensitive() {
|
|
let actual = nu!(
|
|
cwd: ".", pipeline(
|
|
r#"{abe:1,zed:2,ABE:3} | sort -i | to nuon"#
|
|
));
|
|
|
|
assert_eq!(actual.out, r#"{abe: 1, ABE: 3, zed: 2}"#);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_record_insensitive_reverse() {
|
|
let actual = nu!(
|
|
cwd: ".", pipeline(
|
|
r#"{abe:1,zed:2,ABE:3} | sort -ir | to nuon"#
|
|
));
|
|
|
|
assert_eq!(actual.out, r#"{zed: 2, ABE: 3, abe: 1}"#);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_record_values_natural() {
|
|
let actual = nu!(
|
|
cwd: ".", pipeline(
|
|
r#"{1:"1",2:"2",4:"100",3:"10"} | sort -vn | to nuon"#
|
|
));
|
|
|
|
assert_eq!(actual.out, r#"{"1": "1", "2": "2", "3": "10", "4": "100"}"#);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_record_values_insensitive() {
|
|
let actual = nu!(
|
|
cwd: ".", pipeline(
|
|
r#"{1:abe,2:zed,3:ABE} | sort -vi | to nuon"#
|
|
));
|
|
|
|
assert_eq!(actual.out, r#"{"1": abe, "3": ABE, "2": zed}"#);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_record_values_insensitive_reverse() {
|
|
let actual = nu!(
|
|
cwd: ".", pipeline(
|
|
r#"{1:abe,2:zed,3:ABE} | sort -vir | to nuon"#
|
|
));
|
|
|
|
assert_eq!(actual.out, r#"{"2": zed, "3": ABE, "1": abe}"#);
|
|
}
|
|
|
|
#[test]
|
|
fn sort_empty() {
|
|
let actual = nu!("[] | sort | to nuon");
|
|
|
|
assert_eq!(actual.out, "[]");
|
|
}
|