Make DatetimeIndex timezone naive for compatibility with xarray/numpy engine #1343
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…upported by xarray): timezone information is removed without convertion. added associated tests
Codecov ReportBase: 93.89% // Head: 93.88% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #1343 +/- ##
==========================================
- Coverage 93.89% 93.88% -0.01%
==========================================
Files 78 78
Lines 8516 8510 -6
==========================================
- Hits 7996 7990 -6
Misses 520 520
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
hrzn
reviewed
Nov 9, 2022
This was referenced Apr 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1052 and #648. Xarray relies on numpy engine, which is not timezone aware. Causes issues for plotting and resampling.
Summary
When constructing a
TimeSeriesfrom apd.DataFrameor apd.Serieswith aDatetimeIndexcontaining timezone information, this attribute is dropped without conversion usingtz_localize(None)(conversion can causes shift in the timestamps, making the index invalid). The timezone information can be recovered by callingts.time_index.tz_localize(original_tz)prior to exporting the data.Other Information
The
DatetimeIndexnot used as index are silently converted to UTC by thepd.DataFrameconstructor without saving the timezone information. Thus, timezone aware dataset should use the time range as index to take advantage of the bugfix and avoid the error raised by theTimeSeriesconstructor due to index invalidity.In order to have the desired x-axis when plotting the
TimeSeries(with a timezone unawaretime_indexdue to the bugfix), the user can simply leverage the matplotlib.pyplotrcParams['timezone']parameter to automatically convert the time axis back to the original timezone.