ENH: add rcParam for ConciseDate and interval_multiples

jklymak · jklymak · commit 0b05b77a8690 · 2020-04-05T09:23:21.000-07:00
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -1784,8 +1784,11 @@ class DateConverter(units.ConversionInterface):
     The 'unit' tag for such data is None or a tzinfo instance.
     """
 
-    @staticmethod
-    def axisinfo(unit, axis):
+    def __init__(self, interval_multiples=True):
+        self._interval_multiples = interval_multiples
+        super().__init__()
+
+    def axisinfo(self, unit, axis):
         """
         Return the `~matplotlib.units.AxisInfo` for *unit*.
 
@@ -1794,7 +1797,8 @@ def axisinfo(unit, axis):
         """
         tz = unit
 
-        majloc = AutoDateLocator(tz=tz)
+        majloc = AutoDateLocator(tz=tz,
+                                 interval_multiples=self._interval_multiples)
         majfmt = AutoDateFormatter(majloc, tz=tz)
         datemin = datetime.date(2000, 1, 1)
         datemax = datetime.date(2010, 1, 1)
@@ -1836,17 +1840,19 @@ class ConciseDateConverter(DateConverter):
     # docstring inherited
 
     def __init__(self, formats=None, zero_formats=None, offset_formats=None,
-                 show_offset=True):
+                 show_offset=True, interval_multiples=True):
         self._formats = formats
         self._zero_formats = zero_formats
         self._offset_formats = offset_formats
         self._show_offset = show_offset
+        self._interval_multiples = interval_multiples
         super().__init__()
 
     def axisinfo(self, unit, axis):
         # docstring inherited
         tz = unit
-        majloc = AutoDateLocator(tz=tz)
+        majloc = AutoDateLocator(tz=tz,
+                                 interval_multiples=self._interval_multiples)
         majfmt = ConciseDateFormatter(majloc, tz=tz, formats=self._formats,
                                       zero_formats=self._zero_formats,
                                       offset_formats=self._offset_formats,
@@ -1857,6 +1863,49 @@ def axisinfo(self, unit, axis):
                               default_limits=(datemin, datemax))
 
 
-units.registry[np.datetime64] = DateConverter()
-units.registry[datetime.date] = DateConverter()
-units.registry[datetime.datetime] = DateConverter()
+# The following is so that we can set the converter for dates
+# via the validator for the rcParams `date.converter` and
+# `date.interval_multiples`
+
+
+global _converter
+_conv_st = 'auto'
+global _int_mult
+_int_mult = True
+
+
+def _set_converter(s):
+    """Called by validator for rcParams date.converter"""
+    global _conv_st
+    _conv_st = s
+    _register_converters()
+
+
+def _set_int_mult(b):
+    """Called by validator for rcParams date.interval_multiples"""
+    global _int_mult
+    _int_mult = b
+    _register_converters()
+
+
+def _register_converters():
+    """
+    Helper to register the date converters when rcParams `date.converter` and
+    `date.interval_multiples` are changed.  Called by the helpers above.
+    """
+    global _conv_st
+    global _int_mult
+    if _conv_st == 'concise':
+        converter = ConciseDateConverter
+    else:
+        converter = DateConverter
+
+    interval_multiples = _int_mult
+    units.registry[np.datetime64] = converter(
+            interval_multiples=interval_multiples)
+    units.registry[datetime.date] = converter(
+            interval_multiples=interval_multiples)
+    units.registry[datetime.datetime] = converter(
+            interval_multiples=interval_multiples)
+
+# _register_converters()
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -154,6 +154,26 @@ def validate_bool_maybe_none(b):
         raise ValueError('Could not convert "%s" to bool' % b)
 
 
+def _validate_date_converter(s):
+    s = validate_string(s)
+    try:
+        import matplotlib.dates as mdates
+        mdates._set_converter(s)
+    except Exception as e:
+        pass
+
+
+def _validate_date_int_mult(s):
+    if s is None:
+        return
+    s = validate_bool(s)
+    try:
+        import matplotlib.dates as mdates
+        mdates._set_int_mult(s)
+    except Exception as e:
+        pass
+
+
 def _validate_tex_preamble(s):
     message = (
         f"Support for setting the 'text.latex.preamble' and 'pgf.preamble' "
@@ -1266,6 +1286,11 @@ def _convert_validator_spec(key, conv):
     'date.autoformatter.second': ['%H:%M:%S', validate_string],
     'date.autoformatter.microsecond': ['%M:%S.%f', validate_string],
 
+    # 'auto', 'concise', 'auto-noninterval'
+    'date.converter': ['auto', _validate_date_converter],
+    # for auto date locator, choose interval_multiples
+    'date.interval_multiples': [True, _validate_date_int_mult],
+
     #legend properties
     'legend.fancybox': [True, validate_bool],
     'legend.loc': ['best',
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -326,7 +326,7 @@
 #mathtext.sf:  sans
 #mathtext.tt:  monospace
 #mathtext.fallback: cm  # Select fallback font from ['cm' (Computer Modern), 'stix'
-                        # 'stixsans'] when a symbol can not be found in one of the 
+                        # 'stixsans'] when a symbol can not be found in one of the
                         # custom math fonts. Select 'None' to not perform fallback
                         # and replace the missing character by a dummy symbol.
 #mathtext.default: it  # The default font to use for math.
@@ -431,7 +431,10 @@
 #date.autoformatter.minute:      %d %H:%M
 #date.autoformatter.second:      %H:%M:%S
 #date.autoformatter.microsecond: %M:%S.%f
-
+## 'auto', 'concise':
+#date.converter:                 'auto'
+## For auto converter whether to use interval_multiples:
+#date.interval_multiples:         True
 
 ## ***************************************************************************
 ## * TICKS                                                                   *
