mirror of
https://github.com/nushell/nushell.git
synced 2025-05-05 23:42:56 +00:00
8da27a1a09
# Description
This PR creates a new `Record` type to reduce duplicate code and
possibly bugs as well. (This is an edited version of #9648.)
- `Record` implements `FromIterator` and `IntoIterator` and so can be
iterated over or collected into. For example, this helps with
conversions to and from (hash)maps. (Also, no more
`cols.iter().zip(vals)`!)
- `Record` has a `push(col, val)` function to help insure that the
number of columns is equal to the number of values. I caught a few
potential bugs thanks to this (e.g. in the `ls` command).
- Finally, this PR also adds a `record!` macro that helps simplify
record creation. It is used like so:
```rust
record! {
"key1" => some_value,
"key2" => Value::string("text", span),
"key3" => Value::int(optional_int.unwrap_or(0), span),
"key4" => Value::bool(config.setting, span),
}
```
Since macros hinder formatting, etc., the right hand side values should
be relatively short and sweet like the examples above.
Where possible, prefer `record!` or `.collect()` on an iterator instead
of multiple `Record::push`s, since the first two automatically set the
record capacity and do less work overall.
# User-Facing Changes
Besides the changes in `nu-protocol` the only other breaking changes are
to `nu-table::{ExpandedTable::build_map, JustTable::kv_table}`.
73 lines
1.9 KiB
Rust
73 lines
1.9 KiB
Rust
use crate::dataframe::values::NuExpression;
|
|
use nu_engine::CallExt;
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack},
|
|
Category, Example, PipelineData, Record, ShellError, Signature, SyntaxShape, Type, Value,
|
|
};
|
|
use polars::prelude::col;
|
|
|
|
#[derive(Clone)]
|
|
pub struct ExprCol;
|
|
|
|
impl Command for ExprCol {
|
|
fn name(&self) -> &str {
|
|
"dfr col"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Creates a named column expression."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required(
|
|
"column name",
|
|
SyntaxShape::String,
|
|
"Name of column to be used",
|
|
)
|
|
.input_output_type(Type::Any, Type::Custom("expression".into()))
|
|
.category(Category::Custom("expression".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Creates a named column expression and converts it to a nu object",
|
|
example: "dfr col a | dfr into-nu",
|
|
result: Some(Value::test_record(Record {
|
|
cols: vec!["expr".into(), "value".into()],
|
|
vals: vec![Value::test_string("column"), Value::test_string("a")],
|
|
})),
|
|
}]
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["create"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let name: String = call.req(engine_state, stack, 0)?;
|
|
let expr: NuExpression = col(name.as_str()).into();
|
|
|
|
Ok(PipelineData::Value(expr.into_value(call.head), None))
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::super::super::test_dataframe::test_dataframe;
|
|
use super::*;
|
|
use crate::dataframe::eager::ToNu;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![Box::new(ExprCol {}), Box::new(ToNu {})])
|
|
}
|
|
}
|