nushell/crates
pyz4 669b44ad7d
feat(polars): add polars truncate for rounding datetimes (#15582)
<!--
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 directly ports the polars function `polars.Expr.dt.truncate`
(https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.dt.truncate.html),
which rounds a datetime to an arbitrarily specified period length. This
function is particularly useful when rounding to variable period lengths
such as months or quarters. See below for examples.

```nushell
#  Truncate a series of dates by period length
  > seq date -b 2025-01-01 --periods 4 --increment 6wk -o "%Y-%m-%d %H:%M:%S" | polars into-df | polars as-datetime "%F %H:%M:%S" --naive | polars select datetime (polars col datetime | polars truncate 5d37m | polars as truncated) | polars collect
  ╭───┬───────────────────────┬───────────────────────╮
  │ # │       datetime        │       truncated       │
  ├───┼───────────────────────┼───────────────────────┤
  │ 0 │ 01/01/2025 12:00:00AM │ 12/30/2024 04:49:00PM │
  │ 1 │ 02/12/2025 12:00:00AM │ 02/08/2025 09:45:00PM │
  │ 2 │ 03/26/2025 12:00:00AM │ 03/21/2025 02:41:00AM │
  │ 3 │ 05/07/2025 12:00:00AM │ 05/05/2025 08:14:00AM │
  ╰───┴───────────────────────┴───────────────────────╯

#  Truncate based on period length measured in quarters and months
> seq date -b 2025-01-01 --periods 4 --increment 6wk -o "%Y-%m-%d %H:%M:%S" | polars into-df | polars as-datetime "%F %H:%M:%S" --naive | polars select datetime (polars col datetime | polars truncate 1q5mo | polars as truncated) | polars collect
╭───┬───────────────────────┬───────────────────────╮
│ # │       datetime        │       truncated       │
├───┼───────────────────────┼───────────────────────┤
│ 0 │ 01/01/2025 12:00:00AM │ 09/01/2024 12:00:00AM │
│ 1 │ 02/12/2025 12:00:00AM │ 09/01/2024 12:00:00AM │
│ 2 │ 03/26/2025 12:00:00AM │ 09/01/2024 12:00:00AM │
│ 3 │ 05/07/2025 12:00:00AM │ 05/01/2025 12:00:00AM │
╰───┴───────────────────────┴───────────────────────╯

```

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
No breaking changes. This PR introduces a new command `polars truncate`

# 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 test was 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.
-->
2025-04-16 14:17:49 -07:00
..
nu_plugin_custom_values Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_example Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_formats Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_gstat Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_inc Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_javascript create nu_plugin_node_example.js (#15482) 2025-04-11 21:18:46 +02:00
nu_plugin_nu_example Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_polars feat(polars): add polars truncate for rounding datetimes (#15582) 2025-04-16 14:17:49 -07:00
nu_plugin_python Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_query bump to the latest rust version (#15483) 2025-04-03 21:08:59 +02:00
nu_plugin_stress_internals Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-cli fix(lsp): a panic caused by completion with decl_id out of range (#15576) 2025-04-16 06:43:21 -05:00
nu-cmd-base Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-cmd-extra Replace some PipelineMismatch by OnlySupportsThisInputType by shell error (#15447) 2025-04-07 12:25:27 +02:00
nu-cmd-lang update shadow-rs to version 1 (#15462) 2025-04-03 14:08:51 +02:00
nu-cmd-plugin Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-color-config Rename user-facing 'date' to 'datetime' (#15264) 2025-03-21 13:36:21 -04:00
nu-command build(deps): bump data-encoding from 2.8.0 to 2.9.0 (#15580) 2025-04-16 22:14:36 +08:00
nu-derive-value Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-engine Fix clippy (#15489) 2025-04-06 09:49:28 +08:00
nu-explore Fix clippy (#15489) 2025-04-06 09:49:28 +08:00
nu-glob Remove nu-glob's dependency on nu-protocol (#15349) 2025-03-20 17:32:41 +01:00
nu-json Fix future clippy lints (#15519) 2025-04-08 08:51:12 +08:00
nu-lsp fix(lsp): a panic caused by completion with decl_id out of range (#15576) 2025-04-16 06:43:21 -05:00
nu-parser Fix Exbibyte parsing (#15515) 2025-04-07 13:36:23 +02:00
nu-path Fix clippy (#15489) 2025-04-06 09:49:28 +08:00
nu-plugin Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-plugin-core Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-plugin-engine Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-plugin-protocol Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-plugin-test-support Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-pretty-hex Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-protocol refactor(completion, lsp): include decl_id in suggetion_kind for later usage (#15536) 2025-04-15 07:24:56 -05:00
nu-std try to fix datetime-diff for ms, us, ns (#15537) 2025-04-10 06:52:11 -05:00
nu-system Fix future clippy lints (#15519) 2025-04-08 08:51:12 +08:00
nu-table replace repeat().take() with repeat_n() (#15575) 2025-04-15 23:29:32 +08:00
nu-term-grid Fix clippy (#15489) 2025-04-06 09:49:28 +08:00
nu-test-support Remove nu-glob's dependency on nu-protocol (#15349) 2025-03-20 17:32:41 +01:00
nu-utils Substring Match Algorithm (#15511) 2025-04-11 05:15:36 -04:00
nuon Fix to nuon --serialize of closure (#15357) 2025-03-20 17:50:36 +01:00
README.md Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00

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.