Merge branch 'master' of github.com:matplotlib/matplotlib into styles_XDG_compliance

alimuldal · alimuldal · commit 805ce26e0f8a · 2014-01-13T11:24:48.000Z
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -113,6 +113,10 @@ original location:
   does the exact same thing as `FormatStrFormatter`, but for new-style
   formatting strings.
 
+* Deprecated `matplotlib.testing.image_util` and the only function within,
+  `matplotlib.testing.image_util.autocontrast`. These will be removed
+  completely in v1.5.0.
+
 * The ``fmt`` argument of :meth:`~matplotlib.axes.Axes.plot_date` has been
   changed from ``bo`` to just ``o``, so color cycling can happen by default.
 
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -119,6 +119,13 @@ def new_function():
 
     obj_type : str, optional
         The object type being deprecated.
+
+    Example
+    -------
+    # To warn of the deprecation of "matplotlib.name_of_module"
+    warn_deprecated('1.4.0', name='matplotlib.name_of_module',
+                    obj_type='module')
+
     """
     message = _generate_deprecation_message(
         since, message, name, alternative, pending, obj_type)
@@ -129,7 +136,7 @@ def new_function():
 def deprecated(since, message='', name='', alternative='', pending=False,
                obj_type='function'):
     """
-    Used to mark a function as deprecated.
+    Decorator to mark a function as deprecated.
 
     Parameters
     ------------
@@ -164,6 +171,13 @@ def new_function():
     pending : bool, optional
         If True, uses a PendingDeprecationWarning instead of a
         DeprecationWarning.
+        
+    Example
+    -------
+    @deprecated('1.4.0')
+    def the_function_to_deprecate():
+        pass
+    
     """
     def deprecate(func, message=message, name=name, alternative=alternative,
                   pending=pending):
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -2,7 +2,7 @@
 """
 Matplotlib provides sophisticated date plotting capabilities, standing on the
 shoulders of python :mod:`datetime`, the add-on modules :mod:`pytz` and
-:mod:`dateutils`.  :class:`datetime` objects are converted to floating point
+:mod:`dateutil`.  :class:`datetime` objects are converted to floating point
 numbers which represent time in days since 0001-01-01 UTC, plus 1.  For
 example, 0001-01-01, 06:00 is 1.25, not 0.25.  The helper functions
 :func:`date2num`, :func:`num2date` and :func:`drange` are used to facilitate
@@ -50,6 +50,9 @@
 Most of the date tickers can locate single or multiple values.  For
 example::
 
+    # import constants for the days of the week
+    from matplotlib.dates import MO, TU, WE, TH, FR, SA, SU
+
     # tick on mondays every week
     loc = WeekdayLocator(byweekday=MO, tz=tz)
 
@@ -1028,7 +1031,8 @@ def __init__(self,  byweekday=1, interval=1, tz=None):
         sequence.
 
         Elements of *byweekday* must be one of MO, TU, WE, TH, FR, SA,
-        SU, the constants from :mod:`dateutils.rrule`.
+        SU, the constants from :mod:`dateutil.rrule`, which have been
+        imported into the :mod:`matplotlib.dates` namespace.
 
         *interval* specifies the number of weeks to skip.  For example,
         ``interval=2`` plots every second week.
diff --git a/lib/matplotlib/finance.py b/lib/matplotlib/finance.py
@@ -1007,7 +1007,7 @@ def _candlestick(ax, quotes, width=0.2, colorup='k', colordown='r',
 
         vline = Line2D(
             xdata=(t, t), ydata=(low, high),
-            color='k',
+            color=color,
             linewidth=0.5,
             antialiased=True,
         )
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -921,7 +921,7 @@ def subplot(*args, **kwargs):
 
 
 def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
-                subplot_kw=None, **fig_kw):
+                subplot_kw=None, gridspec_kw=None, **fig_kw):
     """
     Create a figure with a set of subplots already made.
 
@@ -981,6 +981,11 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
         :meth:`~matplotlib.figure.Figure.add_subplot` call used to
         create each subplots.
 
+      *gridspec_kw* : dict
+        Dict with keywords passed to the
+        :class:`~matplotlib.gridspec.GridSpec` constructor used to create
+        the grid the subplots are placed on.
+
       *fig_kw* : dict
         Dict with keywords passed to the :func:`figure` call.  Note that all
         keywords not recognized above will be automatically included here.
@@ -1055,16 +1060,19 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
                 (sharey, share_values))
     if subplot_kw is None:
         subplot_kw = {}
+    if gridspec_kw is None:
+        gridspec_kw = {}
 
     fig = figure(**fig_kw)
+    gs = GridSpec(nrows, ncols, **gridspec_kw)
 
     # Create empty object array to hold all axes.  It's easiest to make it 1-d
     # so we can just append subplots upon creation, and then
     nplots = nrows*ncols
     axarr = np.empty(nplots, dtype=object)
 
     # Create first subplot separately, so we can share it if requested
-    ax0 = fig.add_subplot(nrows, ncols, 1, **subplot_kw)
+    ax0 = fig.add_subplot(gs[0, 0], **subplot_kw)
     #if sharex:
     #    subplot_kw['sharex'] = ax0
     #if sharey:
@@ -1094,7 +1102,7 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
             subplot_kw['sharey'] = None
         else:
             subplot_kw['sharey'] = axarr[sys[i]]
-        axarr[i] = fig.add_subplot(nrows, ncols, i + 1, **subplot_kw)
+        axarr[i] = fig.add_subplot(gs[i // ncols, i % ncols], **subplot_kw)
 
     # returned axis array will be always 2-d, even if nrows=ncols=1
     axarr = axarr.reshape(nrows, ncols)
diff --git a/lib/matplotlib/testing/image_util.py b/lib/matplotlib/testing/image_util.py
@@ -37,7 +37,14 @@
 
 import numpy as np
 
-# TODO: Vectorize this
+from matplotlib.cbook import deprecated, warn_deprecated
+
+
+warn_deprecated('1.4.0', name='matplotlib.testing.image_util',
+                obj_type='module')
+
+
+@deprecated('1.4.0')
 def autocontrast(image, cutoff=0):
     """
     Maximize image contrast, based on histogram.  This completely
diff --git a/lib/matplotlib/tests/test_animation.py b/lib/matplotlib/tests/test_animation.py
@@ -10,6 +10,7 @@
 from matplotlib import pyplot as plt
 from matplotlib import animation
 from matplotlib.testing.noseclasses import KnownFailureTest
+from matplotlib.testing.decorators import cleanup
 from matplotlib.testing.decorators import CleanupTest
 
 
diff --git a/lib/matplotlib/tests/test_ticker.py b/lib/matplotlib/tests/test_ticker.py
@@ -51,6 +51,38 @@ def test_LogLocator():
     assert_almost_equal(loc.tick_values(1, 100), test_value)
 
 
+def test_LogFormatterExponent():
+    class FakeAxis(object):
+        """Allow Formatter to be called without having a "full" plot set up."""
+        def get_view_interval(self):
+            return 1, 10
+
+    i = np.arange(-3, 4, dtype=float)
+    expected_result = ['-3', '-2', '-1', '0', '1', '2', '3']
+    for base in [2, 5, 10, np.pi, np.e]:
+        formatter = mticker.LogFormatterExponent(base=base)
+        formatter.axis = FakeAxis()
+        vals = base**i
+        labels = [formatter(x, pos) for (x, pos) in zip(vals, i)]
+        nose.tools.assert_equal(labels, expected_result)
+
+    # Should be a blank string for non-integer powers if labelOnlyBase=True
+    formatter = mticker.LogFormatterExponent(base=10, labelOnlyBase=True)
+    formatter.axis = FakeAxis()
+    nose.tools.assert_equal(formatter(10**0.1), '')
+
+    # Otherwise, non-integer powers should be nicely formatted
+    locs = np.array([0.1, 0.00001, np.pi, 0.2, -0.2, -0.00001])
+    i = range(len(locs))
+    expected_result = ['0.1', '1e-05', '3.14', '0.2', '-0.2', '-1e-05']
+    for base in [2, 5, 10, np.pi, np.e]:
+        formatter = mticker.LogFormatterExponent(base, labelOnlyBase=False)
+        formatter.axis = FakeAxis()
+        vals = base**locs
+        labels = [formatter(x, pos) for (x, pos) in zip(vals, i)]
+        nose.tools.assert_equal(labels, expected_result)
+
+
 def test_use_offset():
     for use_offset in [True, False]:
         with matplotlib.rc_context({'axes.formatter.useoffset': use_offset}):
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -728,13 +728,10 @@ def __call__(self, x, pos=None):
         isDecade = is_close_to_int(fx)
         if not isDecade and self.labelOnlyBase:
             s = ''
-        #if 0: pass
-        elif fx > 10000:
-            s = '%1.0e' % fx
-        #elif x<1: s = '$10^{%d}$'%fx
-        #elif x<1: s =  '10^%d'%fx
-        elif fx < 1:
-            s = '%1.0e' % fx
+        elif abs(fx) > 10000:
+            s = '%1.0g' % fx
+        elif abs(fx) < 1:
+            s = '%1.0g' % fx
         else:
             s = self.pprint_val(fx, d)
         if sign == -1:
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1044,7 +1044,7 @@ def onselect(vmin, vmax):
     """
 
     def __init__(self, ax, onselect, direction, minspan=None, useblit=False,
-                 rectprops=None, onmove_callback=None):
+                 rectprops=None, onmove_callback=None, span_stays=False):
         """
         Create a span selector in *ax*.  When a selection is made, clear
         the span and call *onselect* with::
@@ -1062,6 +1062,9 @@ def __init__(self, ax, onselect, direction, minspan=None, useblit=False,
 
         Set the visible attribute to *False* if you want to turn off
         the functionality of the span selector
+        
+        If *span_stays* is True, the span stays visble after making 
+        a valid selection.
         """
         AxesWidget.__init__(self, ax)
 
@@ -1081,7 +1084,8 @@ def __init__(self, ax, onselect, direction, minspan=None, useblit=False,
         self.onselect = onselect
         self.onmove_callback = onmove_callback
         self.minspan = minspan
-
+        self.span_stays = span_stays
+        
         # Needed when dragging out of axes
         self.buttonDown = False
         self.prev = (0, 0)
@@ -1116,7 +1120,13 @@ def new_axes(self, ax):
                               transform=trans,
                               visible=False,
                               **self.rectprops)
-
+        if self.span_stays:
+            self.stay_rect = Rectangle((0, 0), w, h,
+                                       transform=trans,
+                                       visible=False,
+                                       **self.rectprops)
+            self.ax.add_patch(self.stay_rect)
+            
         if not self.useblit:
             self.ax.add_patch(self.rect)
 
@@ -1140,6 +1150,9 @@ def press(self, event):
         self.buttonDown = True
 
         self.rect.set_visible(self.visible)
+        if self.span_stays:
+            self.stay_rect.set_visible(False)
+            
         if self.direction == 'horizontal':
             self.pressv = event.xdata
         else:
@@ -1155,6 +1168,14 @@ def release(self, event):
         self.buttonDown = False
 
         self.rect.set_visible(False)
+        
+        if self.span_stays:
+            self.stay_rect.set_x(self.rect.get_x())
+            self.stay_rect.set_y(self.rect.get_y())
+            self.stay_rect.set_width(self.rect.get_width())
+            self.stay_rect.set_height(self.rect.get_height())
+            self.stay_rect.set_visible(True)
+        
         self.canvas.draw()
         vmin = self.pressv
         if self.direction == 'horizontal':

Original file line number	Diff line number	Diff line change
`@@ -1007,7 +1007,7 @@ def _candlestick(ax, quotes, width=0.2, colorup='k', colordown='r',`
`1007`	`1007`
`1008`	`1008`	`vline = Line2D(`
`1009`	`1009`	`xdata=(t, t), ydata=(low, high),`
`1010`		`- color='k',`
	`1010`	`+ color=color,`
`1011`	`1011`	`linewidth=0.5,`
`1012`	`1012`	`antialiased=True,`
`1013`	`1013`	`)`