f7b8f97873
Continuation of #8229 # Description The `ShellError` enum at the moment is kind of messy. Many variants are basic tuple structs where you always have to reference the implementation with its macro invocation to know which field serves which purpose. Furthermore we have both variants that are kind of redundant or either overly broad to be useful for the user to match on or overly specific with few uses. So I set out to start fixing the lacking documentation and naming to make it feasible to critically review the individual usages and fix those. Furthermore we can decide to join or split up variants that don't seem to be fit for purpose. **Everyone:** Feel free to add review comments if you spot inconsistent use of `ShellError` variants. - Name fields of `SE::IncorrectValue` - Merge and name fields on `SE::TypeMismatch` - Name fields on `SE::UnsupportedOperator` - Name fields on `AssignmentRequires*` and fix doc - Name fields on `SE::UnknownOperator` - Name fields on `SE::MissingParameter` - Name fields on `SE::DelimiterError` - Name fields on `SE::IncompatibleParametersSingle` # User-Facing Changes (None now, end goal more explicit and consistent error messages) # Tests + Formatting (No additional tests needed so far)
115 lines
3.7 KiB
Rust
115 lines
3.7 KiB
Rust
use crate::dataframe::values::{Column, NuDataFrame, NuExpression};
|
|
use nu_engine::CallExt;
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack},
|
|
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
|
|
};
|
|
use polars::prelude::{lit, DataType};
|
|
|
|
#[derive(Clone)]
|
|
pub struct ExprIsIn;
|
|
|
|
impl Command for ExprIsIn {
|
|
fn name(&self) -> &str {
|
|
"dfr is-in"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Creates an is-in expression."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required(
|
|
"list",
|
|
SyntaxShape::List(Box::new(SyntaxShape::Any)),
|
|
"List to check if values are in",
|
|
)
|
|
.input_type(Type::Custom("expression".into()))
|
|
.output_type(Type::Custom("expression".into()))
|
|
.category(Category::Custom("expression".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Creates a is-in expression",
|
|
example: r#"let df = ([[a b]; [one 1] [two 2] [three 3]] | dfr into-df);
|
|
$df | dfr with-column (dfr col a | dfr is-in [one two] | dfr as a_in)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![
|
|
Value::test_string("one"),
|
|
Value::test_string("two"),
|
|
Value::test_string("three"),
|
|
],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(1), Value::test_int(2), Value::test_int(3)],
|
|
),
|
|
Column::new(
|
|
"a_in".to_string(),
|
|
vec![
|
|
Value::test_bool(true),
|
|
Value::test_bool(true),
|
|
Value::test_bool(false),
|
|
],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
}]
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["check", "contained", "is-contain", "match"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let list: Vec<Value> = call.req(engine_state, stack, 0)?;
|
|
let expr = NuExpression::try_from_pipeline(input, call.head)?;
|
|
|
|
let values = NuDataFrame::try_from_columns(vec![Column::new("list".to_string(), list)])?;
|
|
let list = values.as_series(call.head)?;
|
|
|
|
if matches!(list.dtype(), DataType::Object(..)) {
|
|
return Err(ShellError::IncompatibleParametersSingle {
|
|
msg: "Cannot use a mixed list as argument".into(),
|
|
span: call.head,
|
|
});
|
|
}
|
|
|
|
let expr: NuExpression = expr.into_polars().is_in(lit(list)).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::WithColumn;
|
|
use crate::dataframe::expressions::alias::ExprAlias;
|
|
use crate::dataframe::expressions::col::ExprCol;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![
|
|
Box::new(ExprIsIn {}),
|
|
Box::new(ExprAlias {}),
|
|
Box::new(ExprCol {}),
|
|
Box::new(WithColumn {}),
|
|
])
|
|
}
|
|
}
|