Merge pull request matplotlib#6435 from tacaswell/backport_rgba_overhual

Merge pull request matplotlib#6382 from anntzer/rgba-support

doc/conf.py

@@ -333,5 +333,19 @@ def getapi(*args):
 sys.modules['sip'] = mocksip
 sys.modules['PyQt4'] = mockpyqt4
 
-################# numpydoc config ####################
+# numpydoc config
+
 numpydoc_show_class_members = False
+
+# Skip deprecated members
+
+def skip_deprecated(app, what, name, obj, skip, options):
+    if skip:
+        return skip
+    skipped = {"matplotlib.colors": ["ColorConverter", "hex2color", "rgb2hex"]}
+    skip_list = skipped.get(getattr(obj, "__module__", None))
+    if skip_list is not None:
+        return getattr(obj, "__name__", None) in skip_list
+
+def setup(app):
+    app.connect('autodoc-skip-member', skip_deprecated)

doc/users/colors.rst

@@ -9,7 +9,7 @@ it can be provided as:
 
 * ``(r, g, b)`` tuples
 * ``(r, g, b, a)`` tuples
-* hex string, ex ``#OFOFOF``
+* hex string, ex ``#0F0F0F``, or ``#0F0F0F0F`` (with alpha channel)
 * float value between [0, 1] for gray level
 * One of ``{'b', 'g', 'r', 'c', 'm', 'y', 'k', 'w'}``
 * valid CSS4/X11 color names

doc/users/whats_new/rgba-support.rst

@@ -0,0 +1,11 @@
+Improved color conversion API and RGBA support
+----------------------------------------------
+
+The :module:`~matplotlib.colors` gained a new color conversion API with
+full support for the alpha channel.  The main public functions are
+:func:`~matplotlib.colors.is_color_like`, :func:`matplotlib.colors.to_rgba`,
+:func:`matplotlib.colors.to_rgba_array` and :func:`~matplotlib.colors.to_hex`.
+RGBA quadruplets are encoded in hex format as `#rrggbbaa`.
+
+A side benefit is that the Qt options editor now allows setting the alpha
+channel of the artists as well.

examples/api/collections_demo.py

@@ -18,8 +18,7 @@
 '''
 
 import matplotlib.pyplot as plt
-from matplotlib import collections, transforms
-from matplotlib.colors import colorConverter
+from matplotlib import collections, colors, transforms
 import numpy as np
 
 nverts = 50
@@ -39,7 +38,7 @@
 xyo = list(zip(xo, yo))
 
 # Make a list of colors cycling through the default series.
-colors = [colorConverter.to_rgba(c)
+colors = [colors.to_rgba(c)
           for c in plt.rcParams['axes.prop_cycle'].by_key()['color']]
 
 fig, axes = plt.subplots(2, 2)

examples/color/named_colors.py

@@ -11,36 +11,19 @@
 
 import numpy as np
 import matplotlib.pyplot as plt
-from matplotlib import colors
+from matplotlib import colors as mcolors
 
 
-colors_ = list(six.iteritems(colors.cnames))
-
-# Add the single letter colors.
-for name, rgb in six.iteritems(colors.ColorConverter.colors):
-    hex_ = colors.rgb2hex(rgb)
-    colors_.append((name, hex_))
-
-# Transform to hex color values.
-hex_ = [color[1] for color in colors_]
-# Get the rgb equivalent.
-rgb = [colors.hex2color(color) for color in hex_]
-# Get the hsv equivalent.
-hsv = [colors.rgb_to_hsv(color) for color in rgb]
-
-# Split the hsv values to sort.
-hue = [color[0] for color in hsv]
-sat = [color[1] for color in hsv]
-val = [color[2] for color in hsv]
-
-# Get the color names by themselves.
-names = [color[0] for color in colors_]
+colors = dict(mcolors.BASE_COLORS, **mcolors.CSS4_COLORS)
 
 # Sort by hue, saturation, value and name.
-ind = np.lexsort((names, val, sat, hue))
-sorted_colors = [colors_[i] for i in ind]
+by_hsv = sorted((tuple(mcolors.rgb_to_hsv(mcolors.to_rgba(color)[:3])), name)
+                for name, color in colors.items())
+
+# Get the sorted color names.
+sorted_names = [name for hsv, name in by_hsv]
 
-n = len(sorted_colors)
+n = len(sorted_names)
 ncols = 4
 nrows = int(np.ceil(1. * n / ncols))
 
@@ -53,7 +36,7 @@
 # col width
 w = X / ncols
 
-for i, (name, color) in enumerate(sorted_colors):
+for i, name in enumerate(sorted_names):
     col = i % ncols
     row = int(i / ncols)
     y = Y - (row * h) - h
@@ -68,8 +51,10 @@
 
     # Add extra black line a little bit thicker to make
     # clear colors more visible.
-    ax.hlines(y, xi_line, xf_line, color='black', linewidth=(h * 0.7))
-    ax.hlines(y + h * 0.1, xi_line, xf_line, color=color, linewidth=(h * 0.6))
+    ax.hlines(
+        y, xi_line, xf_line, color='black', linewidth=(h * 0.7))
+    ax.hlines(
+        y + h * 0.1, xi_line, xf_line, color=colors[name], linewidth=(h * 0.6))
 
 ax.set_xlim(0, X)
 ax.set_ylim(0, Y)

examples/event_handling/lasso_demo.py

@@ -7,18 +7,17 @@
 usable as is).  There will be some refinement of the API.
 """
 from matplotlib.widgets import Lasso
-from matplotlib.colors import colorConverter
 from matplotlib.collections import RegularPolyCollection
-from matplotlib import path
+from matplotlib import colors as mcolors, path
 
 import matplotlib.pyplot as plt
 from numpy import nonzero
 from numpy.random import rand
 
 
 class Datum(object):
-    colorin = colorConverter.to_rgba('red')
-    colorout = colorConverter.to_rgba('blue')
+    colorin = mcolors.to_rgba("red")
+    colorout = mcolors.to_rgba("blue")
 
     def __init__(self, x, y, include=False):
         self.x = x

examples/mplot3d/polys3d_demo.py

@@ -1,7 +1,7 @@
 from mpl_toolkits.mplot3d import Axes3D
 from matplotlib.collections import PolyCollection
-from matplotlib.colors import colorConverter
 import matplotlib.pyplot as plt
+from matplotlib import colors as mcolors
 import numpy as np
 
 
@@ -10,7 +10,7 @@
 
 
 def cc(arg):
-    return colorConverter.to_rgba(arg, alpha=0.6)
+    return mcolors.to_rgba(arg, alpha=0.6)
 
 xs = np.arange(0, 10, 0.4)
 verts = []

examples/pylab_examples/colours.py

@@ -4,12 +4,12 @@
 Some simple functions to generate colours.
 """
 import numpy as np
-from matplotlib.colors import colorConverter
+from matplotlib import colors as mcolors
 
 
 def pastel(colour, weight=2.4):
     """ Convert colour into a nice pastel shade"""
-    rgb = np.asarray(colorConverter.to_rgb(colour))
+    rgb = np.asarray(mcolors.to_rgba(colour)[:3])
     # scale colour
     maxc = max(rgb)
     if maxc < 1.0 and maxc > 0:

examples/pylab_examples/demo_ribbon_box.py

@@ -18,7 +18,7 @@ class RibbonBox(object):
     nx = original_image.shape[1]
 
     def __init__(self, color):
-        rgb = matplotlib.colors.colorConverter.to_rgb(color)
+        rgb = matplotlib.colors.to_rgba(color)[:3]
 
         im = np.empty(self.original_image.shape,
                       self.original_image.dtype)

examples/pylab_examples/line_collection.py

@@ -1,6 +1,6 @@
 import matplotlib.pyplot as plt
 from matplotlib.collections import LineCollection
-from matplotlib.colors import colorConverter
+from matplotlib import colors as mcolors
 
 import numpy as np
 
@@ -30,7 +30,7 @@
 #          where onoffseq is an even length tuple of on and off ink in points.
 #          If linestyle is omitted, 'solid' is used
 # See matplotlib.collections.LineCollection for more information
-colors = [colorConverter.to_rgba(c)
+colors = [mcolors.to_rgba(c)
           for c in plt.rcParams['axes.prop_cycle'].by_key()['color']]
 
 line_segments = LineCollection(segs, linewidths=(0.5, 1, 1.5, 2),

examples/widgets/menu.py

@@ -17,8 +17,8 @@ def __init__(self, fontsize=14, labelcolor='black', bgcolor='yellow',
         self.bgcolor = bgcolor
         self.alpha = alpha
 
-        self.labelcolor_rgb = colors.colorConverter.to_rgb(labelcolor)
-        self.bgcolor_rgb = colors.colorConverter.to_rgb(bgcolor)
+        self.labelcolor_rgb = colors.to_rgba(labelcolor)[:3]
+        self.bgcolor_rgb = colors.to_rgba(bgcolor)[:3]
 
 
 class MenuItem(artist.Artist):

lib/matplotlib/_color_data.py

@@ -3,6 +3,18 @@
 
 from matplotlib.externals import six
 
+
+BASE_COLORS = {
+    'b': (0, 0, 1),
+    'g': (0, 0.5, 0),
+    'r': (1, 0, 0),
+    'c': (0, 0.75, 0.75),
+    'm': (0.75, 0, 0.75),
+    'y': (0.75, 0.75, 0),
+    'k': (0, 0, 0),
+    'w': (1, 1, 1)}
+
+
 # This mapping of color names -> hex values is taken from
 # a survey run by Randel Monroe see:
 # http://blog.xkcd.com/2010/05/03/color-survey-results/

lib/matplotlib/axes/_axes.py

@@ -2065,7 +2065,7 @@ def make_iterable(x):
         if color is None:
             color = [None] * nbars
         else:
-            color = list(mcolors.colorConverter.to_rgba_array(color))
+            color = list(mcolors.to_rgba_array(color))
             if len(color) == 0:  # until to_rgba_array is changed
                 color = [[0, 0, 0, 0]]
             if len(color) < nbars:
@@ -2074,7 +2074,7 @@ def make_iterable(x):
         if edgecolor is None:
             edgecolor = [None] * nbars
         else:
-            edgecolor = list(mcolors.colorConverter.to_rgba_array(edgecolor))
+            edgecolor = list(mcolors.to_rgba_array(edgecolor))
             if len(edgecolor) == 0:     # until to_rgba_array is changed
                 edgecolor = [[0, 0, 0, 0]]
             if len(edgecolor) < nbars:
@@ -3843,7 +3843,7 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
         co = kwargs.pop('color', None)
         if co is not None:
             try:
-                mcolors.colorConverter.to_rgba_array(co)
+                mcolors.to_rgba_array(co)
             except ValueError:
                 raise ValueError("'color' kwarg must be an mpl color"
                                  " spec or sequence of color specs.\n"
@@ -6050,7 +6050,7 @@ def _normalize_input(inp, ename='input'):
         if color is None:
             color = [self._get_lines.get_next_color() for i in xrange(nx)]
         else:
-            color = mcolors.colorConverter.to_rgba_array(color)
+            color = mcolors.to_rgba_array(color)
             if len(color) != nx:
                 raise ValueError("color kwarg must have one color per dataset")
 

lib/matplotlib/axes/_base.py

@@ -68,7 +68,7 @@ def _process_plot_format(fmt):
 
     # Is fmt just a colorspec?
     try:
-        color = mcolors.colorConverter.to_rgb(fmt)
+        color = mcolors.to_rgba(fmt)
 
         # We need to differentiate grayscale '1.0' from tri_down marker '1'
         try:
@@ -112,14 +112,14 @@ def _process_plot_format(fmt):
                 raise ValueError(
                     'Illegal format string "%s"; two marker symbols' % fmt)
             marker = c
-        elif c in mcolors.colorConverter.colors:
+        elif c in mcolors.get_named_colors_mapping():
             if color is not None:
                 raise ValueError(
                     'Illegal format string "%s"; two color symbols' % fmt)
             color = c
         elif c == 'C' and i < len(chars) - 1:
             color_cycle_number = int(chars[i + 1])
-            color = mcolors.colorConverter._get_nth_color(color_cycle_number)
+            color = mcolors.to_rgba("C{}".format(color_cycle_number))
             i += 1
         else:
             raise ValueError(
@@ -3636,7 +3636,7 @@ def set_cursor_props(self, *args):
             lw, c = args
         else:
             raise ValueError('args must be a (linewidth, color) tuple')
-        c = mcolors.colorConverter.to_rgba(c)
+        c = mcolors.to_rgba(c)
         self._cursorProps = lw, c
 
     def get_children(self):

lib/matplotlib/backend_bases.py

@@ -1022,11 +1022,11 @@ def set_foreground(self, fg, isRGBA=False):
         if self._forced_alpha and isRGBA:
             self._rgb = fg[:3] + (self._alpha,)
         elif self._forced_alpha:
-            self._rgb = colors.colorConverter.to_rgba(fg, self._alpha)
+            self._rgb = colors.to_rgba(fg, self._alpha)
         elif isRGBA:
             self._rgb = fg
         else:
-            self._rgb = colors.colorConverter.to_rgba(fg)
+            self._rgb = colors.to_rgba(fg)
 
     def set_graylevel(self, frac):
         """

lib/matplotlib/backends/backend_gtk.py

@@ -35,15 +35,11 @@ def fn_name(): return sys._getframe(1).f_code.co_name
 
 from matplotlib.backends.backend_gdk import RendererGDK, FigureCanvasGDK
 from matplotlib.cbook import is_string_like, is_writable_file_like
-from matplotlib.colors import colorConverter
 from matplotlib.figure import Figure
 from matplotlib.widgets import SubplotTool
 
-from matplotlib import lines
-from matplotlib import markers
-from matplotlib import cbook
-from matplotlib import verbose
-from matplotlib import rcParams
+from matplotlib import (
+    cbook, colors as mcolors, lines, markers, rcParams, verbose)
 
 backend_version = "%d.%d.%d" % gtk.pygtk_version
 
@@ -1003,13 +999,13 @@ def on_combobox_lineprops_changed(self, item):
         if marker is None: marker = 'None'
         self.cbox_markers.set_active(self.markerd[marker])
 
-        r,g,b = colorConverter.to_rgb(line.get_color())
-        color = gtk.gdk.Color(*[int(val*65535) for val in (r,g,b)])
+        rgba = mcolors.to_rgba(line.get_color())
+        color = gtk.gdk.Color(*[int(val*65535) for val in rgba[:3]])
         button = self.wtree.get_widget('colorbutton_linestyle')
         button.set_color(color)
 
-        r,g,b = colorConverter.to_rgb(line.get_markerfacecolor())
-        color = gtk.gdk.Color(*[int(val*65535) for val in (r,g,b)])
+        rgba = mcolors.to_rgba(line.get_markerfacecolor())
+        color = gtk.gdk.Color(*[int(val*65535) for val in rgba[:3]])
         button = self.wtree.get_widget('colorbutton_markerface')
         button.set_color(color)
         self._updateson = True

lib/matplotlib/backends/backend_gtk3.py

@@ -36,14 +36,10 @@ def fn_name(): return sys._getframe(1).f_code.co_name
 from matplotlib import backend_tools
 
 from matplotlib.cbook import is_string_like, is_writable_file_like
-from matplotlib.colors import colorConverter
 from matplotlib.figure import Figure
 from matplotlib.widgets import SubplotTool
 
-from matplotlib import lines
-from matplotlib import cbook
-from matplotlib import verbose
-from matplotlib import rcParams
+from matplotlib import cbook, colors as mcolors, lines, verbose, rcParams
 
 backend_version = "%s.%s.%s" % (Gtk.get_major_version(), Gtk.get_micro_version(), Gtk.get_minor_version())