forked from extern/nushell
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>
251 lines
9.4 KiB
Rust
251 lines
9.4 KiB
Rust
use crate::dataframe::values::{Column, NuDataFrame, NuExpression, NuLazyFrame};
|
|
use nu_engine::CallExt;
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack},
|
|
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
|
|
};
|
|
use polars::prelude::{Expr, JoinType};
|
|
|
|
#[derive(Clone)]
|
|
pub struct LazyJoin;
|
|
|
|
impl Command for LazyJoin {
|
|
fn name(&self) -> &str {
|
|
"dfr join"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Joins a lazy frame with other lazy frame."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required("other", SyntaxShape::Any, "LazyFrame to join with")
|
|
.required("left_on", SyntaxShape::Any, "Left column(s) to join on")
|
|
.required("right_on", SyntaxShape::Any, "Right column(s) to join on")
|
|
.switch(
|
|
"inner",
|
|
"inner joing between lazyframes (default)",
|
|
Some('i'),
|
|
)
|
|
.switch("left", "left join between lazyframes", Some('l'))
|
|
.switch("outer", "outer join between lazyframes", Some('o'))
|
|
.switch("cross", "cross join between lazyframes", Some('c'))
|
|
.named(
|
|
"suffix",
|
|
SyntaxShape::String,
|
|
"Suffix to use on columns with same name",
|
|
Some('s'),
|
|
)
|
|
.input_output_type(
|
|
Type::Custom("dataframe".into()),
|
|
Type::Custom("dataframe".into()),
|
|
)
|
|
.category(Category::Custom("lazyframe".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Join two lazy dataframes",
|
|
example: r#"let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | dfr into-lazy);
|
|
let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [2 "c" "var"] [3 "c" "const"]] | dfr into-lazy);
|
|
$df_a | dfr join $df_b a foo | dfr collect"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(1),
|
|
Value::test_int(1),
|
|
],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![
|
|
Value::test_string("a"),
|
|
Value::test_string("b"),
|
|
Value::test_string("c"),
|
|
Value::test_string("c"),
|
|
],
|
|
),
|
|
Column::new(
|
|
"c".to_string(),
|
|
vec![
|
|
Value::test_int(0),
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(3),
|
|
],
|
|
),
|
|
Column::new(
|
|
"bar".to_string(),
|
|
vec![
|
|
Value::test_string("a"),
|
|
Value::test_string("c"),
|
|
Value::test_string("a"),
|
|
Value::test_string("a"),
|
|
],
|
|
),
|
|
Column::new(
|
|
"ham".to_string(),
|
|
vec![
|
|
Value::test_string("let"),
|
|
Value::test_string("var"),
|
|
Value::test_string("let"),
|
|
Value::test_string("let"),
|
|
],
|
|
),
|
|
])
|
|
.expect("simple df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Join one eager dataframe with a lazy dataframe",
|
|
example: r#"let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | dfr into-df);
|
|
let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [2 "c" "var"] [3 "c" "const"]] | dfr into-lazy);
|
|
$df_a | dfr join $df_b a foo"#,
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(1),
|
|
Value::test_int(1),
|
|
],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![
|
|
Value::test_string("a"),
|
|
Value::test_string("b"),
|
|
Value::test_string("c"),
|
|
Value::test_string("c"),
|
|
],
|
|
),
|
|
Column::new(
|
|
"c".to_string(),
|
|
vec![
|
|
Value::test_int(0),
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(3),
|
|
],
|
|
),
|
|
Column::new(
|
|
"bar".to_string(),
|
|
vec![
|
|
Value::test_string("a"),
|
|
Value::test_string("c"),
|
|
Value::test_string("a"),
|
|
Value::test_string("a"),
|
|
],
|
|
),
|
|
Column::new(
|
|
"ham".to_string(),
|
|
vec![
|
|
Value::test_string("let"),
|
|
Value::test_string("var"),
|
|
Value::test_string("let"),
|
|
Value::test_string("let"),
|
|
],
|
|
),
|
|
])
|
|
.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> {
|
|
let left = call.has_flag("left");
|
|
let outer = call.has_flag("outer");
|
|
let cross = call.has_flag("cross");
|
|
|
|
let how = if left {
|
|
JoinType::Left
|
|
} else if outer {
|
|
JoinType::Outer
|
|
} else if cross {
|
|
JoinType::Cross
|
|
} else {
|
|
JoinType::Inner
|
|
};
|
|
|
|
let other: Value = call.req(engine_state, stack, 0)?;
|
|
let other = NuLazyFrame::try_from_value(other)?;
|
|
let other = other.into_polars();
|
|
|
|
let left_on: Value = call.req(engine_state, stack, 1)?;
|
|
let left_on = NuExpression::extract_exprs(left_on)?;
|
|
|
|
let right_on: Value = call.req(engine_state, stack, 2)?;
|
|
let right_on = NuExpression::extract_exprs(right_on)?;
|
|
|
|
if left_on.len() != right_on.len() {
|
|
let right_on: Value = call.req(engine_state, stack, 2)?;
|
|
return Err(ShellError::IncompatibleParametersSingle {
|
|
msg: "The right column list has a different size to the left column list".into(),
|
|
span: right_on.span()?,
|
|
});
|
|
}
|
|
|
|
// Checking that both list of expressions are made out of col expressions or strings
|
|
for (index, list) in &[(1usize, &left_on), (2, &left_on)] {
|
|
if list.iter().any(|expr| !matches!(expr, Expr::Column(..))) {
|
|
let value: Value = call.req(engine_state, stack, *index)?;
|
|
return Err(ShellError::IncompatibleParametersSingle {
|
|
msg: "Expected only a string, col expressions or list of strings".into(),
|
|
span: value.span()?,
|
|
});
|
|
}
|
|
}
|
|
|
|
let suffix: Option<String> = call.get_flag(engine_state, stack, "suffix")?;
|
|
let suffix = suffix.unwrap_or_else(|| "_x".into());
|
|
|
|
let value = input.into_value(call.head);
|
|
let lazy = NuLazyFrame::try_from_value(value)?;
|
|
let from_eager = lazy.from_eager;
|
|
let lazy = lazy.into_polars();
|
|
|
|
let lazy = lazy
|
|
.join_builder()
|
|
.with(other)
|
|
.left_on(left_on)
|
|
.right_on(right_on)
|
|
.how(how)
|
|
.force_parallel(true)
|
|
.suffix(suffix)
|
|
.finish();
|
|
|
|
let lazy = NuLazyFrame::new(from_eager, lazy);
|
|
|
|
Ok(PipelineData::Value(lazy.into_value(call.head)?, None))
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::super::super::test_dataframe::test_dataframe;
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![Box::new(LazyJoin {})])
|
|
}
|
|
}
|