Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Relax nanosecond datetime restriction in CF time decoding #9618

Open
wants to merge 142 commits into
base: main
Choose a base branch
from

Conversation

kmuehlbauer
Copy link
Contributor

@kmuehlbauer kmuehlbauer commented Oct 13, 2024

This is another attempt to resolve #7493. This goes a step further than #9580.

The idea of this PR is to automatically infer the needed resolutions for decoding/encoding and only keep the constraints pandas imposes ("s" - lowest resolution, "ns" - highest resolution). There is still the idea of a default resolution, but this should only take precedence if it doesn't clash with the automatic inference. This can be discussed, though. Update: I've implemented time-unit-kwarg a first try to have default resolution on decode, which will override the current inferred resolution only to higher resolution (eg. 's' -> 'ns'). To work towards #4490 the time decoding options (decode_time and use_cftime are bundled within CFDatetimeCoder which is distributed via decode_times kwarg. use_cftime-kwarg is deprecated.

For sanity checking, and also for my own good, I've created a documentation page on time-coding in the internal dev section. Any suggestions (especially grammar) or ideas for enhancements are much appreciated.

There still might be room for consolidation of functions/methods (mostly in coding/times.py), but I have to leave it alone for some days. I went down that rabbit hole and need to relax, too 😬.

Looking forward to get your insights here, @spencerkclark, @ChrisBarker-NOAA, @pydata/xarray.

Todo:

  • floating point handling
  • update decoding tests to iterate over time_units (where appropriate)
  • CFDatetimeCoder as input for decode_times kwarg
  • ...

@kmuehlbauer
Copy link
Contributor Author

Nice, mypy 1.12 is out and breaks our typing, 😭.

@TomNicholas
Copy link
Member

Nice, mypy 1.12 is out and breaks our typing, 😭

Can we pin it in the CI temporarily?

@TomNicholas TomNicholas mentioned this pull request Oct 14, 2024
4 tasks
@kmuehlbauer
Copy link
Contributor Author

Can we pin it in the CI temporarily?

Yes, 1.11.2 was the last version.

@kmuehlbauer kmuehlbauer force-pushed the any-time-resolution-2 branch from ca5050d to f7396cf Compare October 14, 2024 16:09
@kmuehlbauer kmuehlbauer marked this pull request as ready for review October 14, 2024 18:05
@kmuehlbauer
Copy link
Contributor Author

This is now ready for a first round of review. I think this is already in a quite usable state.

But no rush, this should be thoroughly tested.

@spencerkclark
Copy link
Member

Sounds good @kmuehlbauer! I’ll try and take an initial look this weekend.

@shoyer
Copy link
Member

shoyer commented Jan 5, 2025

I think I've fixed up all issues due to manually merging. Hopefully this is now in a consistent state. I'm not sure if this is good enough, or if I should just rebase/squash this on latest master? Any thoughts appreciated.

No need to rebase/squash manually! As long as this PR can be merged in GitHub, it will be squashed automatically

Copy link
Member

@spencerkclark spencerkclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kmuehlbauer for updating this—I tried to give it a first thorough look through. Some small suggestions, a few possible minor remaining issues, but I think the big picture is looking good!

doc/user-guide/time-series.rst Outdated Show resolved Hide resolved
doc/user-guide/time-series.rst Outdated Show resolved Hide resolved
doc/user-guide/weather-climate.rst Outdated Show resolved Hide resolved
doc/user-guide/weather-climate.rst Outdated Show resolved Hide resolved
doc/internals/time-coding.rst Outdated Show resolved Hide resolved
xarray/tests/test_variable.py Outdated Show resolved Hide resolved
xarray/tests/test_variable.py Outdated Show resolved Hide resolved
xarray/tests/test_variable.py Outdated Show resolved Hide resolved
xarray/tests/test_variable.py Outdated Show resolved Hide resolved
xarray/tests/test_variable.py Outdated Show resolved Hide resolved
@kmuehlbauer
Copy link
Contributor Author

I tried to give it a first thorough look through. Some small suggestions, a few possible minor remaining issues, but I think the big picture is looking good!

@spencerkclark Thanks very much for the extensive review! I've addressed as much of your comments and suggestions, added todo's to keep track of the remaining.

I'll work on your suggestions in time-coding.rst the next days.

Copy link
Contributor

@dcherian dcherian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing stuff, Kai!

doc/user-guide/time-series.rst Outdated Show resolved Hide resolved
doc/user-guide/weather-climate.rst Outdated Show resolved Hide resolved
xarray/tests/test_backends.py Outdated Show resolved Hide resolved
item = np.timedelta64(getattr(item, "value", item), "ns")
# from xarray 2025.01.1 xarray allows non-nanosecond resolution
# so we just convert to_numpy if possible
if hasattr(item, "to_numpy"):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand timedelta is datetime.timedelta which doesn't have a to_numpy attribute? Do we need a pd.Timedelta clause?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My indexing knowledge really lacks, so any suggestion would help. This construct was just to get the machinery running again.

@@ -1165,6 +1266,7 @@ def decode(self, variable: Variable, name: T_Name = None) -> Variable:

units = pop_to(attrs, encoding, "units")
transform = partial(decode_cf_timedelta, units=units)
# todo: check, if we can relax this one here, too
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems important

@@ -0,0 +1,440 @@
.. ipython:: python
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Thanks for writing this.

Would be good to stick some references to this material in https://xray--9618.org.readthedocs.build/en/9618/user-guide/time-series.html

@kmuehlbauer
Copy link
Contributor Author

@dcherian Thanks for taking another look here. I'm deep in the weeds to iron out the last remaining issues. Hope to fix this up until next week. 🤞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
9 participants