GH-45644: [Doc][Python] Document timezone loss when converting timestamp arrays to NumPy#49843
Open
alex-anast wants to merge 1 commit intoapache:mainfrom
Open
GH-45644: [Doc][Python] Document timezone loss when converting timestamp arrays to NumPy#49843alex-anast wants to merge 1 commit intoapache:mainfrom
alex-anast wants to merge 1 commit intoapache:mainfrom
Conversation
…timestamp arrays to NumPy
|
|
|
|
This file contains hidden or 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
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.
Rationale for this change
NumPy's
datetime64type does not support timezones. When converting a timezone-aware Arrow timestamp array to NumPy viato_numpy(), the timezone information is silently dropped. This behaviour is expected but undocumented, which can surprise users (see #45644).What changes are included in this PR?
Adds a "Timezone-aware Timestamps" subsection to
docs/source/python/numpy.rstthat:to_numpy()on tz-aware timestamp arraysto_pandas()for tz-aware Series, andto_pylist()for Pythondatetimeobjects withtzinfoAre these changes tested?
Documentation-only change. All code examples were verified against pyarrow 24.0.0 and
sphinx-lintpasses clean.Are there any user-facing changes?
No behaviour changes. This adds documentation for existing behaviour.
to_numpy#45644Closes [Doc][Python] Timestamp with tz loses its time zone after
to_numpy#45644