mirror of
https://github.com/nushell/nushell.git
synced 2025-04-15 16:58:19 +02:00
d93315d8f5
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> This PR fixes an overlook from a previous PR. It now correctly returns the details on lazy records. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> Describe detailed now returns the expected result.
436 lines
17 KiB
Rust
436 lines
17 KiB
Rust
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack, StateWorkingSet},
|
|
record, Category, Example, IntoPipelineData, PipelineData, PipelineMetadata, Record,
|
|
ShellError, Signature, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct Describe;
|
|
|
|
impl Command for Describe {
|
|
fn name(&self) -> &str {
|
|
"describe"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Describe the type and structure of the value(s) piped in."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("describe")
|
|
.input_output_types(vec![
|
|
(Type::Any, Type::String),
|
|
(Type::Any, Type::Record(vec![])),
|
|
])
|
|
.switch(
|
|
"no-collect",
|
|
"do not collect streams of structured data",
|
|
Some('n'),
|
|
)
|
|
.switch(
|
|
"detailed",
|
|
"show detailed information about the value",
|
|
Some('d'),
|
|
)
|
|
.switch("collect-lazyrecords", "collect lazy records", Some('l'))
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn is_const(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
run(Some(engine_state), call, input)
|
|
}
|
|
|
|
fn run_const(
|
|
&self,
|
|
_working_set: &StateWorkingSet,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
run(None, call, input)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Describe the type of a string",
|
|
example: "'hello' | describe",
|
|
result: Some(Value::test_string("string")),
|
|
},
|
|
Example {
|
|
description: "Describe the type of a record in a detailed way",
|
|
example:
|
|
"{shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| print $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d",
|
|
result: Some(Value::test_record(record!(
|
|
"type" => Value::test_string("record"),
|
|
"lazy" => Value::test_bool(false),
|
|
"columns" => Value::test_record(record!(
|
|
"shell" => Value::test_string("string"),
|
|
"uwu" => Value::test_string("bool"),
|
|
"features" => Value::test_record(record!(
|
|
"type" => Value::test_string("record"),
|
|
"lazy" => Value::test_bool(false),
|
|
"columns" => Value::test_record(record!(
|
|
"bugs" => Value::test_string("bool"),
|
|
"multiplatform" => Value::test_string("bool"),
|
|
"speed" => Value::test_string("int"),
|
|
)),
|
|
)),
|
|
"fib" => Value::test_record(record!(
|
|
"type" => Value::test_string("list"),
|
|
"length" => Value::test_int(6),
|
|
"values" => Value::test_list(vec![
|
|
Value::test_string("int"),
|
|
Value::test_string("int"),
|
|
Value::test_string("int"),
|
|
Value::test_string("int"),
|
|
Value::test_string("int"),
|
|
Value::test_string("int"),
|
|
]),
|
|
)),
|
|
"on_save" => Value::test_record(record!(
|
|
"type" => Value::test_string("closure"),
|
|
"signature" => Value::test_record(record!(
|
|
"name" => Value::test_string(""),
|
|
"category" => Value::test_string("default"),
|
|
)),
|
|
)),
|
|
"first_commit" => Value::test_string("date"),
|
|
"my_duration" => Value::test_string("duration"),
|
|
)),
|
|
))),
|
|
},
|
|
Example {
|
|
description: "Describe the type of a stream with detailed information",
|
|
example: "[1 2 3] | each {|i| echo $i} | describe -d",
|
|
result: None // Give "Running external commands not supported" error
|
|
// result: Some(Value::test_record(record!(
|
|
// "type" => Value::test_string("stream"),
|
|
// "origin" => Value::test_string("nushell"),
|
|
// "subtype" => Value::test_record(record!(
|
|
// "type" => Value::test_string("list"),
|
|
// "length" => Value::test_int(3),
|
|
// "values" => Value::test_list(vec![
|
|
// Value::test_string("int"),
|
|
// Value::test_string("int"),
|
|
// Value::test_string("int"),
|
|
// ])
|
|
// ))
|
|
// ))),
|
|
},
|
|
Example {
|
|
description: "Describe a stream of data, collecting it first",
|
|
example: "[1 2 3] | each {|i| echo $i} | describe",
|
|
result: None // Give "Running external commands not supported" error
|
|
// result: Some(Value::test_string("list<int> (stream)")),
|
|
},
|
|
Example {
|
|
description: "Describe the input but do not collect streams",
|
|
example: "[1 2 3] | each {|i| echo $i} | describe --no-collect",
|
|
result: None // Give "Running external commands not supported" error
|
|
// result: Some(Value::test_string("stream")),
|
|
},
|
|
]
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["type", "typeof", "info", "structure"]
|
|
}
|
|
}
|
|
|
|
fn run(
|
|
engine_state: Option<&EngineState>,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let metadata = input.metadata().clone().map(Box::new);
|
|
let head = call.head;
|
|
let no_collect: bool = call.has_flag("no-collect");
|
|
let detailed = call.has_flag("detailed");
|
|
|
|
let description: Value = match input {
|
|
PipelineData::ExternalStream {
|
|
ref stdout,
|
|
ref stderr,
|
|
ref exit_code,
|
|
..
|
|
} => {
|
|
if detailed {
|
|
Value::record(
|
|
record!(
|
|
"type" => Value::string("stream", head),
|
|
"origin" => Value::string("external", head),
|
|
"stdout" => match stdout {
|
|
Some(_) => Value::record(
|
|
record!(
|
|
"type" => Value::string("stream", head),
|
|
"origin" => Value::string("external", head),
|
|
"subtype" => Value::string("any", head),
|
|
),
|
|
head,
|
|
),
|
|
None => Value::nothing(head),
|
|
},
|
|
"stderr" => match stderr {
|
|
Some(_) => Value::record(
|
|
record!(
|
|
"type" => Value::string("stream", head),
|
|
"origin" => Value::string("external", head),
|
|
"subtype" => Value::string("any", head),
|
|
),
|
|
head,
|
|
),
|
|
None => Value::nothing(head),
|
|
},
|
|
"exit_code" => match exit_code {
|
|
Some(_) => Value::record(
|
|
record!(
|
|
"type" => Value::string("stream", head),
|
|
"origin" => Value::string("external", head),
|
|
"subtype" => Value::string("int", head),
|
|
),
|
|
head,
|
|
),
|
|
None => Value::nothing(head),
|
|
},
|
|
"metadata" => metadata_to_value(metadata, head),
|
|
),
|
|
head,
|
|
)
|
|
} else {
|
|
Value::string("raw input", head)
|
|
}
|
|
}
|
|
PipelineData::ListStream(_, _) => {
|
|
if detailed {
|
|
Value::record(
|
|
record!(
|
|
"type" => Value::string("stream", head),
|
|
"origin" => Value::string("nushell", head),
|
|
"subtype" => {
|
|
if no_collect {
|
|
Value::string("any", head)
|
|
} else {
|
|
describe_value(input.into_value(head), head, engine_state, call)?
|
|
}
|
|
},
|
|
"metadata" => metadata_to_value(metadata, head),
|
|
),
|
|
head,
|
|
)
|
|
} else if no_collect {
|
|
Value::string("stream", head)
|
|
} else {
|
|
let value = input.into_value(head);
|
|
let base_description = match value {
|
|
Value::CustomValue { val, .. } => val.value_string(),
|
|
_ => value.get_type().to_string(),
|
|
};
|
|
|
|
Value::string(format!("{} (stream)", base_description), head)
|
|
}
|
|
}
|
|
_ => {
|
|
let value = input.into_value(head);
|
|
if !detailed {
|
|
match value {
|
|
Value::CustomValue { val, .. } => Value::string(val.value_string(), head),
|
|
_ => Value::string(value.get_type().to_string(), head),
|
|
}
|
|
} else {
|
|
describe_value(value, head, engine_state, call)?
|
|
}
|
|
}
|
|
};
|
|
|
|
Ok(description.into_pipeline_data())
|
|
}
|
|
|
|
fn describe_value(
|
|
value: Value,
|
|
head: nu_protocol::Span,
|
|
engine_state: Option<&EngineState>,
|
|
call: &Call,
|
|
) -> Result<Value, ShellError> {
|
|
Ok(match value {
|
|
Value::CustomValue { val, internal_span } => Value::record(
|
|
record!(
|
|
"type" => Value::string("custom", head),
|
|
"subtype" => run(engine_state,call, val.to_base_value(internal_span)?.into_pipeline_data())?.into_value(head),
|
|
),
|
|
head,
|
|
),
|
|
Value::Bool { .. }
|
|
| Value::Int { .. }
|
|
| Value::Float { .. }
|
|
| Value::Filesize { .. }
|
|
| Value::Duration { .. }
|
|
| Value::Date { .. }
|
|
| Value::Range { .. }
|
|
| Value::String { .. }
|
|
| Value::MatchPattern { .. }
|
|
| Value::Nothing { .. } => Value::record(
|
|
record!(
|
|
"type" => Value::string(value.get_type().to_string(), head),
|
|
),
|
|
head,
|
|
),
|
|
Value::Record { val, .. } => {
|
|
let mut record = Record::new();
|
|
for i in 0..val.len() {
|
|
let k = val.cols[i].clone();
|
|
let v = val.vals[i].clone();
|
|
|
|
record.push(k, {
|
|
if let Value::Record { val, .. } =
|
|
describe_value(v.clone(), head, engine_state, call)?
|
|
{
|
|
if let [Value::String { val: k, .. }] = val.vals.as_slice() {
|
|
Value::string(k, head)
|
|
} else {
|
|
Value::record(val, head)
|
|
}
|
|
} else {
|
|
describe_value(v, head, engine_state, call)?
|
|
}
|
|
});
|
|
}
|
|
|
|
Value::record(
|
|
record!(
|
|
"type" => Value::string("record", head),
|
|
"lazy" => Value::bool(false, head),
|
|
"columns" => Value::record(record, head),
|
|
),
|
|
head,
|
|
)
|
|
}
|
|
Value::List { vals, .. } => Value::record(
|
|
record!(
|
|
"type" => Value::string("list", head),
|
|
"length" => Value::int(vals.len() as i64, head),
|
|
"values" => Value::list(vals.iter().map(|v|
|
|
match describe_value(v.clone(), head, engine_state, call) {
|
|
Ok(Value::Record {val, ..}) => if val.cols.as_slice() == ["type"] {Ok(val.vals[0].clone())} else {Ok(Value::record(val, head))},
|
|
x => x
|
|
}
|
|
).collect::<Result<Vec<_>, _>>()?, head),
|
|
),
|
|
head,
|
|
),
|
|
Value::Block { val, .. } | Value::Closure { val, .. } => {
|
|
let block = engine_state.map(|engine_state| engine_state.get_block(val));
|
|
|
|
if let Some(block) = block {
|
|
let mut record = Record::new();
|
|
record.push("type", Value::string(value.get_type().to_string(), head));
|
|
record.push(
|
|
"signature",
|
|
Value::record(
|
|
record!(
|
|
"name" => Value::string(block.signature.name.clone(), head),
|
|
"category" => Value::string(block.signature.category.to_string(), head),
|
|
),
|
|
head,
|
|
),
|
|
);
|
|
Value::record(record, head)
|
|
} else {
|
|
Value::record(
|
|
record!(
|
|
"type" => Value::string("closure", head),
|
|
),
|
|
head,
|
|
)
|
|
}
|
|
}
|
|
|
|
Value::Error { error, .. } => Value::record(
|
|
record!(
|
|
"type" => Value::string("error", head),
|
|
"subtype" => Value::string(error.to_string(), head),
|
|
),
|
|
head,
|
|
),
|
|
Value::Binary { val, .. } => Value::record(
|
|
record!(
|
|
"type" => Value::string("binary", head),
|
|
"length" => Value::int(val.len() as i64, head),
|
|
),
|
|
head,
|
|
),
|
|
Value::CellPath { val, .. } => Value::record(
|
|
record!(
|
|
"type" => Value::string("cellpath", head),
|
|
"length" => Value::int(val.members.len() as i64, head),
|
|
),
|
|
head,
|
|
),
|
|
Value::LazyRecord { val, .. } => {
|
|
let collect_lazyrecords: bool = call.has_flag("collect-lazyrecords");
|
|
let mut record = Record::new();
|
|
|
|
record.push("type", Value::string("record", head));
|
|
record.push("lazy", Value::bool(true, head));
|
|
|
|
if collect_lazyrecords {
|
|
let collected = val.collect()?;
|
|
if let Value::Record { val, .. } =
|
|
describe_value(collected, head, engine_state, call)?
|
|
{
|
|
let mut record_cols = Record::new();
|
|
record.push("length", Value::int(val.len() as i64, head));
|
|
|
|
for i in 0..val.len() {
|
|
record_cols.push(
|
|
val.cols[i].clone(),
|
|
describe_value(val.vals[i].clone(), head, engine_state, call)?,
|
|
);
|
|
}
|
|
record.push("columns", Value::record(record_cols, head));
|
|
} else {
|
|
let cols = val.column_names();
|
|
record.push("length", Value::int(cols.len() as i64, head));
|
|
}
|
|
} else {
|
|
let cols = val.column_names();
|
|
record.push("length", Value::int(cols.len() as i64, head));
|
|
}
|
|
|
|
Value::record(record, head)
|
|
}
|
|
})
|
|
}
|
|
|
|
fn metadata_to_value(metadata: Option<Box<PipelineMetadata>>, head: nu_protocol::Span) -> Value {
|
|
match metadata {
|
|
Some(metadata) => Value::record(
|
|
record!(
|
|
"data_source" => Value::string(format!("{:?}", metadata.data_source), head),
|
|
),
|
|
head,
|
|
),
|
|
_ => Value::nothing(head),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
#[test]
|
|
fn test_examples() {
|
|
use super::Describe;
|
|
use crate::test_examples;
|
|
test_examples(Describe {})
|
|
}
|
|
}
|