-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Allow timedelta to be converted to an ordinalf #9120
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
Conversation
@@ -474,3 +474,10 @@ def test_tz_utc(): | |||
def test_num2timedelta(x, tdelta): | |||
dt = mdates.num2timedelta(x) | |||
assert dt == tdelta | |||
|
|||
|
|||
def test_timedelta_ordinalf(): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a religious objection to this test. I don't believe that the private interface should be explicitly tested like this (this is in fact not possible in less permissive languages). You can see the various answers on this SO thread for a list of reasons why not.
I would suggest implementing some part of the public interface that uses this _tdelta_to_ordinalf(dt)
function and writing tests for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll try and put a proper plotting test with timedeltas in.
@@ -239,6 +239,17 @@ def _to_ordinalf(dt): | |||
_to_ordinalf_np_vectorized = np.vectorize(_to_ordinalf) | |||
|
|||
|
|||
def _tdelta_to_ordinalf(tdelta): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two objections:
-
Despite the superficial and subject matter similarities, I'm not convinced that
timedelta
is necessarily best handled indates.py
. Date-time instances are complicated because their natural domain is a line in a non-decimal, often non-monotonic number system with complicated unit system.timedelta
specifically, because it only handles durations whose length is invariant with translation along the number line, is effectively a convenience wrapper around an integer number of seconds, with almost none of the complexity ofdatetime
s. If there's a general units framework, I thinktimedelta
likely fits in there much better than lumping it in withdates.py
. I'm open to being convinced thattimedelta
works best indates.py
-
It's not clear to me why the base unit for this is ordinal days. They don't really need to be compatible with how datetimes are handled, and the more natural base unit would be some unit like seconds, microseconds, nanoseconds, etc.
np.timedelta64
has some complicated unit behavior, but the base type seems to be microseconds.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this has to be this way in order to be compatible with how we handle datetimes; the base unit has to the be the same if e.g. I want to plot something that has a timedelta
width on a datetime
axis.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem has come up again in #11290 - I see no reason to use ordinal days - we have to use something, and using ordinal days would make our lives much easier with respect to plotting widths/heights on datetime axes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't had a chance to really look at and grok how the units framework works. I suppose it's possible that units are inferred from type and that everything gets translated into a number under the hood and plotted on the same plot, in which context I guess defining any mapping from timedelta
to that single number line is fine because these things shouldn't be plotted at the same time but matplotlib
isn't enforcing that in any way.
That said, from some preliminary tests, plotting arbitrary non-datetime points on a datetime axis currently fails with a message like:
ValueError: view limit minimum -4.95 is less than 1 and is an invalid Matplotlib date value. This often happens if you pass a non-datetime value to an axis that has datetime units
Sounds like it's a mix of the two, where you could plot non-datetime values if you got them right (because it's not enforced), but it's unlikely enough to work that there's a dedicated error message for it.
I think the right course forward for #11290 is to finish the work started in #9072 of defining all spans as start + span
, such that types with relative but no absolute semantics or meaning (like datetime.timedelta
and dateutil.relativedelta
) don't cause errors.
80a7cbd
to
a79f336
Compare
a79f336
to
5429f1c
Compare
See #12863 for another implimentation of this.... |
#12863 didn't pass muster either, so this is still something that could be done if someone has the interest. OTOH, I'd thionk timedeltas should just be converted to some sort of float before plotting... |
@dstansby do you think this is still something folks would want? |
Yes, I do. It needs careful tests and checks, but would definitely be useful. Happy to try and dig it out in the next week or so. |
I actually don't really have time to pick this up at the moment. Will close the PR but leave the branch if anyone else wants to pick it up in their own PR. |
Replaces #8730 and is a part of fixing #8869