Move constructor.Colors --> utils.get_colors

lukelbd · lukelbd · commit 51d480da1b08 · 2021-08-16T12:51:52.000-06:00
diff --git a/proplot/constructor.py b/proplot/constructor.py
@@ -37,7 +37,7 @@
     _version_mpl,
     warnings,
 )
-from .utils import to_rgba
+from .utils import to_hex, to_rgba, get_colors
 
 try:
     from mpl_toolkits.basemap import Basemap
@@ -336,20 +336,6 @@
 }
 
 
-def Colors(*args, **kwargs):
-    """
-    Pass all arguments to `Cycle` and return the list of colors from
-    the resulting `~cycler.Cycler` object.
-
-    See also
-    --------
-    cycler.Cycler
-    Cycle
-    """
-    cycle = Cycle(*args, **kwargs)
-    return list(dict_['color'] for dict_ in cycle)
-
-
 def _modify_colormap(cmap, *, cut, left, right, reverse, shift, alpha, samples):
     """
     Modify colormap using a variety of methods.
@@ -1523,3 +1509,9 @@ def Proj(name, basemap=None, **kwargs):
         proj._proj_package = 'cartopy'
 
     return proj
+
+
+# Deprecated
+Colors = warnings._rename_objs(
+    '0.8', Colors=get_colors
+)
diff --git a/proplot/utils.py b/proplot/utils.py
@@ -18,7 +18,7 @@
     'arange',
     'edges',
     'edges2d',
-    'units',
+    'get_colors',
     'set_hue',
     'set_saturation',
     'set_luminance',
@@ -208,6 +208,33 @@ def edges2d(z):
     return zb
 
 
+def get_colors(*args, **kwargs):
+    """
+    Get the colors associated with a registered or
+    on-the-fly color cycle.
+
+    Parameters
+    ----------
+    *args, **kwargs
+        Passed to `~proplot.constructor.Cycle`.
+
+    Returns
+    -------
+    colors : list of str
+        A list of HEX strings.
+
+    See also
+    --------
+    cycler.Cycler
+    proplot.constructor.Cycle
+    proplot.constructor.Colormap
+    """
+    from .constructor import Cycle  # delayed to avoid cyclic imports
+    cycle = Cycle(*args, **kwargs)
+    colors = [to_hex(dict_['color']) for dict_ in cycle]
+    return colors
+
+
 def _transform_color(func, color, space):
     """
     Standardize input for color transformation functions.
