holm/nushell
1
1
Fork 0
forked from extern/nushell
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve type hovers (#9515)

Browse Source 
# 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>
This commit is contained in:
JT
2023-06-29 05:19:48 +12:00
committed by GitHub
parent 9d247387ea
commit 9068093081
112 changed files with 681 additions and 334 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
crates/nu-cmd-dataframe/src/dataframe/eager/append.rs
View File

@ -23,8 +23,10 @@ impl Command for AppendDF {
Signature::build(self.name())
.required("other", SyntaxShape::Any, "dataframe to be appended")
.switch("col", "appends in col orientation", Some('c'))
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/columns.rs
View File

@ -19,8 +19,7 @@ impl Command for ColumnsDF {
fn signature(&self) -> Signature {
Signature::build(self.name())
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Any)
.input_output_type(Type::Custom("dataframe".into()), Type::Any)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/drop.rs
View File

@ -23,8 +23,10 @@ impl Command for DropDF {
fn signature(&self) -> Signature {
Signature::build(self.name())
.rest("rest", SyntaxShape::Any, "column names to be dropped")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/drop_duplicates.rs
View File

@ -34,8 +34,10 @@ impl Command for DropDuplicates {
"keeps last duplicate value (by default keeps first)",
Some('l'),
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/drop_nulls.rs
View File

@ -27,8 +27,10 @@ impl Command for DropNulls {
SyntaxShape::Table,
"subset of columns to drop nulls",
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/dtypes.rs
View File

@ -19,8 +19,10 @@ impl Command for DataTypes {
fn signature(&self) -> Signature {
Signature::build(self.name())
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/dummies.rs
View File

@ -20,8 +20,10 @@ impl Command for Dummies {
fn signature(&self) -> Signature {
Signature::build(self.name())
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/filter_with.rs
View File

@ -29,8 +29,10 @@ impl Command for FilterWith {
SyntaxShape::Any,
"boolean mask used to filter data",
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe or lazyframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/first.rs
View File

@ -25,8 +25,10 @@ impl Command for FirstDF {
SyntaxShape::Int,
"starting from the front, the number of rows to return",
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/get.rs
View File

@ -24,8 +24,10 @@ impl Command for GetDF {
fn signature(&self) -> Signature {
Signature::build(self.name())
.rest("rest", SyntaxShape::Any, "column names to sort dataframe")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/last.rs
View File

@ -21,8 +21,10 @@ impl Command for LastDF {
fn signature(&self) -> Signature {
Signature::build(self.name())
.optional("rows", SyntaxShape::Int, "Number of rows for tail")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/melt.rs
View File

@ -48,8 +48,10 @@ impl Command for MeltDF {
"optional name for value column",
Some('l'),
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/open.rs
View File

@ -68,8 +68,7 @@ impl Command for OpenDataFrame {
"Columns to be selected from csv file. CSV and Parquet file",
None,
)
.input_type(Type::Any)
.output_type(Type::Custom("dataframe".into()))
.input_output_type(Type::Any, Type::Custom("dataframe".into()))
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/query_df.rs
View File

@ -28,8 +28,10 @@ impl Command for QueryDf {
fn signature(&self) -> Signature {
Signature::build(self.name())
.required("sql", SyntaxShape::String, "sql query")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/rename.rs
View File

@ -33,8 +33,10 @@ impl Command for RenameDF {
SyntaxShape::Any,
"New names for the selected column(s). A string or list of strings",
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe or lazyframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/sample.rs
View File

@ -41,8 +41,10 @@ impl Command for SampleDF {
)
.switch("replace", "sample with replace", Some('e'))
.switch("shuffle", "shuffle sample", Some('u'))
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/shape.rs
View File

@ -22,8 +22,10 @@ impl Command for ShapeDF {
fn signature(&self) -> Signature {
Signature::build(self.name())
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/slice.rs
View File

@ -25,8 +25,10 @@ impl Command for SliceDF {
Signature::build(self.name())
.required("offset", SyntaxShape::Int, "start of slice")
.required("size", SyntaxShape::Int, "size of slice")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/summary.rs
View File

@ -29,8 +29,10 @@ impl Command for Summary {
fn signature(&self) -> Signature {
Signature::build(self.name())
.category(Category::Custom("dataframe".into()))
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.named(
"quantiles",
SyntaxShape::Table,

6
crates/nu-cmd-dataframe/src/dataframe/eager/take.rs
View File

@ -29,8 +29,10 @@ impl Command for TakeDF {
SyntaxShape::Any,
"list of indices used to take data",
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/to_arrow.rs
View File

@ -25,8 +25,7 @@ impl Command for ToArrow {
fn signature(&self) -> Signature {
Signature::build(self.name())
.required("file", SyntaxShape::Filepath, "file path to save dataframe")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Any)
.input_output_type(Type::Custom("dataframe".into()), Type::Any)
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/to_csv.rs
View File

@ -32,8 +32,7 @@ impl Command for ToCSV {
Some('d'),
)
.switch("no-header", "Indicates if file doesn't have header", None)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Any)
.input_output_type(Type::Custom("dataframe".into()), Type::Any)
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/to_df.rs
View File

@ -20,8 +20,7 @@ impl Command for ToDataFrame {
fn signature(&self) -> Signature {
Signature::build(self.name())
.input_type(Type::Any)
.output_type(Type::Custom("dataframe".into()))
.input_output_type(Type::Any, Type::Custom("dataframe".into()))
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/to_json_lines.rs
View File

@ -25,8 +25,7 @@ impl Command for ToJsonLines {
fn signature(&self) -> Signature {
Signature::build(self.name())
.required("file", SyntaxShape::Filepath, "file path to save dataframe")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Any)
.input_output_type(Type::Custom("dataframe".into()), Type::Any)
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/to_nu.rs
View File

@ -28,8 +28,7 @@ impl Command for ToNu {
Some('n'),
)
.switch("tail", "shows tail rows", Some('t'))
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Any)
.input_output_type(Type::Custom("dataframe".into()), Type::Any)
.category(Category::Custom("dataframe".into()))
}

3
crates/nu-cmd-dataframe/src/dataframe/eager/to_parquet.rs
View File

@ -25,8 +25,7 @@ impl Command for ToParquet {
fn signature(&self) -> Signature {
Signature::build(self.name())
.required("file", SyntaxShape::Filepath, "file path to save dataframe")
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Any)
.input_output_type(Type::Custom("dataframe".into()), Type::Any)
.category(Category::Custom("dataframe".into()))
}

6
crates/nu-cmd-dataframe/src/dataframe/eager/with_column.rs
View File

@ -27,8 +27,10 @@ impl Command for WithColumn {
SyntaxShape::Any,
"series to be added or expressions used to define the new columns",
)
.input_type(Type::Custom("dataframe".into()))
.output_type(Type::Custom("dataframe".into()))
.input_output_type(
Type::Custom("dataframe".into()),
Type::Custom("dataframe".into()),
)
.category(Category::Custom("dataframe or lazyframe".into()))
}