nu-command 0.62.0

Nushell's built-in commands
Documentation 
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use nu_engine::CallExt;
use nu_protocol::{
    ast::Call,
    engine::{Command, EngineState, Stack},
    Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Value,
};

use crate::dataframe::values::{utils::convert_columns_string, Column};

use super::super::values::NuDataFrame;

#[derive(Clone)]
pub struct SortDF;

impl Command for SortDF {
    fn name(&self) -> &str {
        "dfr sort"
    }

    fn usage(&self) -> &str {
        "Creates new sorted dataframe or series"
    }

    fn signature(&self) -> Signature {
        Signature::build(self.name())
            .switch("reverse", "invert sort", Some('r'))
            .rest("rest", SyntaxShape::Any, "column names to sort dataframe")
            .category(Category::Custom("dataframe".into()))
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Create new sorted dataframe",
                example: "[[a b]; [3 4] [1 2]] | dfr to-df | dfr sort a",
                result: Some(
                    NuDataFrame::try_from_columns(vec![
                        Column::new(
                            "a".to_string(),
                            vec![Value::test_int(1), Value::test_int(3)],
                        ),
                        Column::new(
                            "b".to_string(),
                            vec![Value::test_int(2), Value::test_int(4)],
                        ),
                    ])
                    .expect("simple df for test should not fail")
                    .into_value(Span::test_data()),
                ),
            },
            Example {
                description: "Create new sorted series",
                example: "[3 4 1 2] | dfr to-df | dfr sort",
                result: Some(
                    NuDataFrame::try_from_columns(vec![Column::new(
                        "0".to_string(),
                        vec![
                            Value::test_int(1),
                            Value::test_int(2),
                            Value::test_int(3),
                            Value::test_int(4),
                        ],
                    )])
                    .expect("simple df for test should not fail")
                    .into_value(Span::test_data()),
                ),
            },
        ]
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        command(engine_state, stack, call, input)
    }
}

fn command(
    engine_state: &EngineState,
    stack: &mut Stack,
    call: &Call,
    input: PipelineData,
) -> Result<PipelineData, ShellError> {
    let reverse = call.has_flag("reverse");

    let df = NuDataFrame::try_from_pipeline(input, call.head)?;

    if df.is_series() {
        let columns = df.as_ref().get_column_names();

        df.as_ref()
            .sort(columns, reverse)
            .map_err(|e| {
                ShellError::GenericError(
                    "Error sorting dataframe".into(),
                    e.to_string(),
                    Some(call.head),
                    None,
                    Vec::new(),
                )
            })
            .map(|df| PipelineData::Value(NuDataFrame::dataframe_into_value(df, call.head), None))
    } else {
        let columns: Vec<Value> = call.rest(engine_state, stack, 0)?;

        if !columns.is_empty() {
            let (col_string, col_span) = convert_columns_string(columns, call.head)?;

            df.as_ref()
                .sort(&col_string, reverse)
                .map_err(|e| {
                    ShellError::GenericError(
                        "Error sorting dataframe".into(),
                        e.to_string(),
                        Some(col_span),
                        None,
                        Vec::new(),
                    )
                })
                .map(|df| {
                    PipelineData::Value(NuDataFrame::dataframe_into_value(df, call.head), None)
                })
        } else {
            Err(ShellError::GenericError(
                "Missing columns".into(),
                "missing column name to perform sort".into(),
                Some(call.head),
                None,
                Vec::new(),
            ))
        }
    }
}

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

    #[test]
    fn test_examples() {
        test_dataframe(vec![Box::new(SortDF {})])
    }
}