Merge pull request #14573 from anntzer/jpl

tacaswell · web-flow · commit b1ae81c740cc · 2019-06-23T18:05:42.000-04:00
MNT: Cleanup jpl_units.
diff --git a/doc/api/next_api_changes/2019-06-18-AL.rst b/doc/api/next_api_changes/2019-06-18-AL.rst
@@ -0,0 +1,4 @@
+Deprecations
+````````````
+
+``testing.jpl_units.UnitDbl.UnitDbl.checkUnits`` is deprecated.
diff --git a/lib/matplotlib/testing/jpl_units/Duration.py b/lib/matplotlib/testing/jpl_units/Duration.py
@@ -2,6 +2,8 @@
 
 import operator
 
+from matplotlib import cbook
+
 
 class Duration:
     """Class Duration in development.
@@ -18,11 +20,7 @@ def __init__(self, frame, seconds):
         - frame     The frame of the duration.  Must be 'ET' or 'UTC'
         - seconds  The number of seconds in the Duration.
         """
-        if frame not in self.allowed:
-            msg = "Input frame '%s' is not one of the supported frames of %s" \
-                    % (frame, str(self.allowed))
-            raise ValueError(msg)
-
+        cbook._check_in_list(self.allowed, frame=frame)
         self._frame = frame
         self._seconds = seconds
 
@@ -176,7 +174,7 @@ def checkSameFrame(self, rhs, func):
         - func    The name of the function doing the check.
         """
         if self._frame != rhs._frame:
-            msg = "Cannot %s Duration's with different frames.\n" \
-                    "LHS: %s\n" \
-                    "RHS: %s" % (func, self._frame, rhs._frame)
-            raise ValueError(msg)
+            raise ValueError(
+                f"Cannot {func} Durations with different frames.\n"
+                f"LHS: {self._frame}\n"
+                f"RHS: {rhs._frame}")
diff --git a/lib/matplotlib/testing/jpl_units/Epoch.py b/lib/matplotlib/testing/jpl_units/Epoch.py
@@ -3,6 +3,8 @@
 import operator
 import math
 import datetime as DT
+
+from matplotlib import cbook
 from matplotlib.dates import date2num
 
 
@@ -56,11 +58,7 @@ def __init__(self, frame, sec=None, jd=None, daynum=None, dt=None):
                 "dnum= %s\n"
                 "dt  = %s" % (sec, jd, daynum, dt))
 
-        if frame not in self.allowed:
-            raise ValueError(
-                "Input frame '%s' is not one of the supported frames of %s" %
-                (frame, list(self.allowed.keys())))
-
+        cbook._check_in_list(self.allowed, frame=frame)
         self._frame = frame
 
         if dt is not None:
diff --git a/lib/matplotlib/testing/jpl_units/EpochConverter.py b/lib/matplotlib/testing/jpl_units/EpochConverter.py
@@ -99,8 +99,7 @@ def convert(value, unit, axis):
 
         if not cbook.is_scalar_or_string(value):
             return [EpochConverter.convert(x, unit, axis) for x in value]
-        if (units.ConversionInterface.is_numlike(value)
-                and not isinstance(value, (U.Epoch, U.Duration))):
+        if units.ConversionInterface.is_numlike(value):
             return value
         if unit is None:
             unit = EpochConverter.default_units(value, axis)
diff --git a/lib/matplotlib/testing/jpl_units/UnitDbl.py b/lib/matplotlib/testing/jpl_units/UnitDbl.py
@@ -2,6 +2,8 @@
 
 import operator
 
+from matplotlib import cbook
+
 
 class UnitDbl:
     """Class UnitDbl in development.
@@ -45,8 +47,7 @@ def __init__(self, value, units):
         - value     The numeric value of the UnitDbl.
         - units     The string name of the units the value is in.
         """
-        self.checkUnits(units)
-
+        cbook._check_in_list(self.allowed, units=units)
         data = self.allowed[units]
         self._value = float(value * data[0])
         self._units = data[1]
@@ -66,17 +67,13 @@ def convert(self, units):
         """
         if self._units == units:
             return self._value
-
-        self.checkUnits(units)
-
+        cbook._check_in_list(self.allowed, units=units)
         data = self.allowed[units]
         if self._units != data[1]:
-            msg = "Error trying to convert to different units.\n" \
-                    "    Invalid conversion requested.\n" \
-                    "    UnitDbl: %s\n" \
-                    "    Units:    %s\n" % (str(self), units)
-            raise ValueError(msg)
-
+            raise ValueError(f"Error trying to convert to different units.\n"
+                             f"    Invalid conversion requested.\n"
+                             f"    UnitDbl: {self}\n"
+                             f"    Units:   {units}\n")
         return self._value / data[0]
 
     def __abs__(self):
@@ -236,6 +233,7 @@ def range(start, stop, step=None):
 
         return elems
 
+    @cbook.deprecated("3.2")
     def checkUnits(self, units):
         """Check to see if some units are valid.
 
@@ -262,7 +260,6 @@ def checkSameUnits(self, rhs, func):
         - func    The name of the function doing the check.
         """
         if self._units != rhs._units:
-            msg = "Cannot %s units of different types.\n" \
-                    "LHS: %s\n" \
-                    "RHS: %s" % (func, self._units, rhs._units)
-            raise ValueError(msg)
+            raise ValueError(f"Cannot {func} units of different types.\n"
+                             f"LHS: {self._units}\n"
+                             f"RHS: {rhs._units}")
diff --git a/lib/matplotlib/testing/jpl_units/UnitDblConverter.py b/lib/matplotlib/testing/jpl_units/UnitDblConverter.py
@@ -86,11 +86,10 @@ def convert(value, unit, axis):
 
         if not cbook.is_scalar_or_string(value):
             return [UnitDblConverter.convert(x, unit, axis) for x in value]
-        # If the incoming value behaves like a number, but is not a UnitDbl,
+        # If the incoming value behaves like a number,
         # then just return it because we don't know how to convert it
         # (or it is already converted)
-        if (units.ConversionInterface.is_numlike(value)
-                and not isinstance(value, U.UnitDbl)):
+        if units.ConversionInterface.is_numlike(value):
             return value
         # If no units were specified, then get the default units to use.
         if unit is None:
diff --git a/lib/matplotlib/units.py b/lib/matplotlib/units.py
@@ -112,6 +112,7 @@ class ConversionInterface:
     The minimal interface for a converter to take custom data types (or
     sequences) and convert them to values Matplotlib can use.
     """
+
     @staticmethod
     def axisinfo(unit, axis):
         """
