extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-04-29 23:54:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

add more details to decribe -d (#15591)

Browse Source 
# Description

I was playing around with the `debug` command and wanted to add this
information to it but since most of it already existed in `describe` I
wanted to try and add it here. It adds a few more details that are
hopefully helpful. It mainly tries to add the value type, rust datatype,
and value. I'm not sure all of this is wanted or needed but I thought it
was an interesting introspection idea.

### Before

![image](https://github.com/user-attachments/assets/f1cfc5dd-6c02-4aa1-acb2-8e9931f66dd8)


### After

![image](https://github.com/user-attachments/assets/cfb3c8bd-70dd-4aa1-b03a-375acf6c0e09)


# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# 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.
-->
This commit is contained in:
Darren Schroeder 2025-04-24 08:25:36 -05:00 committed by GitHub
parent 6be291b00a
commit 82eb1c5584
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 207 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

254
crates/nu-cmd-lang/src/core_commands/describe.rs
View File

@ -1,6 +1,9 @@
use nu_engine::command_prelude::*; use nu_engine::command_prelude::*;
use nu_protocol::{engine::StateWorkingSet, ByteStreamSource, PipelineMetadata}; use nu_protocol::{
engine::{Closure, StateWorkingSet},
BlockId, ByteStreamSource, Category, PipelineMetadata, Signature,
};
use std::any::type_name;
#[derive(Clone)] #[derive(Clone)]
pub struct Describe; pub struct Describe;
@ -73,39 +76,116 @@ impl Command for Describe {
"{shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d", "{shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d",
result: Some(Value::test_record(record!( result: Some(Value::test_record(record!(
"type" => Value::test_string("record"), "type" => Value::test_string("record"),
"detailed_type" => Value::test_string("record<shell: string, uwu: bool, features: record<bugs: bool, multiplatform: bool, speed: int>, fib: list<int>, on_save: closure, first_commit: datetime, my_duration: duration>"),
"columns" => Value::test_record(record!( "columns" => Value::test_record(record!(
"shell" => Value::test_string("string"), "shell" => Value::test_record(record!(
"uwu" => Value::test_string("bool"), "type" => Value::test_string("string"),
"detailed_type" => Value::test_string("string"),
"rust_type" => Value::test_string("&alloc::string::String"),
"value" => Value::test_string("true"),
)),
"uwu" => Value::test_record(record!(
"type" => Value::test_string("bool"),
"detailed_type" => Value::test_string("bool"),
"rust_type" => Value::test_string("bool"),
"value" => Value::test_bool(true),
)),
"features" => Value::test_record(record!( "features" => Value::test_record(record!(
"type" => Value::test_string("record"), "type" => Value::test_string("record"),
"detailed_type" => Value::test_string("record<bugs: bool, multiplatform: bool, speed: int>"),
"columns" => Value::test_record(record!( "columns" => Value::test_record(record!(
"bugs" => Value::test_string("bool"), "bugs" => Value::test_record(record!(
"multiplatform" => Value::test_string("bool"), "type" => Value::test_string("bool"),
"speed" => Value::test_string("int"), "detailed_type" => Value::test_string("bool"),
"rust_type" => Value::test_string("bool"),
"value" => Value::test_bool(false),
)),
"multiplatform" => Value::test_record(record!(
"type" => Value::test_string("bool"),
"detailed_type" => Value::test_string("bool"),
"rust_type" => Value::test_string("bool"),
"value" => Value::test_bool(true),
)),
"speed" => Value::test_record(record!(
"type" => Value::test_string("int"),
"detailed_type" => Value::test_string("int"),
"rust_type" => Value::test_string("i64"),
"value" => Value::test_int(10),
)),
)), )),
"rust_type" => Value::test_string("&nu_utils::shared_cow::SharedCow<nu_protocol::value::record::Record>"),
)), )),
"fib" => Value::test_record(record!( "fib" => Value::test_record(record!(
"type" => Value::test_string("list"), "type" => Value::test_string("list"),
"detailed_type" => Value::test_string("list<int>"),
"length" => Value::test_int(6), "length" => Value::test_int(6),
"values" => Value::test_list(vec![ "rust_type" => Value::test_string("&mut alloc::vec::Vec<nu_protocol::value::Value>"),
Value::test_string("int"), "value" => Value::test_list(vec![
Value::test_string("int"), Value::test_record(record!(
Value::test_string("int"), "type" => Value::test_string("int"),
Value::test_string("int"), "detailed_type" => Value::test_string("int"),
Value::test_string("int"), "rust_type" => Value::test_string("i64"),
Value::test_string("int"), "value" => Value::test_int(1),
]), )),
Value::test_record(record!(
"type" => Value::test_string("int"),
"detailed_type" => Value::test_string("int"),
"rust_type" => Value::test_string("i64"),
"value" => Value::test_int(1),
)),
Value::test_record(record!(
"type" => Value::test_string("int"),
"detailed_type" => Value::test_string("int"),
"rust_type" => Value::test_string("i64"),
"value" => Value::test_int(2),
)),
Value::test_record(record!(
"type" => Value::test_string("int"),
"detailed_type" => Value::test_string("int"),
"rust_type" => Value::test_string("i64"),
"value" => Value::test_int(3),
)),
Value::test_record(record!(
"type" => Value::test_string("int"),
"detailed_type" => Value::test_string("int"),
"rust_type" => Value::test_string("i64"),
"value" => Value::test_int(5),
)),
Value::test_record(record!(
"type" => Value::test_string("int"),
"detailed_type" => Value::test_string("int"),
"rust_type" => Value::test_string("i64"),
"value" => Value::test_int(8),
))]
),
)), )),
"on_save" => Value::test_record(record!( "on_save" => Value::test_record(record!(
"type" => Value::test_string("closure"), "type" => Value::test_string("closure"),
"detailed_type" => Value::test_string("closure"),
"rust_type" => Value::test_string("&alloc::boxed::Box<nu_protocol::engine::closure::Closure>"),
"value" => Value::test_closure(Closure {
block_id: BlockId::new(1),
captures: vec![],
}),
"signature" => Value::test_record(record!( "signature" => Value::test_record(record!(
"name" => Value::test_string(""), "name" => Value::test_string(""),
"category" => Value::test_string("default"), "category" => Value::test_string("default"),
)), )),
)), )),
"first_commit" => Value::test_string("datetime"), "first_commit" => Value::test_record(record!(
"my_duration" => Value::test_string("duration"), "type" => Value::test_string("datetime"),
"detailed_type" => Value::test_string("datetime"),
"rust_type" => Value::test_string("chrono::datetime::DateTime<chrono::offset::fixed::FixedOffset>"),
"value" => Value::test_date("2019-05-10 00:00:00Z".parse().unwrap_or_default()),
)),
"my_duration" => Value::test_record(record!(
"type" => Value::test_string("duration"),
"detailed_type" => Value::test_string("duration"),
"rust_type" => Value::test_string("i64"),
"value" => Value::test_duration(260_000_000_000),
))
)), )),
"rust_type" => Value::test_string("&nu_utils::shared_cow::SharedCow<nu_protocol::value::record::Record>"),
))), ))),
}, },
Example { Example {
@ -175,7 +255,9 @@ fn run(
Value::record( Value::record(
record! { record! {
"type" => Value::string(type_, head), "type" => Value::string("bytestream", head),
"detailed_type" => Value::string(type_, head),
"rust_type" => Value::string(type_of(&stream), head),
"origin" => Value::string(origin, head), "origin" => Value::string(origin, head),
"metadata" => metadata_to_value(metadata, head), "metadata" => metadata_to_value(metadata, head),
}, },
@ -192,6 +274,7 @@ fn run(
description description
} }
PipelineData::ListStream(stream, ..) => { PipelineData::ListStream(stream, ..) => {
let type_ = type_of(&stream);
if options.detailed { if options.detailed {
let subtype = if options.no_collect { let subtype = if options.no_collect {
Value::string("any", head) Value::string("any", head)
@ -201,6 +284,8 @@ fn run(
Value::record( Value::record(
record! { record! {
"type" => Value::string("stream", head), "type" => Value::string("stream", head),
"detailed_type" => Value::string("list stream", head),
"rust_type" => Value::string(type_, head),
"origin" => Value::string("nushell", head), "origin" => Value::string("nushell", head),
"subtype" => subtype, "subtype" => subtype,
"metadata" => metadata_to_value(metadata, head), "metadata" => metadata_to_value(metadata, head),
@ -229,45 +314,95 @@ fn run(
} }
enum Description { enum Description {
String(String),
Record(Record), Record(Record),
} }
impl Description { impl Description {
fn into_value(self, span: Span) -> Value { fn into_value(self, span: Span) -> Value {
match self { match self {
Description::String(ty) => Value::string(ty, span),
Description::Record(record) => Value::record(record, span), Description::Record(record) => Value::record(record, span),
} }
} }
} }
fn describe_value(value: Value, head: Span, engine_state: Option<&EngineState>) -> Value { fn describe_value(value: Value, head: Span, engine_state: Option<&EngineState>) -> Value {
let record = match describe_value_inner(value, head, engine_state) { let Description::Record(record) = describe_value_inner(value, head, engine_state);
Description::String(ty) => record! { "type" => Value::string(ty, head) },
Description::Record(record) => record,
};
Value::record(record, head) Value::record(record, head)
} }
fn type_of<T>(_: &T) -> String {
type_name::<T>().to_string()
}
fn describe_value_inner( fn describe_value_inner(
value: Value, mut value: Value,
head: Span, head: Span,
engine_state: Option<&EngineState>, engine_state: Option<&EngineState>,
) -> Description { ) -> Description {
let value_type = value.get_type().to_string();
match value { match value {
Value::Bool { .. } Value::Bool { val, .. } => Description::Record(record! {
| Value::Int { .. } "type" => Value::string("bool", head),
| Value::Float { .. } "detailed_type" => Value::string(value_type, head),
| Value::Filesize { .. } "rust_type" => Value::string(type_of(&val), head),
| Value::Duration { .. } "value" => value,
| Value::Date { .. } }),
| Value::Range { .. } Value::Int { val, .. } => Description::Record(record! {
| Value::String { .. } "type" => Value::string("int", head),
| Value::Glob { .. } "detailed_type" => Value::string(value_type, head),
| Value::Nothing { .. } => Description::String(value.get_type().to_string()), "rust_type" => Value::string(type_of(&val), head),
Value::Record { val, .. } => { "value" => value,
let mut columns = val.into_owned(); }),
Value::Float { val, .. } => Description::Record(record! {
"type" => Value::string("float", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}),
Value::Filesize { val, .. } => Description::Record(record! {
"type" => Value::string("filesize", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}),
Value::Duration { val, .. } => Description::Record(record! {
"type" => Value::string("duration", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}),
Value::Date { val, .. } => Description::Record(record! {
"type" => Value::string("datetime", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}),
Value::Range { ref val, .. } => Description::Record(record! {
"type" => Value::string("range", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}),
Value::String { ref val, .. } => Description::Record(record! {
"type" => Value::string("string", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}),
Value::Glob { ref val, .. } => Description::Record(record! {
"type" => Value::string("glob", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}),
Value::Nothing { .. } => Description::Record(record! {
"type" => Value::string("nothing", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string("", head),
"value" => value,
}),
Value::Record { ref val, .. } => {
let mut columns = val.clone().into_owned();
for (_, val) in &mut columns { for (_, val) in &mut columns {
*val = *val =
describe_value_inner(std::mem::take(val), head, engine_state).into_value(head); describe_value_inner(std::mem::take(val), head, engine_state).into_value(head);
@ -275,25 +410,34 @@ fn describe_value_inner(
Description::Record(record! { Description::Record(record! {
"type" => Value::string("record", head), "type" => Value::string("record", head),
"columns" => Value::record(columns, head), "detailed_type" => Value::string(value_type, head),
"columns" => Value::record(columns.clone(), head),
"rust_type" => Value::string(type_of(&val), head),
}) })
} }
Value::List { mut vals, .. } => { Value::List { ref mut vals, .. } => {
for val in &mut vals { for val in &mut *vals {
*val = *val =
describe_value_inner(std::mem::take(val), head, engine_state).into_value(head); describe_value_inner(std::mem::take(val), head, engine_state).into_value(head);
} }
Description::Record(record! { Description::Record(record! {
"type" => Value::string("list", head), "type" => Value::string("list", head),
"detailed_type" => Value::string(value_type, head),
"length" => Value::int(vals.len() as i64, head), "length" => Value::int(vals.len() as i64, head),
"values" => Value::list(vals, head), "rust_type" => Value::string(type_of(&vals), head),
"value" => value,
}) })
} }
Value::Closure { val, .. } => { Value::Closure { ref val, .. } => {
let block = engine_state.map(|engine_state| engine_state.get_block(val.block_id)); let block = engine_state.map(|engine_state| engine_state.get_block(val.block_id));
let mut record = record! { "type" => Value::string("closure", head) }; let mut record = record! {
"type" => Value::string("closure", head),
"detailed_type" => Value::string(value_type, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
};
if let Some(block) = block { if let Some(block) = block {
record.push( record.push(
"signature", "signature",
@ -308,21 +452,37 @@ fn describe_value_inner(
} }
Description::Record(record) Description::Record(record)
} }
Value::Error { error, .. } => Description::Record(record! { Value::Error { ref error, .. } => Description::Record(record! {
"type" => Value::string("error", head), "type" => Value::string("error", head),
"detailed_type" => Value::string(value_type, head),
"subtype" => Value::string(error.to_string(), head), "subtype" => Value::string(error.to_string(), head),
"rust_type" => Value::string(type_of(&error), head),
"value" => value,
}), }),
Value::Binary { val, .. } => Description::Record(record! { Value::Binary { ref val, .. } => Description::Record(record! {
"type" => Value::string("binary", head), "type" => Value::string("binary", head),
"detailed_type" => Value::string(value_type, head),
"length" => Value::int(val.len() as i64, head), "length" => Value::int(val.len() as i64, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value,
}), }),
Value::CellPath { val, .. } => Description::Record(record! { Value::CellPath { ref val, .. } => Description::Record(record! {
"type" => Value::string("cell-path", head), "type" => Value::string("cell-path", head),
"detailed_type" => Value::string(value_type, head),
"length" => Value::int(val.members.len() as i64, head), "length" => Value::int(val.members.len() as i64, head),
"rust_type" => Value::string(type_of(&val), head),
"value" => value
}), }),
Value::Custom { val, .. } => Description::Record(record! { Value::Custom { ref val, .. } => Description::Record(record! {
"type" => Value::string("custom", head), "type" => Value::string("custom", head),
"detailed_type" => Value::string(value_type, head),
"subtype" => Value::string(val.type_name(), head), "subtype" => Value::string(val.type_name(), head),
"rust_type" => Value::string(type_of(&val), head),
"value" =>
match val.to_base_value(head) {
Ok(base_value) => base_value,
Err(err) => Value::error(err, head),
}
}), }),
} }
} }