mirror of
https://github.com/nushell/nushell.git
synced 2025-07-08 02:17:22 +02:00
c747ec75c9
# Description
When implementing a `Command`, one must also import all the types
present in the function signatures for `Command`. This makes it so that
we often import the same set of types in each command implementation
file. E.g., something like this:
```rust
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData,
ShellError, Signature, Span, Type, Value,
};
```
This PR adds the `nu_engine::command_prelude` module which contains the
necessary and commonly used types to implement a `Command`:
```rust
// command_prelude.rs
pub use crate::CallExt;
pub use nu_protocol::{
ast::{Call, CellPath},
engine::{Command, EngineState, Stack},
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, IntoSpanned,
PipelineData, Record, ShellError, Signature, Span, Spanned, SyntaxShape, Type, Value,
};
```
This should reduce the boilerplate needed to implement a command and
also gives us a place to track the breadth of the `Command` API. I tried
to be conservative with what went into the prelude modules, since it
might be hard/annoying to remove items from the prelude in the future.
Let me know if something should be included or excluded.
117 lines
3.4 KiB
Rust
117 lines
3.4 KiB
Rust
use crate::dataframe::values::{Column, NuDataFrame, NuExpression, NuLazyFrame};
|
|
use nu_engine::command_prelude::*;
|
|
|
|
use polars_plan::prelude::lit;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Shift;
|
|
|
|
impl Command for Shift {
|
|
fn name(&self) -> &str {
|
|
"dfr shift"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Shifts the values by a given period."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required("period", SyntaxShape::Int, "shift period")
|
|
.named(
|
|
"fill",
|
|
SyntaxShape::Any,
|
|
"Expression used to fill the null values (lazy df)",
|
|
Some('f'),
|
|
)
|
|
.input_output_type(
|
|
Type::Custom("dataframe".into()),
|
|
Type::Custom("dataframe".into()),
|
|
)
|
|
.category(Category::Custom("dataframe or lazyframe".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Shifts the values by a given period",
|
|
example: "[1 2 2 3 3] | dfr into-df | dfr shift 2 | dfr drop-nulls",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![Column::new(
|
|
"0".to_string(),
|
|
vec![Value::test_int(1), Value::test_int(2), Value::test_int(2)],
|
|
)],
|
|
None,
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let value = input.into_value(call.head);
|
|
|
|
if NuLazyFrame::can_downcast(&value) {
|
|
let df = NuLazyFrame::try_from_value(value)?;
|
|
command_lazy(engine_state, stack, call, df)
|
|
} else {
|
|
let df = NuDataFrame::try_from_value(value)?;
|
|
command_eager(engine_state, stack, call, df)
|
|
}
|
|
}
|
|
}
|
|
|
|
fn command_eager(
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
df: NuDataFrame,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let period: i64 = call.req(engine_state, stack, 0)?;
|
|
let series = df.as_series(call.head)?.shift(period);
|
|
|
|
NuDataFrame::try_from_series(vec![series], call.head)
|
|
.map(|df| PipelineData::Value(NuDataFrame::into_value(df, call.head), None))
|
|
}
|
|
|
|
fn command_lazy(
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
lazy: NuLazyFrame,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let shift: i64 = call.req(engine_state, stack, 0)?;
|
|
let fill: Option<Value> = call.get_flag(engine_state, stack, "fill")?;
|
|
|
|
let lazy = lazy.into_polars();
|
|
|
|
let lazy: NuLazyFrame = match fill {
|
|
Some(fill) => {
|
|
let expr = NuExpression::try_from_value(fill)?.into_polars();
|
|
lazy.shift_and_fill(lit(shift), expr).into()
|
|
}
|
|
None => lazy.shift(shift).into(),
|
|
};
|
|
|
|
Ok(PipelineData::Value(lazy.into_value(call.head)?, None))
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::super::super::eager::DropNulls;
|
|
use super::super::super::test_dataframe::test_dataframe;
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![Box::new(Shift {}), Box::new(DropNulls {})])
|
|
}
|
|
}
|