mirror of
https://github.com/nushell/nushell.git
synced 2025-08-03 12:37:55 +02:00
37bc922a67
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> This PR adds a number of math functions under a single `polars math` command that apply to one or more column expressions. Note, `polars math` currently resides in the new module dataframe/command/command/computation/math.rs. I'm open to alternative organization and naming suggestions. ```nushell Collection of math functions to be applied on one or more column expressions This is an incomplete implementation of the available functions listed here: https://docs.pola.rs/api/python/stable/reference/expressions/computation.html. The following functions are currently available: - abs - cos - dot <expression> - exp - log <base; default e> - log1p - sign - sin - sqrt Usage: > polars math <type> ...(args) Flags: -h, --help: Display the help message for this command Parameters: type <string>: Function name. See extra description for full list of accepted values ...args <any>: Extra arguments required by some functions Input/output types: ╭───┬────────────┬────────────╮ │ # │ input │ output │ ├───┼────────────┼────────────┤ │ 0 │ expression │ expression │ ╰───┴────────────┴────────────╯ Examples: Apply function to column expression > [[a]; [0] [-1] [2] [-3] [4]] | polars into-df | polars select [ (polars col a | polars math abs | polars as a_abs) (polars col a | polars math sign | polars as a_sign) (polars col a | polars math exp | polars as a_exp)] | polars collect ╭───┬───────┬────────┬────────╮ │ # │ a_abs │ a_sign │ a_exp │ ├───┼───────┼────────┼────────┤ │ 0 │ 0 │ 0 │ 1.000 │ │ 1 │ 1 │ -1 │ 0.368 │ │ 2 │ 2 │ 1 │ 7.389 │ │ 3 │ 3 │ -1 │ 0.050 │ │ 4 │ 4 │ 1 │ 54.598 │ ╰───┴───────┴────────┴────────╯ Specify arguments for select functions. See description for more information. > [[a]; [0] [1] [2] [4] [8] [16]] | polars into-df | polars select [ (polars col a | polars math log 2 | polars as a_base2)] | polars collect ╭───┬─────────╮ │ # │ a_base2 │ ├───┼─────────┤ │ 0 │ -inf │ │ 1 │ 0.000 │ │ 2 │ 1.000 │ │ 3 │ 2.000 │ │ 4 │ 3.000 │ │ 5 │ 4.000 │ ╰───┴─────────╯ Specify arguments for select functions. See description for more information. > [[a b]; [0 0] [1 1] [2 2] [3 3] [4 4] [5 5]] | polars into-df | polars select [ (polars col a | polars math dot (polars col b) | polars as ab)] | polars collect ╭───┬────────╮ │ # │ ab │ ├───┼────────┤ │ 0 │ 55.000 │ ╰───┴────────╯ ``` # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> No breaking changes. # 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` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` 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 > ``` --> Example tests were added to `polars math`. # 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. -->
111 lines
2.8 KiB
TOML
111 lines
2.8 KiB
TOML
[package]
|
|
authors = ["The Nushell Project Developers"]
|
|
description = "Nushell dataframe plugin commands based on polars."
|
|
edition = "2024"
|
|
license = "MIT"
|
|
name = "nu_plugin_polars"
|
|
repository = "https://github.com/nushell/nushell/tree/main/crates/nu_plugin_polars"
|
|
version = "0.104.2"
|
|
|
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
|
|
[[bin]]
|
|
name = "nu_plugin_polars"
|
|
bench = false
|
|
|
|
[lib]
|
|
bench = false
|
|
|
|
[dependencies]
|
|
nu-protocol = { path = "../nu-protocol", version = "0.104.2" }
|
|
nu-plugin = { path = "../nu-plugin", version = "0.104.2" }
|
|
nu-path = { path = "../nu-path", version = "0.104.2" }
|
|
nu-utils = { path = "../nu-utils", version = "0.104.2" }
|
|
|
|
# Potential dependencies for extras
|
|
chrono = { workspace = true, features = [
|
|
"std",
|
|
"unstable-locales",
|
|
], default-features = false }
|
|
chrono-tz = "0.10"
|
|
fancy-regex = { workspace = true }
|
|
indexmap = { version = "2.9" }
|
|
num = { version = "0.4" }
|
|
serde = { version = "1.0", features = ["derive"] }
|
|
sqlparser = { version = "0.53" }
|
|
polars-io = { version = "0.46", features = ["avro", "cloud", "aws"] }
|
|
polars-arrow = { version = "0.46" }
|
|
polars-ops = { version = "0.46", features = ["pivot", "cutqcut"] }
|
|
polars-plan = { version = "0.46", features = ["regex"] }
|
|
polars-utils = { version = "0.46" }
|
|
typetag = "0.2"
|
|
env_logger = "0.11.3"
|
|
log.workspace = true
|
|
uuid = { version = "1.16", features = ["v4", "serde"] }
|
|
|
|
# Do to a compile error with polars, this included to force the raw dependency
|
|
hashbrown = { version = "0.15", features = ["rayon", "serde"] }
|
|
|
|
# Cloud support
|
|
aws-config = { version = "1.5", features = ["sso"] }
|
|
aws-credential-types = "1.2"
|
|
tokio = { version = "1.45", features = ["full"] }
|
|
object_store = { version = "0.11", default-features = false }
|
|
url.workspace = true
|
|
|
|
[dependencies.polars]
|
|
features = [
|
|
"abs",
|
|
"arg_where",
|
|
"bigidx",
|
|
"checked_arithmetic",
|
|
"cloud",
|
|
"concat_str",
|
|
"cross_join",
|
|
"iejoin",
|
|
"csv",
|
|
"cum_agg",
|
|
"default",
|
|
"dtype-categorical",
|
|
"dtype-datetime",
|
|
"dtype-struct",
|
|
"dtype-decimal",
|
|
"dtype-i8",
|
|
"dtype-i16",
|
|
"dtype-u8",
|
|
"dtype-u16",
|
|
"dynamic_group_by",
|
|
"ipc",
|
|
"is_in",
|
|
"json",
|
|
"lazy",
|
|
"log",
|
|
"object",
|
|
"parquet",
|
|
"pivot",
|
|
"random",
|
|
"rolling_window",
|
|
"rows",
|
|
"round_series",
|
|
"serde",
|
|
"serde-lazy",
|
|
"sign",
|
|
"strings",
|
|
"string_to_integer",
|
|
"streaming",
|
|
"timezones",
|
|
"temporal",
|
|
"to_dummies",
|
|
"trigonometry",
|
|
]
|
|
optional = false
|
|
version = "0.46"
|
|
|
|
[dev-dependencies]
|
|
nu-cmd-lang = { path = "../nu-cmd-lang", version = "0.104.2" }
|
|
nu-engine = { path = "../nu-engine", version = "0.104.2" }
|
|
nu-parser = { path = "../nu-parser", version = "0.104.2" }
|
|
nu-command = { path = "../nu-command", version = "0.104.2" }
|
|
nu-plugin-test-support = { path = "../nu-plugin-test-support", version = "0.104.2" }
|
|
tempfile.workspace = true
|