Merge remote-tracking branch 'matplotlib/v2.x'

tacaswell · tacaswell · commit 98a2e6433866 · 2016-05-29T21:39:48.000-04:00
Conflicts:
	lib/matplotlib/axes/_base.py
           - whitespace conflicts
	lib/matplotlib/rcsetup.py
	   - kept 2.x version
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -866,7 +866,7 @@ def matplotlib_fname():
 _deprecated_ignore_map = {
     }
 
-_obsolete_set = set(['tk.pythoninspect', ])
+_obsolete_set = set(['tk.pythoninspect', 'legend.isaxes'])
 _all_deprecated = set(chain(_deprecated_ignore_map,
                             _deprecated_map, _obsolete_set))
 
@@ -885,6 +885,8 @@ class RcParams(dict):
                     if key not in _all_deprecated)
     msg_depr = "%s is deprecated and replaced with %s; please use the latter."
     msg_depr_ignore = "%s is deprecated and ignored. Use %s"
+    msg_obsolete = ("%s is obsolete. Please remove it from your matplotlibrc "
+                    "and/or style files.")
 
     # validate values on the way in
     def __init__(self, *args, **kwargs):
@@ -902,6 +904,9 @@ def __setitem__(self, key, val):
                 alt = _deprecated_ignore_map[key]
                 warnings.warn(self.msg_depr_ignore % (key, alt))
                 return
+            elif key in _obsolete_set:
+                warnings.warn(self.msg_obsolete % (key,))
+                return
             try:
                 cval = self.validate[key](val)
             except ValueError as ve:
@@ -923,6 +928,10 @@ def __getitem__(self, key):
             warnings.warn(self.msg_depr_ignore % (key, alt))
             key = alt
 
+        elif key in _obsolete_set:
+            warnings.warn(self.msg_obsolete % (key,))
+            return None
+
         val = dict.__getitem__(self, key)
         if inverse_alt is not None:
             return inverse_alt(val)
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -164,16 +164,9 @@ def __setstate__(self, state):
     def set_prop_cycle(self, *args, **kwargs):
         if not (args or kwargs) or (len(args) == 1 and args[0] is None):
             prop_cycler = rcParams['axes.prop_cycle']
-            if prop_cycler is None and 'axes.color_cycle' in rcParams:
-                clist = rcParams['axes.color_cycle']
-                prop_cycler = cycler('color', clist)
         else:
             prop_cycler = cycler(*args, **kwargs)
 
-        # Make sure the cycler always has at least one color
-        if 'color' not in prop_cycler.keys:
-            prop_cycler = prop_cycler * cycler('color', ['k'])
-
         self.prop_cycler = itertools.cycle(prop_cycler)
         # This should make a copy
         self._prop_keys = prop_cycler.keys
@@ -203,6 +196,8 @@ def get_next_color(self):
         """
         Return the next color in the cycle.
         """
+        if 'color' not in self._prop_keys:
+            return 'k'
         return six.next(self.prop_cycler)['color']
 
     def set_lineprops(self, line, **kwargs):
@@ -1044,11 +1039,12 @@ def cla(self):
                   axis=rcParams['axes.grid.axis'])
         props = font_manager.FontProperties(
             size=rcParams['axes.titlesize'],
-            weight=rcParams['axes.titleweight']
-            )
+            weight=rcParams['axes.titleweight'])
 
+        title_offset_points = rcParams['axes.titlepad']
         self.titleOffsetTrans = mtransforms.ScaledTranslation(
-            0.0, 5.0 / 72.0, self.figure.dpi_scale_trans)
+            0.0, title_offset_points / 72.0,
+            self.figure.dpi_scale_trans)
         self.title = mtext.Text(
             x=0.5, y=1.0, text='',
             fontproperties=props,
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -126,12 +126,8 @@ def to_rgba(c, alpha=None):
     # Special-case nth color syntax because it should not be cached.
     if _is_nth_color(c):
         from matplotlib import rcParams
-        from matplotlib.rcsetup import cycler
         prop_cycler = rcParams['axes.prop_cycle']
-        if prop_cycler is None and 'axes.color_cycle' in rcParams:
-            clist = rcParams['axes.color_cycle']
-            prop_cycler = cycler('color', clist)
-        colors = prop_cycler._transpose().get('color', 'k')
+        colors = prop_cycler.by_key().get('color', ['k'])
         c = colors[int(c[1]) % len(colors)]
     try:
         rgba = _colors_full_map.cache[c, alpha]
diff --git a/lib/matplotlib/mpl-data/stylelib/classic.mplstyle b/lib/matplotlib/mpl-data/stylelib/classic.mplstyle
@@ -179,6 +179,7 @@ axes.grid           : False   # display grid or not
 axes.grid.which     : major
 axes.grid.axis      : both
 axes.titlesize      : large   # fontsize of the axes title
+axes.titlepad       : 5.0     # pad between axes and title in points
 axes.titleweight    : normal  # font weight for axes title
 axes.labelsize      : medium  # fontsize of the x any y labels
 axes.labelpad       : 5.0     # space between label and axis
@@ -267,7 +268,6 @@ grid.alpha       :   1.0     # transparency, between 0.0 and 1.0
 legend.fancybox      : False  # if True, use a rounded box for the
                               # legend, else a rectangle
 legend.loc           : upper right
-legend.isaxes        : True   # this option is internally ignored
 legend.numpoints     : 2      # the number of points in the legend line
 legend.fontsize      : large
 legend.borderpad     : 0.4    # border whitespace in fontsize units
@@ -503,4 +503,4 @@ animation.convert_path: convert   # Path to ImageMagick's convert binary.
 animation.convert_args:
 animation.html: none
 
-_internal.classic_mode: True
+_internal.classic_mode: True
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -1051,6 +1051,7 @@ def validate_animation_writer_path(p):
     'axes.titlesize':        ['large', validate_fontsize],  # fontsize of the
                                                             # axes title
     'axes.titleweight':      ['normal', six.text_type],  # font weight of axes title
+    'axes.titlepad':         [9.0, validate_float],  # pad from axes top to title in points
     'axes.grid':             [False, validate_bool],   # display grid or not
     'axes.grid.which':       ['major', validate_axis_locator],  # set wether the gid are by
                                                                 # default draw on 'major'
@@ -1117,23 +1118,19 @@ def validate_animation_writer_path(p):
 
     #legend properties
     'legend.fancybox': [True, validate_bool],
-
-    # at some point, legend.loc should be changed to 'best'
     'legend.loc': ['best', validate_legend_loc],
-
-    # this option is internally ignored - it never served any useful purpose
-    'legend.isaxes': [True, validate_bool],
-
     # the number of points in the legend line
     'legend.numpoints': [1, validate_int],
     # the number of points in the legend line for scatter
-    'legend.scatterpoints': [3, validate_int],
-    'legend.fontsize': ['large', validate_fontsize],
-
-    # whether or not to draw a frame around legend
+    'legend.scatterpoints': [1, validate_int],
+    'legend.fontsize': ['medium', validate_fontsize],
+     # the relative size of legend markers vs. original
+    'legend.markerscale': [1.0, validate_float],
+    'legend.shadow': [False, validate_bool],
+     # whether or not to draw a frame around legend
     'legend.frameon': [True, validate_bool],
-    # alpha value of the legend frame
-    'legend.framealpha': [None, validate_float_or_None],
+     # alpha value of the legend frame
+    'legend.framealpha': [0.8, validate_float_or_None],
 
     ## the following dimensions are in fraction of the font size
     'legend.borderpad': [0.4, validate_float],  # units are fontsize
@@ -1153,7 +1150,7 @@ def validate_animation_writer_path(p):
     'legend.markerscale': [1.0, validate_float],
     'legend.shadow': [False, validate_bool],
     'legend.facecolor': ['inherit', validate_color_or_inherit],
-    'legend.edgecolor': ['k', validate_color_or_inherit],
+    'legend.edgecolor': ['none', validate_color_or_inherit],
 
     # tick properties
     'xtick.top':         [True, validate_bool],   # draw ticks on the top side
@@ -1206,13 +1203,13 @@ def validate_animation_writer_path(p):
     'figure.autolayout': [False, validate_bool],
     'figure.max_open_warning': [20, validate_int],
 
-    'figure.subplot.left': [0.125, ValidateInterval(0, 1, closedmin=True,
+    'figure.subplot.left': [0.155, ValidateInterval(0, 1, closedmin=True,
                                                        closedmax=True)],
-    'figure.subplot.right': [0.9, ValidateInterval(0, 1, closedmin=True,
+    'figure.subplot.right': [0.87, ValidateInterval(0, 1, closedmin=True,
                                                      closedmax=True)],
-    'figure.subplot.bottom': [0.1, ValidateInterval(0, 1, closedmin=True,
+    'figure.subplot.bottom': [0.13, ValidateInterval(0, 1, closedmin=True,
                                                      closedmax=True)],
-    'figure.subplot.top': [0.9, ValidateInterval(0, 1, closedmin=True,
+    'figure.subplot.top': [0.87, ValidateInterval(0, 1, closedmin=True,
                                                      closedmax=True)],
     'figure.subplot.wspace': [0.2, ValidateInterval(0, 1, closedmin=True,
                                                      closedmax=False)],
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -176,6 +176,7 @@ def check_freetype_version(ver):
 
     return found >= ver[0] and found <= ver[1]
 
+
 class ImageComparisonTest(CleanupTest):
     @classmethod
     def setup_class(cls):
@@ -213,7 +214,8 @@ def remove_text(figure):
 
     def test(self):
         baseline_dir, result_dir = _image_directories(self._func)
-
+        if self._style != 'classic':
+            raise KnownFailureTest('temporarily disabled until 2.0 tag')
         for fignum, baseline in zip(plt.get_fignums(), self._baseline_images):
             for extension in self._extensions:
                 will_fail = not extension in comparable_formats()
diff --git a/lib/matplotlib/tests/test_backend_pgf.py b/lib/matplotlib/tests/test_backend_pgf.py
@@ -17,7 +17,7 @@
 from matplotlib.testing.compare import compare_images, ImageComparisonFailure
 from matplotlib.testing.decorators import (_image_directories, switch_backend,
                                            cleanup)
-
+from matplotlib.testing.noseclasses import KnownFailureTest
 
 baseline_dir, result_dir = _image_directories(lambda: 'dummy func')
 
@@ -43,6 +43,8 @@ def check_for(texsystem):
 
 
 def compare_figure(fname, savefig_kwargs={}, tol=0):
+    # TODO remove this before tagging 2.0
+    raise KnownFailureTest('temporarily disabled until 2.0 tag')
     actual = os.path.join(result_dir, fname)
     plt.savefig(actual, **savefig_kwargs)
 
diff --git a/lib/matplotlib/tests/test_cycles.py b/lib/matplotlib/tests/test_cycles.py
@@ -70,13 +70,13 @@ def test_linestylecycle_basic():
     ax.set_prop_cycle(cycler('ls', ['-', '--', ':']))
     xs = np.arange(10)
     ys = 0.25 * xs + 2
-    ax.plot(xs, ys, label='solid', lw=4)
+    ax.plot(xs, ys, label='solid', lw=4, color='k')
     ys = 0.45 * xs + 3
-    ax.plot(xs, ys, label='dashed', lw=4)
+    ax.plot(xs, ys, label='dashed', lw=4, color='k')
     ys = 0.65 * xs + 4
-    ax.plot(xs, ys, label='dotted', lw=4)
+    ax.plot(xs, ys, label='dotted', lw=4, color='k')
     ys = 0.85 * xs + 5
-    ax.plot(xs, ys, label='solid2', lw=4)
+    ax.plot(xs, ys, label='solid2', lw=4, color='k')
     ax.legend(loc='upper left')
 
 
@@ -131,8 +131,8 @@ def test_property_collision_plot():
     ax.set_prop_cycle('linewidth', [2, 4])
     for c in range(1, 4):
         ax.plot(np.arange(10), c * np.arange(10), lw=0.1, color='k')
-    ax.plot(np.arange(10), 4 * np.arange(10))
-    ax.plot(np.arange(10), 5 * np.arange(10))
+    ax.plot(np.arange(10), 4 * np.arange(10), color='k')
+    ax.plot(np.arange(10), 5 * np.arange(10), color='k')
 
 
 @image_comparison(baseline_images=['property_collision_fill'],
diff --git a/lib/mpl_toolkits/tests/baseline_images/test_axes_grid1/inset_locator.png b/lib/mpl_toolkits/tests/baseline_images/test_axes_grid1/inset_locator.png
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -297,6 +297,7 @@ backend      : $TEMPLATE_BACKEND
 #axes.linewidth      : 1.0     # edge linewidth
 #axes.grid           : False   # display grid or not
 #axes.titlesize      : large   # fontsize of the axes title
+#axes.titlepad       : 9.0     # pad between axes and title in points
 #axes.labelsize      : medium  # fontsize of the x any y labels
 #axes.labelpad       : 5.0     # space between label and axis
 #axes.labelweight    : normal  # weight of the x and y labels
@@ -388,33 +389,32 @@ backend      : $TEMPLATE_BACKEND
 
 
 ### GRIDS
-#grid.color       :   b0b0b0 # grid color
+#grid.color       :   b0b0b0    # grid color
 #grid.linestyle   :   -         # solid
 #grid.linewidth   :   1.0       # in points
 #grid.alpha       :   1.0       # transparency, between 0.0 and 1.0
 
 ### Legend
-#legend.fancybox      : True  # if True, use a rounded box for the
-                              # legend, else a rectangle
 #legend.loc           : best
-#legend.isaxes        : True
-#legend.numpoints     : 1      # the number of points in the legend line
-#legend.fontsize      : large
-#legend.borderpad     : 0.5    # border whitespace in fontsize units
-#legend.markerscale   : 1.0    # the relative size of legend markers vs. original
-# the following dimensions are in axes coords
-#legend.labelspacing  : 0.5    # the vertical space between the legend entries in fraction of fontsize
-#legend.handlelength  : 2.     # the length of the legend lines in fraction of fontsize
-#legend.handleheight  : 0.7     # the height of the legend handle in fraction of fontsize
-#legend.handletextpad : 0.8    # the space between the legend line and legend text in fraction of fontsize
-#legend.borderaxespad : 0.5   # the border between the axes and legend edge in fraction of fontsize
-#legend.columnspacing : 2.    # the border between the axes and legend edge in fraction of fontsize
+#legend.frameon       : True     # whether or not to draw a frame around legend
+#legend.framealpha    : 0.8      # legend frame transparency
+#legend.facecolor     : inherit  # inherit from axes.facecolor; or color spec
+#legend.edgecolor     : none
+#legend.fancybox      : True     # if True, use a rounded box for the
+                                 # legend, else a rectangle
 #legend.shadow        : False
-#legend.frameon       : True   # whether or not to draw a frame around legend
-#legend.framealpha    : None    # opacity of of legend frame
-#legend.scatterpoints : 3 # number of scatter points
-#legend.facecolor     : inherit
-#legend.edgecolor     : k
+#legend.numpoints     : 1        # the number of marker points in the legend line
+#legend.scatterpoints : 1        # number of scatter points
+#legend.markerscale   : 1.0      # the relative size of legend markers vs. original
+#legend.fontsize      : medium
+# Dimensions as fraction of fontsize:
+#legend.borderpad     : 0.4      # border whitespace
+#legend.labelspacing  : 0.5      # the vertical space between the legend entries
+#legend.handlelength  : 2.0      # the length of the legend lines
+#legend.handleheight  : 0.7      # the height of the legend handle
+#legend.handletextpad : 0.8      # the space between the legend line and legend text
+#legend.borderaxespad : 0.5      # the border between the axes and legend edge
+#legend.columnspacing : 2.0      # column separation
 
 ### FIGURE
 # See http://matplotlib.org/api/figure_api.html#matplotlib.figure.Figure
@@ -432,10 +432,10 @@ backend      : $TEMPLATE_BACKEND
 
 # The figure subplot parameters.  All dimensions are a fraction of the
 # figure width or height
-#figure.subplot.left    : 0.125  # the left side of the subplots of the figure
-#figure.subplot.right   : 0.9    # the right side of the subplots of the figure
-#figure.subplot.bottom  : 0.1    # the bottom of the subplots of the figure
-#figure.subplot.top     : 0.9    # the top of the subplots of the figure
+#figure.subplot.left    : 0.155  # the left side of the subplots of the figure
+#figure.subplot.right   : 0.87   # the right side of the subplots of the figure
+#figure.subplot.bottom  : 0.13   # the bottom of the subplots of the figure
+#figure.subplot.top     : 0.87   # the top of the subplots of the figure
 #figure.subplot.wspace  : 0.2    # the amount of width reserved for blank space between subplots
 #figure.subplot.hspace  : 0.2    # the amount of height reserved for white space between subplots
 
