ENH: add rcParam for ConciseDate and interval_multiples by jklymak · Pull Request #17022 · matplotlib/matplotlib

jklymak · 2020-04-03T23:36:24Z

PR Summary

This is a proposal for two new date rcParam entries:

date.converter which takes a string. If its 'concise' then mdates.ConciseDateConverter is used for dates, otherwise mdates.AutoDateConverter is used (as before). Default is the same as before: 'auto'

date.interval_multiples sets whether 'interval_multiples' is used (True by default) for the auto locators.

~~Note this needs a new mdates.register_converters to work after matplotlib.dates has been imported by matplotlib.pyplot.~~ EDIT: fixed to allow automatic changing of the rcParams....

import matplotlib
import datetime
import matplotlib.pyplot as plt
import matplotlib.dates as mdates


y = range(43)
datex = [datetime.date(2020,2,21)+datetime.timedelta(x) for x in range(43)]
fig, axs = plt.subplots(2, 2, constrained_layout=True, figsize=(6,7))

for m, converter in enumerate(['auto', 'concise']):
    for n, interval_multiples in enumerate([True, False]):

        plt.rcParams['date.converter'] = converter
        plt.rcParams['date.interval_multiples'] = interval_multiples
        ax = axs[m, n]
        ax.plot(datex, y)
        if m == 0:
            ax.xaxis.set_tick_params(rotation=45)
plt.show()

Needs tests and a what's new...

PR Checklist

Has Pytest style unit tests
Code is Flake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

anntzer · 2020-04-03T23:40:21Z

-units.registry[datetime.date] = DateConverter()
-units.registry[datetime.datetime] = DateConverter()
+
+def register_converters():


This logic should really be in a _validate_date_converter validator, no? otherwise that means that setting the rcParam from anywhere but the matplotlibrc would have no effect.
(And yes, that means we may either need to try to import matplotlib.dates in rcsetup, or, if that's not possible, special case initial import time and re-validate once we import matplotlib.dates).

Does a validator get called every time the rcParam dict is updated? I guess that would be a good way to do that, if a little magical.

Is there an easy way to tell if the validation is the initial one or a subsequent one? Because if not, I'm not convinced this is worth the bother.

tacaswell · 2020-04-03T23:44:47Z

I agree this seems reasonable, but share @anntzer 's concern that as written it won't trigger when the rcparams are changed.

jklymak · 2020-04-04T21:08:08Z

Unless someone has a straightforward way to update the converter during the init of the rcParams without importing datetime, I'm not convinced the magic of being able to change the rcParam on the fly is worthwhile. People can just call the new mdates.set_converters if they need to change the rcParams during a script.

anntzer · 2020-04-04T22:32:41Z

ok, but in that case you need at least to block updating of the rcParam once matplotlib is imported (again, with a custom validator) (and even then I doubt I'd accept the feature). I don't like that solution but I think it's expected (well, at least I expect) that setting a variable in the matplotlibrc is equivalent to setting it in python code, so if it's not at least it should error out cleanly.

jklymak · 2020-04-04T22:49:44Z

Well again is there an easy way to know if the validator is being run for first time? If not I don’t see how this can work.

Frankly I think the magic imbued in rcParams is needlessly complicated and we should not think of it as something that must allow real time toggles for everything.

anntzer · 2020-04-04T22:52:58Z

It's not so much called once as called from the matplotlibrc, I'm sure the right amount of stack walking could work.
I agree the rcparams magic is a pain, but I feel fairly strongly that rcParams["foo"] = "bar" should behave like foo: bar in your matplotlibrc.
Or, to look at it differently: the current design wouldn't work if the rcparam was set in a style file either.

jklymak · 2020-04-05T01:19:40Z

OK, not ridiculously ugly. I just bail if the matplotlib.dates import fails...

anntzer · 2020-04-05T10:22:56Z

Much better :)

jklymak · 2020-06-19T04:21:12Z

... I forgot about this one. Its now rebased and should be ready for review...

anntzer · 2020-06-20T11:13:25Z

+
+class _rcParam_helper:
+    """
+    Never instatiated, but manages the rcParams for dates...


perhaps merge the comment above and the docstring...

anntzer · 2020-06-20T11:13:49Z

+            converter = DateConverter
+
+        interval_multiples = cls.int_mult
+        print(interval_multiples)


remove this?

anntzer · 2020-06-20T11:14:17Z

+
+        interval_multiples = cls.int_mult
+        print(interval_multiples)
+        units.registry[np.datetime64] = converter(


perhaps just instantiate a single converter and assign to all 3?

... I guess so? the old code instantiated three converters, so I'm a little hesitant. OTOH, I'm not sure why it did, and I don't think we lose any flexibility this way...

anntzer · 2020-06-20T11:14:37Z

+    try:
+        import matplotlib.dates as mdates
+        mdates._rcParam_helper.set_converter(s)
+    except Exception as e:


add a comment that this can only fail at initial import time?

Yeah - so this gives me a bit of pause. Does this cause any import slowdowns?

I guess you could write mdates = sys.modules.get("matplotlib.dates"); if mdates: ... as matplotlib.dates will be in sys.modules once everything is set up properly...

Thanks, I prefer that....

@jklymak do you still want to change how this is written?

anntzer

Needs perhaps a few comments/docstring fixes, but other than that looks fine to me.

jklymak

Add doc in ConciseDateFormatter

tacaswell

Modulo a example with a plot in the whats new.

anntzer · 2020-06-22T19:37:05Z


    def __init__(self, formats=None, zero_formats=None, offset_formats=None,
-                 show_offset=True):
+                 show_offset=True, interval_multiples=True):


anntzer · 2020-06-22T19:37:12Z


-    @staticmethod
-    def axisinfo(unit, axis):
+    def __init__(self, interval_multiples=True):


jklymak · 2020-06-25T15:41:22Z

+  plt.rcParams['date.converter'] = 'auto'
+  plt.rcParams['date.interval_multiples'] = False
+  ax = axs[1]
+  ax.plot(dates, y)


~~This renders as https://39494-1385122-gh.circle-artifacts.com/0/doc/build/html/users/next_whats_new/rcparams_dates.html I'm forgetting how to get the plot to show in the docs?~~ OK figured it out

jklymak · 2020-06-25T19:42:31Z

New Whats new w example: https://39836-1385122-gh.circle-artifacts.com/0/doc/build/html/users/next_whats_new/rcparams_dates.html

tacaswell

Still approve, leave it to @jklymak if we should change how the conditional import is done.

Anyone can merge.

jklymak · 2020-06-26T04:34:47Z

Still approve, leave it to @jklymak if we should change how the conditional import is done.

Anyone can merge.

Ooops, duh - I missed one of the two cases. Thanks for pointing that out.

jklymak added the topic: date handling label Apr 3, 2020

jklymak requested a review from ImportanceOfBeingErnest April 3, 2020 23:36

anntzer reviewed Apr 3, 2020

View reviewed changes

tacaswell added this to the v3.3.0 milestone Apr 3, 2020

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from 1a6da7b to 0b05b77 Compare April 5, 2020 16:23

dstansby added the status: work in progress label Apr 19, 2020

jklymak mentioned this pull request Apr 30, 2020

Discuss: Date handling issues and ideas #15018

Closed

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from d22ebe4 to f2a84b1 Compare April 30, 2020 18:15

QuLogic modified the milestones: v3.3.0, v3.4.0 May 5, 2020

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from f2a84b1 to e4c7774 Compare June 19, 2020 04:20

jklymak marked this pull request as ready for review June 19, 2020 04:20

jklymak added topic: rcparams and removed status: work in progress labels Jun 19, 2020

jklymak removed the request for review from ImportanceOfBeingErnest June 19, 2020 14:40

anntzer reviewed Jun 19, 2020

View reviewed changes

Comment thread lib/matplotlib/dates.py Resolved

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from 6cb6516 to 22923c5 Compare June 19, 2020 23:45

anntzer reviewed Jun 20, 2020

View reviewed changes

anntzer approved these changes Jun 20, 2020

View reviewed changes

jklymak force-pushed the enh-rcparams-concisedate-intervals branch 2 times, most recently from 6b6f120 to 2cdcfe7 Compare June 20, 2020 15:54

jklymak commented Jun 22, 2020

View reviewed changes

tacaswell approved these changes Jun 22, 2020

View reviewed changes

anntzer reviewed Jun 22, 2020

View reviewed changes

jklymak commented Jun 25, 2020

View reviewed changes

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from dfd8924 to 4f29425 Compare June 25, 2020 15:45

tacaswell approved these changes Jun 26, 2020

View reviewed changes

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from 4f29425 to abc06c5 Compare June 26, 2020 04:34

timhoffm added the status: needs rebase label Jul 4, 2020

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from abc06c5 to 610f5fb Compare July 6, 2020 17:02

jklymak removed the status: needs rebase label Jul 6, 2020

ENH: add rcParam for ConciseDate and interval_multiples

a793bde

jklymak force-pushed the enh-rcparams-concisedate-intervals branch from 610f5fb to a793bde Compare July 7, 2020 05:16

tacaswell merged commit 7ed6bc2 into matplotlib:master Jul 7, 2020

jklymak deleted the enh-rcparams-concisedate-intervals branch July 7, 2020 17:14

dstansby mentioned this pull request Jul 9, 2020

datetime plotting broken on master #17867

Closed

jklymak mentioned this pull request Jul 9, 2020

FIX: new date rcParams weren't being evaluated #17869

Merged

6 tasks

tacaswell mentioned this pull request Apr 23, 2021

add legend.labelcolor "argument" to mplstyle stylesheet #20049

Closed

Conversation

jklymak commented Apr 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Apr 3, 2020

Uh oh!

jklymak commented Apr 4, 2020

Uh oh!

anntzer commented Apr 4, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jklymak commented Apr 4, 2020

Uh oh!

anntzer commented Apr 4, 2020

Uh oh!

jklymak commented Apr 5, 2020

Uh oh!

anntzer commented Apr 5, 2020

Uh oh!

jklymak commented Jun 19, 2020

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer left a comment

Choose a reason for hiding this comment

Uh oh!

jklymak left a comment

Choose a reason for hiding this comment

Uh oh!

tacaswell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jklymak Jun 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jklymak commented Jun 25, 2020

Uh oh!

tacaswell left a comment

Choose a reason for hiding this comment

Uh oh!

jklymak commented Jun 26, 2020

Uh oh!

jklymak commented Apr 3, 2020 •

edited

Loading

anntzer commented Apr 4, 2020 •

edited

Loading

jklymak Jun 25, 2020 •

edited

Loading