mirror of
https://github.com/nushell/nushell.git
synced 2025-06-08 11:06:55 +02:00
bdc7cdbcc4
<!-- 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 seeks to port the polars command `replace` (https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.replace.html) and `replace_strict` (https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.replace_strict.html). See examples below. Consequently, the current `polars replace` and `polars replace-all` have been renamed to `polars str-replace` and `polars str-replace-all` to bring their naming better in-line with `polars str-join` and related str commands. ```nushell Usage: > polars replace {flags} <old> (new) Flags: -h, --help: Display the help message for this command -s, --strict: Require that all values must be replaced or throw an error (ignored if `old` or `new` are expressions). -d, --default <any>: Set values that were not replaced to this value. If no default is specified, (default), an error is raised if any values were not replaced. Accepts expression input. Non-expression inputs are parsed as literals. -t, --return-dtype <string>: Data type of the resulting expression. If set to `null` (default), the data type is determined automatically based on the other inputs. Parameters: old <one_of(record, list<any>)>: Values to be replaced new <list<any>>: Values to replace by (optional) Input/output types: ╭───┬────────────┬────────────╮ │ # │ input │ output │ ├───┼────────────┼────────────┤ │ 0 │ expression │ expression │ ╰───┴────────────┴────────────╯ Examples: Replace column with different values of same type > [[a]; [1] [1] [2] [2]] | polars into-df | polars select (polars col a | polars replace [1 2] [10 20]) | polars collect ╭───┬────╮ │ # │ a │ ├───┼────┤ │ 0 │ 10 │ │ 1 │ 10 │ │ 2 │ 20 │ │ 3 │ 20 │ ╰───┴────╯ Replace column with different values of another type > [[a]; [1] [1] [2] [2]] | polars into-df | polars select (polars col a | polars replace [1 2] [a b] --strict) | polars collect ╭───┬───╮ │ # │ a │ ├───┼───┤ │ 0 │ a │ │ 1 │ a │ │ 2 │ b │ │ 3 │ b │ ╰───┴───╯ Replace column with different values based on expressions (cannot be used with strict) > [[a]; [1] [1] [2] [2]] | polars into-df | polars select (polars col a | polars replace [(polars col a | polars max)] [(polars col a | polars max | $in + 5)]) | polars collect ╭───┬───╮ │ # │ a │ ├───┼───┤ │ 0 │ 1 │ │ 1 │ 1 │ │ 2 │ 7 │ │ 3 │ 7 │ ╰───┴───╯ Replace column with different values based on expressions with default > [[a]; [1] [1] [2] [3]] | polars into-df | polars select (polars col a | polars replace [1] [10] --default (polars col a | polars max | $in * 100) --strict) | polars collect ╭───┬─────╮ │ # │ a │ ├───┼─────┤ │ 0 │ 10 │ │ 1 │ 10 │ │ 2 │ 300 │ │ 3 │ 300 │ ╰───┴─────╯ Replace column with different values based on expressions with default > [[a]; [1] [1] [2] [3]] | polars into-df | polars select (polars col a | polars replace [1] [10] --default (polars col a | polars max | $in * 100) --strict --return-dtype str) | polars collect ╭───┬─────╮ │ # │ a │ ├───┼─────┤ │ 0 │ 10 │ │ 1 │ 10 │ │ 2 │ 300 │ │ 3 │ 300 │ ╰───┴─────╯ Replace column with different values using a record > [[a]; [1] [1] [2] [2]] | polars into-df | polars select (polars col a | polars replace {1: a, 2: b} --strict --return-dtype str) | polars collect ╭───┬───╮ │ # │ a │ ├───┼───┤ │ 0 │ a │ │ 1 │ a │ │ 2 │ b │ │ 3 │ b │ ╰───┴───╯ ``` # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> **BREAKING CHANGE**: `polars replace` and `polars replace-all` have been renamed to `polars str-replace` and `polars str-replace-all`. The new `polars replace` now replaces elements in a series/column rather than patterns within strings. # 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. # 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. -->
Nushell core libraries and plugins
These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.
Foundational libraries are split into two kinds of crates:
- Core crates - those crates that work together to build the Nushell language engine
- Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.
Plugins are likewise also split into two types:
- Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
- Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.