mirror of
https://github.com/nushell/nushell.git
synced 2025-05-05 15:32:56 +00: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.
105 lines
3.1 KiB
Rust
105 lines
3.1 KiB
Rust
use crate::dataframe::values::{Column, NuDataFrame};
|
|
use nu_engine::command_prelude::*;
|
|
|
|
use polars::prelude::{is_in, IntoSeries};
|
|
|
|
#[derive(Clone)]
|
|
pub struct IsIn;
|
|
|
|
impl Command for IsIn {
|
|
fn name(&self) -> &str {
|
|
"dfr is-in"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Checks if elements from a series are contained in right series."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required("other", SyntaxShape::Any, "right series")
|
|
.input_output_type(
|
|
Type::Custom("dataframe".into()),
|
|
Type::Custom("dataframe".into()),
|
|
)
|
|
.category(Category::Custom("dataframe".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Checks if elements from a series are contained in right series",
|
|
example: r#"let other = ([1 3 6] | dfr into-df);
|
|
[5 6 6 6 8 8 8] | dfr into-df | dfr is-in $other"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![Column::new(
|
|
"is_in".to_string(),
|
|
vec![
|
|
Value::test_bool(false),
|
|
Value::test_bool(true),
|
|
Value::test_bool(true),
|
|
Value::test_bool(true),
|
|
Value::test_bool(false),
|
|
Value::test_bool(false),
|
|
Value::test_bool(false),
|
|
],
|
|
)],
|
|
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> {
|
|
command(engine_state, stack, call, input)
|
|
}
|
|
}
|
|
|
|
fn command(
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let df = NuDataFrame::try_from_pipeline(input, call.head)?.as_series(call.head)?;
|
|
|
|
let other_value: Value = call.req(engine_state, stack, 0)?;
|
|
let other_span = other_value.span();
|
|
let other_df = NuDataFrame::try_from_value(other_value)?;
|
|
let other = other_df.as_series(other_span)?;
|
|
|
|
let mut res = is_in(&df, &other)
|
|
.map_err(|e| ShellError::GenericError {
|
|
error: "Error finding in other".into(),
|
|
msg: e.to_string(),
|
|
span: Some(call.head),
|
|
help: None,
|
|
inner: vec![],
|
|
})?
|
|
.into_series();
|
|
|
|
res.rename("is_in");
|
|
|
|
NuDataFrame::try_from_series(vec![res.into_series()], call.head)
|
|
.map(|df| PipelineData::Value(NuDataFrame::into_value(df, call.head), None))
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::super::super::super::test_dataframe::test_dataframe;
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![Box::new(IsIn {})])
|
|
}
|
|
}
|