nu_plugin_polars 0.113.0

Nushell dataframe plugin commands based on polars.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use crate::{
    PolarsPlugin,
    dataframe::values::NuSelector,
    values::{CustomValueSupport, PolarsPluginType},
};
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
use nu_protocol::{Category, Example, LabeledError, PipelineData, Signature, SyntaxShape, Type};
use polars_plan::prelude::{DataTypeSelector, Selector, TimeUnitSet};

#[derive(Clone)]
pub struct SelectorDuration;

impl PluginCommand for SelectorDuration {
    type Plugin = PolarsPlugin;

    fn name(&self) -> &str {
        "polars selector duration"
    }

    fn description(&self) -> &str {
        "Select all duration columns. Optionally filter by time unit (ns, us, ms)."
    }

    fn signature(&self) -> Signature {
        Signature::build(self.name())
            .named(
                "time-unit",
                SyntaxShape::List(Box::new(SyntaxShape::String)),
                "Filter by time unit(s): ns (nanoseconds), us (microseconds), ms (milliseconds).",
                None,
            )
            .input_output_type(Type::Any, PolarsPluginType::NuSelector.into())
            .category(Category::Custom("expression".into()))
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![
            Example {
                example: "polars selector duration",
                description: "Create a selector for all duration columns",
                result: None,
            },
            Example {
                example: "polars selector duration --time-unit [ns us]",
                description: "Create a selector for nanosecond or microsecond duration columns",
                result: None,
            },
        ]
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["columns", "select", "duration", "interval", "time"]
    }

    fn run(
        &self,
        plugin: &Self::Plugin,
        engine: &EngineInterface,
        call: &EvaluatedCall,
        mut input: PipelineData,
    ) -> Result<PipelineData, LabeledError> {
        let metadata = input.take_metadata();

        let time_units: Vec<String> = call
            .get_flag::<Vec<String>>("time-unit")?
            .unwrap_or_default();

        let tu_set = parse_time_unit_set(&time_units, call)?;

        let selector = Selector::ByDType(DataTypeSelector::Duration(tu_set));
        let nu_selector = NuSelector::from(selector);

        nu_selector
            .to_pipeline_data(plugin, engine, call.head)
            .map_err(LabeledError::from)
            .map(|pd| pd.set_metadata(metadata))
    }
}

fn parse_time_unit_set(
    time_units: &[String],
    call: &EvaluatedCall,
) -> Result<TimeUnitSet, LabeledError> {
    if time_units.is_empty() {
        return Ok(TimeUnitSet::all());
    }
    let mut set = TimeUnitSet::empty();
    for tu in time_units {
        let flag = match tu.as_str() {
            "ns" => TimeUnitSet::NANO_SECONDS,
            "us" => TimeUnitSet::MICRO_SECONDS,
            "ms" => TimeUnitSet::MILLI_SECONDS,
            other => {
                return Err(LabeledError::new(format!("Invalid time unit: '{other}'"))
                    .with_label("expected 'ns', 'us', or 'ms'", call.head));
            }
        };
        set |= flag;
    }
    Ok(set)
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::test::test_polars_plugin_command;

    #[test]
    fn test_examples() -> Result<(), nu_protocol::ShellError> {
        test_polars_plugin_command(&SelectorDuration)
    }
}