cmd(df/first): returns the first row by default. (#6312)

This commit is contained in:
Andrés N. Robalino 2022-08-13 14:08:00 -05:00 committed by GitHub
parent 613d2fb8df
commit eb55fd2383
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,4 +1,4 @@
use super::super::values::{utils::DEFAULT_ROWS, Column, NuDataFrame}; use super::super::values::{Column, NuDataFrame};
use nu_engine::CallExt; use nu_engine::CallExt;
use nu_protocol::{ use nu_protocol::{
ast::Call, ast::Call,
@ -15,30 +15,54 @@ impl Command for FirstDF {
} }
fn usage(&self) -> &str { fn usage(&self) -> &str {
"Creates new dataframe with first rows" "Show only the first number of rows."
} }
fn signature(&self) -> Signature { fn signature(&self) -> Signature {
Signature::build(self.name()) Signature::build(self.name())
.optional("rows", SyntaxShape::Int, "Number of rows for head") .optional(
"rows",
SyntaxShape::Int,
"starting from the front, the number of rows to return",
)
.input_type(Type::Custom("dataframe".into())) .input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into())) .output_type(Type::Custom("dataframe".into()))
.category(Category::Custom("dataframe".into())) .category(Category::Custom("dataframe".into()))
} }
fn examples(&self) -> Vec<Example> { fn examples(&self) -> Vec<Example> {
vec![Example { vec![
description: "Create new dataframe with head rows", Example {
example: "[[a b]; [1 2] [3 4]] | into df | first 1", description: "Return the first row of a dataframe",
result: Some( example: "[[a b]; [1 2] [3 4]] | into df | first",
NuDataFrame::try_from_columns(vec![ result: Some(
Column::new("a".to_string(), vec![Value::test_int(1)]), NuDataFrame::try_from_columns(vec![
Column::new("b".to_string(), vec![Value::test_int(2)]), Column::new("a".to_string(), vec![Value::test_int(1)]),
]) Column::new("b".to_string(), vec![Value::test_int(2)]),
.expect("simple df for test should not fail") ])
.into_value(Span::test_data()), .expect("should not fail")
), .into_value(Span::test_data()),
}] ),
},
Example {
description: "Return the first two rows of a dataframe",
example: "[[a b]; [1 2] [3 4]] | into df | first 2",
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("should not fail")
.into_value(Span::test_data()),
),
},
]
} }
fn run( fn run(
@ -60,7 +84,7 @@ fn command(
df: NuDataFrame, df: NuDataFrame,
) -> Result<PipelineData, ShellError> { ) -> Result<PipelineData, ShellError> {
let rows: Option<usize> = call.opt(engine_state, stack, 0)?; let rows: Option<usize> = call.opt(engine_state, stack, 0)?;
let rows = rows.unwrap_or(DEFAULT_ROWS); let rows = rows.unwrap_or(1);
let res = df.as_ref().head(Some(rows)); let res = df.as_ref().head(Some(rows));
Ok(PipelineData::Value( Ok(PipelineData::Value(