nushell/crates
pyz4 7ca2a6f8ac
FIX polars as-datetime: ignores timezone information on conversion (#15490)
# Description
This PR seeks to fix an error in `polars as-datetime` where timezone
information is entirely ignored. This behavior raises a host of silent
errors when dealing with datetime conversions (see example below).

## Current Implementation
Timezones are entirely ignored and datetimes with different timezones
are converted to the same naive datetimes even when the user
specifically indicates that the timezone should be parsed. For example,
"2021-12-30 00:00:00 +0000" and "2021-12-30 00:00:00 -0400" will both be
parsed to "2021-12-30 00:00:00" even when the format string specifically
includes "%z".

```
$ ["2021-12-30 00:00:00 +0000" "2021-12-30 00:00:00 -0400"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S %z"
╭───┬───────────────────────╮
│ # │       datetime        │
├───┼───────────────────────┤
│ 0 │ 12/30/2021 12:00:00AM │ 
│ 1 │ 12/30/2021 12:00:00AM │ <-- Same datetime even though the first is +0000 and second is -0400
╰───┴───────────────────────╯

$ ["2021-12-30 00:00:00 +0000" "2021-12-30 00:00:00 -0400"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S %z" | polars schema
╭──────────┬──────────────╮
│ datetime │ datetime<ns> │
╰──────────┴──────────────╯
```

## New Implementation
Datetimes are converted to UTC and timezone information is retained.

```
$ "2021-12-30 00:00:00 +0000" "2021-12-30 00:00:00 -0400"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S %z"
╭───┬───────────────────────╮
│ # │       datetime        │
├───┼───────────────────────┤
│ 0 │ 12/30/2021 12:00:00AM │
│ 1 │ 12/30/2021 04:00:00AM │ <-- Converted to UTC
╰───┴───────────────────────╯

$ ["2021-12-30 00:00:00 +0000" "2021-12-30 00:00:00 -0400"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S %z" | polars schema
╭──────────┬───────────────────╮
│ datetime │ datetime<ns, UTC> │
╰──────────┴───────────────────╯
```

The user may intentionally ignore timezone information by setting the
`--naive` flag.
```
$ ["2021-12-30 00:00:00 +0000" "2021-12-30 00:00:00 -0400"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S %z" --naive
╭───┬───────────────────────╮
│ # │       datetime        │
├───┼───────────────────────┤
│ 0 │ 12/30/2021 12:00:00AM │
│ 1 │ 12/30/2021 12:00:00AM │ <-- the -0400 offset is ignored when --naive is set
╰───┴───────────────────────╯

$ ["2021-12-30 00:00:00 +0000" "2021-12-30 00:00:00 -0400"] | polars into-df | polars as-datetime "%Y-%m-%d %H:%M:%S %z" --naive | polars schema
╭──────────┬──────────────╮
│ datetime │ datetime<ns> │
╰──────────┴──────────────╯
```

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
`polars as-datetime` will now account for timezone information and
return type `datetime<ns,UTC>` rather than `datetime<ns>` by default.
The user can replicate the previous behavior by setting `--naive`.

# 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
> ```
-->
Tests that incorporated `polars as-datetime` had to be tweaked to
include `--naive` flag to replicate previous behavior.

# 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-04 09:43:21 -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_nu_example Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu_plugin_polars FIX polars as-datetime: ignores timezone information on conversion (#15490) 2025-04-04 09:43:21 -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 refactor: command identified by name instead of span content (#15471) 2025-04-02 13:12:38 +02:00
nu-cmd-base Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-cmd-extra Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04: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 Consider PATH when running command is nuscript in windows (#15486) 2025-04-04 06:35:36 -05:00
nu-derive-value Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-engine reset argument/redirection state after eval_call errors (#15400) 2025-03-26 19:41:16 -04:00
nu-explore fix(explore): do not create extra layer for empty entries (#15367) 2025-03-20 06:53:06 -05:00
nu-glob Remove nu-glob's dependency on nu-protocol (#15349) 2025-03-20 17:32:41 +01:00
nu-json Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-lsp refactor: command identified by name instead of span content (#15471) 2025-04-02 13:12:38 +02:00
nu-parser fix(parser): skip eval_const if parsing errors detected to avoid panic (#15364) 2025-03-26 15:02:26 +01:00
nu-path bump to the latest rust version (#15483) 2025-04-03 21:08:59 +02: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: ensure range is bounded (#15429) 2025-03-27 14:25:55 +01:00
nu-std Fixes clip copy stripping control characters when de-ansifying (#15428) 2025-03-28 19:15:17 -04:00
nu-system add more columns to macos ps -l (#15341) 2025-03-20 09:53:19 -05:00
nu-table Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-term-grid Bump to 0.103.1 dev version (#15347) 2025-03-19 00:12:01 -04:00
nu-test-support Remove nu-glob's dependency on nu-protocol (#15349) 2025-03-20 17:32:41 +01:00
nu-utils Fix typo in doc_config.nu + small description (#15461) 2025-03-31 21:38:50 +02: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.