629 lines
21 KiB
Rust
629 lines
21 KiB
Rust
/// Definition of multiple Expression commands using a macro rule
|
|
/// All of these expressions have an identical body and only require
|
|
/// to have a change in the name, description and expression function
|
|
use crate::dataframe::values::{Column, NuDataFrame, NuExpression, NuLazyFrame};
|
|
use crate::values::CustomValueSupport;
|
|
use crate::PolarsPlugin;
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{Category, Example, LabeledError, PipelineData, Signature, Span, Type, Value};
|
|
|
|
// The structs defined in this file are structs that form part of other commands
|
|
// since they share a similar name
|
|
macro_rules! expr_command {
|
|
($command: ident, $name: expr, $desc: expr, $examples: expr, $func: ident, $test: ident) => {
|
|
#[derive(Clone)]
|
|
pub struct $command;
|
|
|
|
impl PluginCommand for $command {
|
|
type Plugin = PolarsPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
$name
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
$desc
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.usage($desc)
|
|
.input_output_type(
|
|
Type::Custom("expression".into()),
|
|
Type::Custom("expression".into()),
|
|
)
|
|
.category(Category::Custom("expression".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
$examples
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &Self::Plugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let expr = NuExpression::try_from_pipeline(plugin, input, call.head)
|
|
.map_err(LabeledError::from)?;
|
|
let expr: NuExpression = expr.into_polars().$func().into();
|
|
expr.to_pipeline_data(plugin, engine, call.head)
|
|
.map_err(LabeledError::from)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod $test {
|
|
use super::*;
|
|
use crate::test::test_polars_plugin_command;
|
|
use nu_protocol::ShellError;
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), ShellError> {
|
|
test_polars_plugin_command(&$command)
|
|
}
|
|
}
|
|
};
|
|
|
|
($command: ident, $name: expr, $desc: expr, $examples: expr, $func: ident, $test: ident, $ddof: expr) => {
|
|
#[derive(Clone)]
|
|
pub struct $command;
|
|
|
|
impl PluginCommand for $command {
|
|
type Plugin = PolarsPlugin;
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.usage($desc)
|
|
.input_output_type(
|
|
Type::Custom("expression".into()),
|
|
Type::Custom("expression".into()),
|
|
)
|
|
.category(Category::Custom("expression".into()))
|
|
.plugin_examples($examples)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &Self::Plugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let expr = NuExpression::try_from_pipeline(input, call.head)
|
|
.map_err(LabeledError::from)?;
|
|
let expr: NuExpression = expr.into_polars().$func($ddof).into();
|
|
expr.to_pipeline_data(plugin, engine, call.head)
|
|
.map_err(LabeledError::from)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod $test {
|
|
use super::*;
|
|
use crate::test::test_polars_plugin_command;
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), ShellError> {
|
|
test_polars_plugin_command(&$command)
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
// The structs defined in this file are structs that form part of other commands
|
|
// since they share a similar name
|
|
macro_rules! lazy_expr_command {
|
|
($command: ident, $name: expr, $desc: expr, $examples: expr, $func: ident, $test: ident) => {
|
|
#[derive(Clone)]
|
|
pub struct $command;
|
|
|
|
impl PluginCommand for $command {
|
|
type Plugin = PolarsPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
$name
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
$desc
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.usage($desc)
|
|
.input_output_types(vec![
|
|
(
|
|
Type::Custom("expression".into()),
|
|
Type::Custom("expression".into()),
|
|
),
|
|
(
|
|
Type::Custom("dataframe".into()),
|
|
Type::Custom("dataframe".into()),
|
|
),
|
|
])
|
|
.category(Category::Custom("expression".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
$examples
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &Self::Plugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let value = input.into_value(call.head)?;
|
|
if NuDataFrame::can_downcast(&value) || NuLazyFrame::can_downcast(&value) {
|
|
let lazy = NuLazyFrame::try_from_value_coerce(plugin, &value)
|
|
.map_err(LabeledError::from)?;
|
|
let lazy = NuLazyFrame::new(lazy.from_eager, lazy.to_polars().$func());
|
|
lazy.to_pipeline_data(plugin, engine, call.head)
|
|
.map_err(LabeledError::from)
|
|
} else {
|
|
let expr =
|
|
NuExpression::try_from_value(plugin, &value).map_err(LabeledError::from)?;
|
|
let expr: NuExpression = expr.into_polars().$func().into();
|
|
expr.to_pipeline_data(plugin, engine, call.head)
|
|
.map_err(LabeledError::from)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod $test {
|
|
use super::*;
|
|
use crate::test::test_polars_plugin_command;
|
|
use nu_protocol::ShellError;
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), ShellError> {
|
|
test_polars_plugin_command(&$command)
|
|
}
|
|
}
|
|
};
|
|
|
|
($command: ident, $name: expr, $desc: expr, $examples: expr, $func: ident, $test: ident, $ddof: expr) => {
|
|
#[derive(Clone)]
|
|
pub struct $command;
|
|
|
|
impl PluginCommand for $command {
|
|
type Plugin = PolarsPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
$name
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
$desc
|
|
}
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_types(vec![
|
|
(
|
|
Type::Custom("expression".into()),
|
|
Type::Custom("expression".into()),
|
|
),
|
|
(
|
|
Type::Custom("dataframe".into()),
|
|
Type::Custom("dataframe".into()),
|
|
),
|
|
])
|
|
.category(Category::Custom("expression".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
$examples
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &Self::Plugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let value = input.into_value(call.head)?;
|
|
if NuDataFrame::can_downcast(&value) || NuLazyFrame::can_downcast(&value) {
|
|
let lazy = NuLazyFrame::try_from_value_coerce(plugin, &value)
|
|
.map_err(LabeledError::from)?;
|
|
let lazy = NuLazyFrame::new(lazy.from_eager, lazy.to_polars().$func($ddof));
|
|
lazy.to_pipeline_data(plugin, engine, call.head)
|
|
.map_err(LabeledError::from)
|
|
} else {
|
|
let expr = NuExpression::try_from_value(plugin, &value)?;
|
|
let expr: NuExpression = expr.into_polars().$func($ddof).into();
|
|
expr.to_pipeline_data(plugin, engine, call.head)
|
|
.map_err(LabeledError::from)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod $test {
|
|
use super::*;
|
|
use crate::test::test_polars_plugin_command;
|
|
use nu_protocol::ShellError;
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), ShellError> {
|
|
test_polars_plugin_command(&$command)
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
// ExprList command
|
|
// Expands to a command definition for a list expression
|
|
expr_command!(
|
|
ExprList,
|
|
"polars implode",
|
|
"Aggregates a group to a Series.",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
implode,
|
|
test_implode
|
|
);
|
|
|
|
// ExprAggGroups command
|
|
// Expands to a command definition for a agg groups expression
|
|
expr_command!(
|
|
ExprAggGroups,
|
|
"polars agg-groups",
|
|
"Creates an agg_groups expression.",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
agg_groups,
|
|
test_groups
|
|
);
|
|
|
|
// ExprCount command
|
|
// Expands to a command definition for a count expression
|
|
expr_command!(
|
|
ExprCount,
|
|
"polars count",
|
|
"Creates a count expression.",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
count,
|
|
test_count
|
|
);
|
|
|
|
// ExprNot command
|
|
// Expands to a command definition for a not expression
|
|
expr_command!(
|
|
ExprNot,
|
|
"polars expr-not",
|
|
"Creates a not expression.",
|
|
vec![Example {
|
|
description: "Creates a not expression",
|
|
example: "(polars col a) > 2) | polars expr-not",
|
|
result: None,
|
|
},],
|
|
not,
|
|
test_not
|
|
);
|
|
|
|
// ExprMax command
|
|
// Expands to a command definition for max aggregation
|
|
lazy_expr_command!(
|
|
ExprMax,
|
|
"polars max",
|
|
"Creates a max expression or aggregates columns to their max value.",
|
|
vec![
|
|
Example {
|
|
description: "Max value from columns in a dataframe",
|
|
example: "[[a b]; [6 2] [1 4] [4 1]] | polars into-df | polars max",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new("a".to_string(), vec![Value::test_int(6)],),
|
|
Column::new("b".to_string(), vec![Value::test_int(4)],),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Max aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| polars into-df
|
|
| polars group-by a
|
|
| polars agg (polars col b | polars max)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(4), Value::test_int(1)],
|
|
),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
],
|
|
max,
|
|
test_max
|
|
);
|
|
|
|
// ExprMin command
|
|
// Expands to a command definition for min aggregation
|
|
lazy_expr_command!(
|
|
ExprMin,
|
|
"polars min",
|
|
"Creates a min expression or aggregates columns to their min value.",
|
|
vec![
|
|
Example {
|
|
description: "Min value from columns in a dataframe",
|
|
example: "[[a b]; [6 2] [1 4] [4 1]] | polars into-df | polars min",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new("a".to_string(), vec![Value::test_int(1)],),
|
|
Column::new("b".to_string(), vec![Value::test_int(1)],),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Min aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| polars into-df
|
|
| polars group-by a
|
|
| polars agg (polars col b | polars min)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(2), Value::test_int(1)],
|
|
),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
],
|
|
min,
|
|
test_min
|
|
);
|
|
|
|
// ExprSum command
|
|
// Expands to a command definition for sum aggregation
|
|
lazy_expr_command!(
|
|
ExprSum,
|
|
"polars sum",
|
|
"Creates a sum expression for an aggregation or aggregates columns to their sum value.",
|
|
vec![
|
|
Example {
|
|
description: "Sums all columns in a dataframe",
|
|
example: "[[a b]; [6 2] [1 4] [4 1]] | polars into-df | polars sum",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new("a".to_string(), vec![Value::test_int(11)],),
|
|
Column::new("b".to_string(), vec![Value::test_int(7)],),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Sum aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| polars into-df
|
|
| polars group-by a
|
|
| polars agg (polars col b | polars sum)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(6), Value::test_int(1)],
|
|
),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
],
|
|
sum,
|
|
test_sum
|
|
);
|
|
|
|
// ExprMean command
|
|
// Expands to a command definition for mean aggregation
|
|
lazy_expr_command!(
|
|
ExprMean,
|
|
"polars mean",
|
|
"Creates a mean expression for an aggregation or aggregates columns to their mean value.",
|
|
vec![
|
|
Example {
|
|
description: "Mean value from columns in a dataframe",
|
|
example: "[[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars mean",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new("a".to_string(), vec![Value::test_float(4.0)],),
|
|
Column::new("b".to_string(), vec![Value::test_float(2.0)],),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Mean aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| polars into-df
|
|
| polars group-by a
|
|
| polars agg (polars col b | polars mean)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_float(3.0), Value::test_float(1.0)],
|
|
),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
],
|
|
mean,
|
|
test_mean
|
|
);
|
|
|
|
// ExprStd command
|
|
// Expands to a command definition for std aggregation
|
|
lazy_expr_command!(
|
|
ExprStd,
|
|
"polars std",
|
|
"Creates a std expression for an aggregation of std value from columns in a dataframe.",
|
|
vec![
|
|
Example {
|
|
description: "Std value from columns in a dataframe",
|
|
example: "[[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars std",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new("a".to_string(), vec![Value::test_float(2.0)],),
|
|
Column::new("b".to_string(), vec![Value::test_float(0.0)],),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Std aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 2] [two 1] [two 1]]
|
|
| polars into-df
|
|
| polars group-by a
|
|
| polars agg (polars col b | polars std)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_float(0.0), Value::test_float(0.0)],
|
|
),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
],
|
|
std,
|
|
test_std,
|
|
1
|
|
);
|
|
|
|
// ExprVar command
|
|
// Expands to a command definition for var aggregation
|
|
lazy_expr_command!(
|
|
ExprVar,
|
|
"polars var",
|
|
"Create a var expression for an aggregation.",
|
|
vec![
|
|
Example {
|
|
description:
|
|
"Var value from columns in a dataframe or aggregates columns to their var value",
|
|
example: "[[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars var",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new("a".to_string(), vec![Value::test_float(4.0)],),
|
|
Column::new("b".to_string(), vec![Value::test_float(0.0)],),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Var aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 2] [two 1] [two 1]]
|
|
| polars into-df
|
|
| polars group-by a
|
|
| polars agg (polars col b | polars var)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_float(0.0), Value::test_float(0.0)],
|
|
),
|
|
],
|
|
None
|
|
)
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
],
|
|
var,
|
|
test_var,
|
|
1
|
|
);
|