Skip to content

Allow timedelta to be converted to a ordinalf #8730

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

Closed
wants to merge 2 commits into from

Conversation

dstansby
Copy link
Member

@dstansby dstansby commented Jun 7, 2017

This allows _to_ordinalf to handle python timedelta objects. This is a first step in solving #4916, where the problem is that it is currently not possible to convert a width into a ordinal.

e.g. the following now works with this PR, whereas delta being a timedelta object was a problem before:

import matplotlib.pyplot as plt
import matplotlib.patches as mpatch
from datetime import datetime, timedelta

start = datetime(2017, 1, 1, 0, 0, 0)
delta = timedelta(seconds=16)
patch = mpatch.Rectangle((start, 0),
                         delta, 1)
fig, ax = plt.subplots()
ax.add_patch(patch)
ax.set_xlim(start - delta, start + 2 * delta)
ax.set_ylim(-1, 2)
plt.show()

@tacaswell
Copy link
Member

Can you add a test for this?

@tacaswell tacaswell added this to the 2.1 (next point release) milestone Jun 9, 2017
@dstansby dstansby mentioned this pull request Jul 12, 2017
6 tasks
@dstansby dstansby mentioned this pull request Jul 24, 2017
@tacaswell
Copy link
Member

@dstansby This needs a rebase.

"""
# Convert to UTC
tzi = getattr(dt, 'tzinfo', None)
if tzi is not None:
dt = dt.astimezone(UTC)
tzi = UTC

if isinstance(dt, datetime.timedelta):
Copy link
Member

Choose a reason for hiding this comment

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

This seems like the wrong place to decide whether or not this is a timedelta. Despite both being about time, I think durations and points in time are very different things and should follow different code paths. Most of the date-handling stuff is simply not applicable to timedelta.

Copy link
Member

Choose a reason for hiding this comment

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

how else would you compute widths? It is a similar problem to temperatures. You can't simply convert a 5 degrees C temperature change into Fahrenheit temperature change (a big annoyance of mine when reading news articles that blindly injects unit conversions)

Copy link
Member

@pganssle pganssle Aug 21, 2017

Choose a reason for hiding this comment

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

@WeatherGod I expressed my reservations a bit more in this comment. timedelta is a weird animal in that you normally don't have separate units for x and delta-x, but in datetimes you do.

One problem with this as a solution to #4916 is that a corollary to #4916 is that (if I understand correctly) datetime could be used as a width in rect, which is just as wrong as timedelta failing to work (and this does not fix that problem).

I don't know enough about the way the width processing and unit framework to know what the right seam is, but I would think that the right place to do the type check would be earlier in the pipeline, when you still know whether this is supposed to be units of x or delta-x.

Copy link
Member

Choose a reason for hiding this comment

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

Another thing to note about this solution is that ideally the way this would work is that height and width would apply to the values in the initial units / types, if possible.

Consider that if the plot's width is calculated by adding width to dt_begin, you automatically get the ability to add dateutil.relativedelta.relativedelta objects as well (for example, relativedelta(weekday=MO(+3)) - the width being "from the initial value to three Mondays later). It's not high priority, but if you're solving this problem anyway, it's worth considering that leveraging the existing arithmetic framework for rich objects might be worth doing.

Copy link
Member

Choose a reason for hiding this comment

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

ooh, now that is an attractive option.

@pganssle
Copy link
Member

Is this supplanted by #9072?

@dstansby
Copy link
Member Author

dstansby commented Aug 25, 2017 via email

@pganssle
Copy link
Member

I think it should definitely be its own thing and not folded into dates like this. It's somewhat meaningful to wrap date, time and datetimetogether, buttimedelta` is another beast entirely.

@tacaswell tacaswell modified the milestones: 2.2 (next next feature release), 2.1 (next point release) Aug 26, 2017
@tacaswell
Copy link
Member

Moving this to 2.2 due to @pganssle 's concerns about the implementation.

@dstansby
Copy link
Member Author

Was easier to just open a new PR at #9120

@dstansby dstansby closed this Aug 29, 2017
@dstansby dstansby deleted the timedelta-ordinal branch November 22, 2017 14:01
@QuLogic QuLogic modified the milestones: needs sorting, v2.2.0 Feb 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants