mirror of
https://github.com/nushell/nushell.git
synced 2025-07-08 18:37:07 +02:00
9068093081
# Description
This PR does a few things to help improve type hovers and, in the
process, fixes a few outstanding issues in the type system. Here's a
list of the changes:
* `for` now will try to infer the type of the iteration variable based
on the expression it's given. This fixes things like `for x in [1, 2, 3]
{ }` where `x` now properly gets the int type.
* Removed old input/output type fields from the signature, focuses on
the vec of signatures. Updated a bunch of dataframe commands that hadn't
moved over. This helps tie things together a bit better
* Fixed inference of types from subexpressions to use the last
expression in the block
* Fixed handling of explicit types in `let` and `mut` calls, so we now
respect that as the authoritative type
I also tried to add `def` input/output type inference, but unfortunately
we only know the predecl types universally, which means we won't have
enough information to properly know what the types of the custom
commands are.
# User-Facing Changes
Script typechecking will get tighter in some cases
Hovers should be more accurate in some cases that previously resorted to
any.
# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.
Make sure you've run and fixed any issues with these commands:
- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect -A clippy::result_large_err` to check that
you're using the standard code style
- `cargo test --workspace` to check that all tests pass
- `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the
standard library
> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->
# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
---------
Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com>
520 lines
14 KiB
Rust
520 lines
14 KiB
Rust
/// Definition of multiple Expression commands using a macro rule
|
|
/// All of these expressions have an identical body and only require
|
|
/// to have a change in the name, description and expression function
|
|
use crate::dataframe::values::{Column, NuDataFrame, NuExpression};
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack},
|
|
Category, Example, PipelineData, ShellError, Signature, Span, Type, Value,
|
|
};
|
|
|
|
// The structs defined in this file are structs that form part of other commands
|
|
// since they share a similar name
|
|
macro_rules! expr_command {
|
|
($command: ident, $name: expr, $desc: expr, $examples: expr, $func: ident, $test: ident) => {
|
|
#[derive(Clone)]
|
|
pub struct $command;
|
|
|
|
impl Command for $command {
|
|
fn name(&self) -> &str {
|
|
$name
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
$desc
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_type(
|
|
Type::Custom("expression".into()),
|
|
Type::Custom("expression".into()),
|
|
)
|
|
.category(Category::Custom("expression".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
$examples
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let expr = NuExpression::try_from_pipeline(input, call.head)?;
|
|
let expr: NuExpression = expr.into_polars().$func().into();
|
|
|
|
Ok(PipelineData::Value(
|
|
NuExpression::into_value(expr, call.head),
|
|
None,
|
|
))
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod $test {
|
|
use super::super::super::test_dataframe::test_dataframe;
|
|
use super::*;
|
|
use crate::dataframe::lazy::aggregate::LazyAggregate;
|
|
use crate::dataframe::lazy::groupby::ToLazyGroupBy;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![
|
|
Box::new($command {}),
|
|
Box::new(LazyAggregate {}),
|
|
Box::new(ToLazyGroupBy {}),
|
|
])
|
|
}
|
|
}
|
|
};
|
|
|
|
($command: ident, $name: expr, $desc: expr, $examples: expr, $func: ident, $test: ident, $ddof: expr) => {
|
|
#[derive(Clone)]
|
|
pub struct $command;
|
|
|
|
impl Command for $command {
|
|
fn name(&self) -> &str {
|
|
$name
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
$desc
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_type(
|
|
Type::Custom("expression".into()),
|
|
Type::Custom("expression".into()),
|
|
)
|
|
.category(Category::Custom("expression".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
$examples
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let expr = NuExpression::try_from_pipeline(input, call.head)?;
|
|
let expr: NuExpression = expr.into_polars().$func($ddof).into();
|
|
|
|
Ok(PipelineData::Value(
|
|
NuExpression::into_value(expr, call.head),
|
|
None,
|
|
))
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod $test {
|
|
use super::super::super::test_dataframe::test_dataframe;
|
|
use super::*;
|
|
use crate::dataframe::lazy::aggregate::LazyAggregate;
|
|
use crate::dataframe::lazy::groupby::ToLazyGroupBy;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![
|
|
Box::new($command {}),
|
|
Box::new(LazyAggregate {}),
|
|
Box::new(ToLazyGroupBy {}),
|
|
])
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
// ExprList command
|
|
// Expands to a command definition for a list expression
|
|
expr_command!(
|
|
ExprList,
|
|
"dfr implode",
|
|
"Aggregates a group to a Series",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
implode,
|
|
test_implode
|
|
);
|
|
|
|
// ExprAggGroups command
|
|
// Expands to a command definition for a agg groups expression
|
|
expr_command!(
|
|
ExprAggGroups,
|
|
"dfr agg-groups",
|
|
"creates an agg_groups expression",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
agg_groups,
|
|
test_groups
|
|
);
|
|
|
|
// ExprFlatten command
|
|
// Expands to a command definition for a flatten expression
|
|
expr_command!(
|
|
ExprFlatten,
|
|
"dfr flatten",
|
|
"creates a flatten expression",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
flatten,
|
|
test_flatten
|
|
);
|
|
|
|
// ExprExplode command
|
|
// Expands to a command definition for a explode expression
|
|
expr_command!(
|
|
ExprExplode,
|
|
"dfr explode",
|
|
"creates an explode expression",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
explode,
|
|
test_explode
|
|
);
|
|
|
|
// ExprCount command
|
|
// Expands to a command definition for a count expression
|
|
expr_command!(
|
|
ExprCount,
|
|
"dfr count",
|
|
"creates a count expression",
|
|
vec![Example {
|
|
description: "",
|
|
example: "",
|
|
result: None,
|
|
}],
|
|
count,
|
|
test_count
|
|
);
|
|
|
|
// ExprFirst command
|
|
// Expands to a command definition for a count expression
|
|
expr_command!(
|
|
ExprFirst,
|
|
"dfr first",
|
|
"creates a first expression",
|
|
vec![Example {
|
|
description: "Creates a first expression from a column",
|
|
example: "dfr col a | dfr first",
|
|
result: None,
|
|
},],
|
|
first,
|
|
test_first
|
|
);
|
|
|
|
// ExprLast command
|
|
// Expands to a command definition for a count expression
|
|
expr_command!(
|
|
ExprLast,
|
|
"dfr last",
|
|
"creates a last expression",
|
|
vec![Example {
|
|
description: "Creates a last expression from a column",
|
|
example: "dfr col a | dfr last",
|
|
result: None,
|
|
},],
|
|
last,
|
|
test_last
|
|
);
|
|
|
|
// ExprNUnique command
|
|
// Expands to a command definition for a n-unique expression
|
|
expr_command!(
|
|
ExprNUnique,
|
|
"dfr n-unique",
|
|
"creates a n-unique expression",
|
|
vec![Example {
|
|
description: "Creates a is n-unique expression from a column",
|
|
example: "dfr col a | dfr n-unique",
|
|
result: None,
|
|
},],
|
|
n_unique,
|
|
test_nunique
|
|
);
|
|
|
|
// ExprIsNotNull command
|
|
// Expands to a command definition for a n-unique expression
|
|
expr_command!(
|
|
ExprIsNotNull,
|
|
"dfr is-not-null",
|
|
"creates a is not null expression",
|
|
vec![Example {
|
|
description: "Creates a is not null expression from a column",
|
|
example: "dfr col a | dfr is-not-null",
|
|
result: None,
|
|
},],
|
|
is_not_null,
|
|
test_is_not_null
|
|
);
|
|
|
|
// ExprIsNull command
|
|
// Expands to a command definition for a n-unique expression
|
|
expr_command!(
|
|
ExprIsNull,
|
|
"dfr is-null",
|
|
"creates a is null expression",
|
|
vec![Example {
|
|
description: "Creates a is null expression from a column",
|
|
example: "dfr col a | dfr is-null",
|
|
result: None,
|
|
},],
|
|
is_null,
|
|
test_is_null
|
|
);
|
|
|
|
// ExprNot command
|
|
// Expands to a command definition for a not expression
|
|
expr_command!(
|
|
ExprNot,
|
|
"dfr expr-not",
|
|
"creates a not expression",
|
|
vec![Example {
|
|
description: "Creates a not expression",
|
|
example: "(dfr col a) > 2) | dfr expr-not",
|
|
result: None,
|
|
},],
|
|
not,
|
|
test_not
|
|
);
|
|
|
|
// ExprMax command
|
|
// Expands to a command definition for max aggregation
|
|
expr_command!(
|
|
ExprMax,
|
|
"dfr max",
|
|
"Creates a max expression",
|
|
vec![Example {
|
|
description: "Max aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| dfr into-df
|
|
| dfr group-by a
|
|
| dfr agg (dfr col b | dfr max)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(4), Value::test_int(1)],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},],
|
|
max,
|
|
test_max
|
|
);
|
|
|
|
// ExprMin command
|
|
// Expands to a command definition for min aggregation
|
|
expr_command!(
|
|
ExprMin,
|
|
"dfr min",
|
|
"Creates a min expression",
|
|
vec![Example {
|
|
description: "Min aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| dfr into-df
|
|
| dfr group-by a
|
|
| dfr agg (dfr col b | dfr min)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(2), Value::test_int(1)],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},],
|
|
min,
|
|
test_min
|
|
);
|
|
|
|
// ExprSum command
|
|
// Expands to a command definition for sum aggregation
|
|
expr_command!(
|
|
ExprSum,
|
|
"dfr sum",
|
|
"Creates a sum expression for an aggregation",
|
|
vec![Example {
|
|
description: "Sum aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| dfr into-df
|
|
| dfr group-by a
|
|
| dfr agg (dfr col b | dfr sum)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(6), Value::test_int(1)],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},],
|
|
sum,
|
|
test_sum
|
|
);
|
|
|
|
// ExprMean command
|
|
// Expands to a command definition for mean aggregation
|
|
expr_command!(
|
|
ExprMean,
|
|
"dfr mean",
|
|
"Creates a mean expression for an aggregation",
|
|
vec![Example {
|
|
description: "Mean aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| dfr into-df
|
|
| dfr group-by a
|
|
| dfr agg (dfr col b | dfr mean)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_float(3.0), Value::test_float(1.0)],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},],
|
|
mean,
|
|
test_mean
|
|
);
|
|
|
|
// ExprMedian command
|
|
// Expands to a command definition for median aggregation
|
|
expr_command!(
|
|
ExprMedian,
|
|
"dfr median",
|
|
"Creates a median expression for an aggregation",
|
|
vec![Example {
|
|
description: "Median aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 4] [two 1]]
|
|
| dfr into-df
|
|
| dfr group-by a
|
|
| dfr agg (dfr col b | dfr median)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_float(3.0), Value::test_float(1.0)],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},],
|
|
median,
|
|
test_median
|
|
);
|
|
|
|
// ExprStd command
|
|
// Expands to a command definition for std aggregation
|
|
expr_command!(
|
|
ExprStd,
|
|
"dfr std",
|
|
"Creates a std expression for an aggregation",
|
|
vec![Example {
|
|
description: "Std aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 2] [two 1] [two 1]]
|
|
| dfr into-df
|
|
| dfr group-by a
|
|
| dfr agg (dfr col b | dfr std)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_float(0.0), Value::test_float(0.0)],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},],
|
|
std,
|
|
test_std,
|
|
0
|
|
);
|
|
|
|
// ExprVar command
|
|
// Expands to a command definition for var aggregation
|
|
expr_command!(
|
|
ExprVar,
|
|
"dfr var",
|
|
"Create a var expression for an aggregation",
|
|
vec![Example {
|
|
description: "Var aggregation for a group-by",
|
|
example: r#"[[a b]; [one 2] [one 2] [two 1] [two 1]]
|
|
| dfr into-df
|
|
| dfr group-by a
|
|
| dfr agg (dfr col b | dfr var)"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_string("one"), Value::test_string("two")],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_float(0.0), Value::test_float(0.0)],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},],
|
|
var,
|
|
test_var,
|
|
0
|
|
);
|