Make stream info visible to users in describe (#7589)

Closes #7581.

After this PR, `describe` shows `(stream)` next to input that arrived at
`describe` as a `ListStream`:
```bash
〉ls | describe
table<name: string, type: string, size: filesize, modified: date> (stream)
〉[1 2 3] | each {|i| $i} | describe
list<int> (stream)
```

`describe` must collect all items of the stream to display type
information for lists and tables. If users need to avoid collecting
input, they can use the `-n`/`--no-collect` flag:

```bash
〉[1 2 3] | each {|i| $i} | describe --no-collect
stream
```
This commit is contained in:
Reilly Wood 2023-01-03 21:08:05 -08:00 committed by GitHub
parent bdd52f0111
commit 95d4922e44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 58 additions and 26 deletions

View File

@ -19,6 +19,11 @@ impl Command for Describe {
fn signature(&self) -> Signature { fn signature(&self) -> Signature {
Signature::build("describe") Signature::build("describe")
.input_output_types(vec![(Type::Any, Type::String)]) .input_output_types(vec![(Type::Any, Type::String)])
.switch(
"no-collect",
"do not collect streams of structured data",
Some('n'),
)
.category(Category::Core) .category(Category::Core)
} }
@ -30,32 +35,58 @@ impl Command for Describe {
input: PipelineData, input: PipelineData,
) -> Result<PipelineData, ShellError> { ) -> Result<PipelineData, ShellError> {
let head = call.head; let head = call.head;
if matches!(input, PipelineData::ExternalStream { .. }) {
Ok(PipelineData::Value( let no_collect: bool = call.has_flag("no-collect");
Value::string("raw input", call.head),
None, let description = match input {
)) PipelineData::ExternalStream { .. } => "raw input".into(),
PipelineData::ListStream(_, _) => {
if no_collect {
"stream".into()
} else { } else {
let value = input.into_value(call.head); let value = input.into_value(head);
let description = match value { let base_description = match value {
Value::CustomValue { val, .. } => val.value_string(), Value::CustomValue { val, .. } => val.value_string(),
_ => value.get_type().to_string(), _ => value.get_type().to_string(),
}; };
format!("{base_description} (stream)")
}
}
_ => {
let value = input.into_value(head);
match value {
Value::CustomValue { val, .. } => val.value_string(),
_ => value.get_type().to_string(),
}
}
};
Ok(Value::String { Ok(Value::String {
val: description, val: description,
span: head, span: head,
} }
.into_pipeline_data()) .into_pipeline_data())
} }
}
fn examples(&self) -> Vec<Example> { fn examples(&self) -> Vec<Example> {
vec![Example { vec![
Example {
description: "Describe the type of a string", description: "Describe the type of a string",
example: "'hello' | describe", example: "'hello' | describe",
result: Some(Value::test_string("string")), result: Some(Value::test_string("string")),
}] },
Example {
description: "Describe a stream of data, collecting it first",
example: "[1 2 3] | each {|i| $i} | describe",
result: Some(Value::test_string("list<int> (stream)")),
},
Example {
description: "Describe the input but do not collect streams",
example: "[1 2 3] | each {|i| $i} | describe --no-collect",
result: Some(Value::test_string("stream")),
},
]
} }
fn search_terms(&self) -> Vec<&str> { fn search_terms(&self) -> Vec<&str> {

View File

@ -13,7 +13,7 @@ mod test_examples {
MathRound, Path, Random, Split, SplitColumn, SplitRow, Str, StrJoin, StrLength, StrReplace, MathRound, Path, Random, Split, SplitColumn, SplitRow, Str, StrJoin, StrLength, StrReplace,
Url, Values, Wrap, Url, Values, Wrap,
}; };
use crate::{Break, Mut, To}; use crate::{Break, Each, Mut, To};
use itertools::Itertools; use itertools::Itertools;
use nu_protocol::{ use nu_protocol::{
ast::Block, ast::Block,
@ -61,6 +61,7 @@ mod test_examples {
// Base functions that are needed for testing // Base functions that are needed for testing
// Try to keep this working set small to keep tests running as fast as possible // Try to keep this working set small to keep tests running as fast as possible
let mut working_set = StateWorkingSet::new(&engine_state); let mut working_set = StateWorkingSet::new(&engine_state);
working_set.add_decl(Box::new(Each));
working_set.add_decl(Box::new(Let)); working_set.add_decl(Box::new(Let));
working_set.add_decl(Box::new(Str)); working_set.add_decl(Box::new(Str));
working_set.add_decl(Box::new(StrJoin)); working_set.add_decl(Box::new(StrJoin));

View File

@ -375,7 +375,7 @@ mod test {
r#"[7,8,9,10] | par-each {|el ind| $ind } | describe"# r#"[7,8,9,10] | par-each {|el ind| $ind } | describe"#
)); ));
assert_eq!(actual.out, "list<int>"); assert_eq!(actual.out, "list<int> (stream)");
} }
#[test] #[test]

View File

@ -77,7 +77,7 @@ fn gets_first_row_as_list_when_amount_given() {
"# "#
)); ));
assert_eq!(actual.out, "list<int>"); assert_eq!(actual.out, "list<int> (stream)");
} }
#[test] #[test]

View File

@ -76,7 +76,7 @@ fn gets_last_row_as_list_when_amount_given() {
"# "#
)); ));
assert_eq!(actual.out, "list<int>"); assert_eq!(actual.out, "list<int> (stream)");
} }
#[test] #[test]

View File

@ -9,7 +9,7 @@ fn float_in_seq_leads_to_lists_of_floats() {
"# "#
)); ));
assert_eq!(actual.out, "list<float>"); assert_eq!(actual.out, "list<float> (stream)");
} }
#[test] #[test]
@ -21,5 +21,5 @@ fn ints_in_seq_leads_to_lists_of_ints() {
"# "#
)); ));
assert_eq!(actual.out, "list<int>"); assert_eq!(actual.out, "list<int> (stream)");
} }