use crate::{ dataframe::{utils::extract_strings, values::NuLazyFrame}, values::CustomValueSupport, PolarsPlugin, }; use 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::UniqueKeepStrategy; #[derive(Clone)] pub struct Unique; impl PluginCommand for Unique { type Plugin = PolarsPlugin; fn name(&self) -> &str { "polars unique" } fn usage(&self) -> &str { "Returns unique values from a dataframe." } fn signature(&self) -> Signature { Signature::build(self.name()) .named( "subset", SyntaxShape::Any, "Subset of column(s) to use to maintain rows (lazy df)", Some('s'), ) .switch( "last", "Keeps last unique value. Default keeps first value (lazy df)", Some('l'), ) .switch( "maintain-order", "Keep the same order as the original DataFrame (lazy df)", Some('k'), ) .input_output_type( Type::Custom("dataframe".into()), Type::Custom("dataframe".into()), ) .category(Category::Custom("dataframe or lazyframe".into())) } fn examples(&self) -> Vec { vec![ Example { description: "Returns unique values from a series", example: "[2 2 2 2 2] | polars into-df | polars unique", result: Some( NuDataFrame::try_from_columns( vec![Column::new("0".to_string(), vec![Value::test_int(2)])], None, ) .expect("simple df for test should not fail") .into_value(Span::test_data()), ), }, Example { description: "Returns unique values in a subset of lazyframe columns", example: "[[a b c]; [1 2 1] [2 2 2] [3 2 1]] | polars into-df | polars unique --subset [b c] | polars collect", result: Some( NuDataFrame::try_from_columns( vec![ Column::new( "a".to_string(), vec![Value::test_int(1), Value::test_int(2)] ), Column::new( "b".to_string(), vec![Value::test_int(2), Value::test_int(2)] ), Column::new( "c".to_string(), vec![Value::test_int(1), Value::test_int(2)] ) ], None, ) .expect("simple df for test should not fail") .into_value(Span::test_data()), ), }, Example { description: "Returns unique values in a subset of lazyframe columns", example: r#"[[a b c]; [1 2 1] [2 2 2] [3 2 1]] | polars into-df | polars unique --subset [b c] --last | polars collect"#, result: Some( NuDataFrame::try_from_columns( vec![ Column::new( "a".to_string(), vec![Value::test_int(2), Value::test_int(3)] ), Column::new( "b".to_string(), vec![Value::test_int(2), Value::test_int(2)] ), Column::new( "c".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()), ), }, Example { description: "Creates a is unique expression from a column", example: "col a | unique", result: None, }, ] } fn run( &self, plugin: &Self::Plugin, engine: &EngineInterface, call: &EvaluatedCall, input: PipelineData, ) -> Result { let value = input.into_value(call.head); let df = NuLazyFrame::try_from_value_coerce(plugin, &value)?; command_lazy(plugin, engine, call, df).map_err(LabeledError::from) } } fn command_lazy( plugin: &PolarsPlugin, engine: &EngineInterface, call: &EvaluatedCall, lazy: NuLazyFrame, ) -> Result { let last = call.has_flag("last")?; let maintain = call.has_flag("maintain-order")?; let subset: Option = call.get_flag("subset")?; let subset = match subset { Some(value) => Some(extract_strings(value)?), None => None, }; let strategy = if last { UniqueKeepStrategy::Last } else { UniqueKeepStrategy::First }; let lazy = lazy.to_polars(); let lazy: NuLazyFrame = if maintain { lazy.unique(subset, strategy).into() } else { lazy.unique_stable(subset, strategy).into() }; lazy.to_pipeline_data(plugin, engine, call.head) } #[cfg(test)] mod test { use super::*; use crate::test::test_polars_plugin_command; #[test] fn test_examples() -> Result<(), ShellError> { test_polars_plugin_command(&Unique) } }