use crate::{ values::{ cant_convert_err, CustomValueSupport, NuExpression, PolarsPluginObject, PolarsPluginType, }, PolarsPlugin, }; use super::super::super::values::{Column, NuDataFrame}; use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand}; use nu_protocol::{ Category, Example, LabeledError, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value, }; use polars::prelude::IntoSeries; #[derive(Clone)] pub struct StrFTime; impl PluginCommand for StrFTime { type Plugin = PolarsPlugin; fn name(&self) -> &str { "polars strftime" } fn description(&self) -> &str { "Formats date based on string rule." } fn signature(&self) -> Signature { Signature::build(self.name()) .required("fmt", SyntaxShape::String, "Format rule") .input_output_types(vec![ ( Type::Custom("expression".into()), Type::Custom("expression".into()), ), ( Type::Custom("dataframe".into()), Type::Custom("dataframe".into()), ), ]) .category(Category::Custom("dataframe".into())) } fn examples(&self) -> Vec { vec![ Example { description: "Formats date column as a string", example: r#"let date = '2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'; let df = ([[a]; [$date]] | polars into-df); let df2 = $df | polars with-column [(polars col a | polars strftime "%Y/%m/%d" | polars as b)] | polars collect; $df2.b"#, result: Some( NuDataFrame::try_from_columns( vec![Column::new( "b".to_string(), vec![Value::test_string("2020/08/04")], )], None, ) .expect("simple df for test should not fail") .into_value(Span::test_data()), ), }, Example { description: "Formats date", example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | polars into-df); $df | polars strftime "%Y/%m/%d""#, result: Some( NuDataFrame::try_from_columns( vec![Column::new( "0".to_string(), vec![ Value::test_string("2020/08/04"), Value::test_string("2020/08/04"), ], )], None, ) .expect("simple df for test should not fail") .into_value(Span::test_data()), ), }, ] } fn run( &self, plugin: &Self::Plugin, engine: &EngineInterface, call: &EvaluatedCall, input: PipelineData, ) -> Result { let value = input.into_value(call.head)?; match PolarsPluginObject::try_from_value(plugin, &value)? { PolarsPluginObject::NuDataFrame(df) => command_df(plugin, engine, call, df), PolarsPluginObject::NuLazyFrame(lazy) => { command_df(plugin, engine, call, lazy.collect(call.head)?) } PolarsPluginObject::NuExpression(expr) => command_expr(plugin, engine, call, expr), _ => Err(cant_convert_err( &value, &[ PolarsPluginType::NuDataFrame, PolarsPluginType::NuLazyFrame, PolarsPluginType::NuExpression, ], )), } .map_err(LabeledError::from) } } fn command_expr( plugin: &PolarsPlugin, engine: &EngineInterface, call: &EvaluatedCall, expr: NuExpression, ) -> Result { let fmt: String = call.req(0)?; let res: NuExpression = expr.into_polars().dt().strftime(&fmt).into(); res.to_pipeline_data(plugin, engine, call.head) } fn command_df( plugin: &PolarsPlugin, engine: &EngineInterface, call: &EvaluatedCall, df: NuDataFrame, ) -> Result { let fmt: String = call.req(0)?; let series = df.as_series(call.head)?; let casted = series.datetime().map_err(|e| ShellError::GenericError { error: "Error casting to date".into(), msg: e.to_string(), span: Some(call.head), help: Some("The str-slice command can only be used with string columns".into()), inner: vec![], })?; let res = casted .strftime(&fmt) .map_err(|e| ShellError::GenericError { error: "Error formatting datetime".into(), msg: e.to_string(), span: Some(call.head), help: None, inner: vec![], })? .into_series(); let df = NuDataFrame::try_from_series_vec(vec![res.into_series()], call.head)?; df.to_pipeline_data(plugin, engine, call.head) } #[cfg(test)] mod test { use super::*; use crate::test::test_polars_plugin_command_with_decls; use nu_command::IntoDatetime; #[test] fn test_examples() -> Result<(), ShellError> { test_polars_plugin_command_with_decls(&StrFTime, vec![Box::new(IntoDatetime)]) } }