Fix add_vline and add_hline with datetime axes#5508
Open
mosh3eb wants to merge 1 commit intoplotly:mainfrom
Open
Fix add_vline and add_hline with datetime axes#5508mosh3eb wants to merge 1 commit intoplotly:mainfrom
mosh3eb wants to merge 1 commit intoplotly:mainfrom
Conversation
Contributor
|
Thanks for the contribution @mosh3eb ! This approach won't work because the |
Instead of assuming input values are equal, _mean() now converts datetime-like values (date strings and datetime objects) to milliseconds-since-epoch, computes the actual arithmetic mean, and converts back. This correctly handles annotation placement for ALL shapes (vlines, hlines, vrects, hrects) with datetime axes. The numeric fast path is unchanged — datetime handling only activates when sum() raises TypeError on non-numeric types. Added tests for datetime strings, datetime objects, and rects with different x0/x1 values on datetime axes. Fixes plotly#3065
c580b1f to
9bed9d3
Compare
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.
Summary
When using add_vline, add_hline,
add_vrect, oradd_hrectwithannotation_texton datetime axes, plotly crashes with aTypeErrorbecause the _mean() helper function tries to callfloat(sum(x))on datetime strings.Approach
Instead of assuming input values are equal (which only works for vlines/hlines), _mean() now converts datetime-like values to milliseconds-since-epoch, computes the actual arithmetic mean, and converts back. This correctly handles annotation placement for ALL shapes with datetime axes, including rects where
x0 != x1.sum()raisesTypeError"2018-09-24") anddatetime.datetimeobjectsTypeErrorfor truly unsupported typesChanges
Fixes #3065