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

tacaswell · tacaswell · commit 2fd479a2e65b · 2017-11-18T17:02:01.000-05:00
Conflicts:
	lib/matplotlib/pyplot.py
	  - identical changes to docstring
	lib/matplotlib/tests/test_artist.py
	  - adjacent tests changed, kept both versions
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,6 @@
-include CHANGELOG INSTALL
+include INSTALL.rst README.rst
 include CONTRIBUTING.md
+include pytest.ini
 include Makefile MANIFEST.in
 include matplotlibrc.template setup.cfg.template
 include setupext.py setup.py distribute_setup.py
@@ -10,13 +11,16 @@ include lib/matplotlib/mpl-data/fonts/ttf/*
 include lib/matplotlib/mpl-data/fonts/pdfcorefonts/*
 include lib/matplotlib/mpl-data/fonts/afm/*
 include lib/matplotlib/mpl-data/stylelib/*
-recursive-include lib/matplotlib/mpl-data/sample_data *
 recursive-include LICENSE *
-recursive-include examples *
 recursive-include doc *
-recursive-include src  *.cpp *.c *.h *.m
-recursive-include lib *
+recursive-include examples *
 recursive-include extern *
+recursive-include lib *
+recursive-include lib/matplotlib/mpl-data/sample_data *
+recursive-include src  *.cpp *.c *.h *.m
+recursive-include tools *
+recursive-include tutorials *
+recursive-include unit *
 include versioneer.py
 include lib/matplotlib/_version.py
 include tests.py
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -948,6 +948,8 @@ def set_zorder(self, level):
             ..
                 ACCEPTS: float
         """
+        if level is None:
+            level = self.__class__.zorder
         self.zorder = level
         self.pchanged()
         self.stale = True
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -920,11 +920,12 @@ def add_axes(self, *args, **kwargs):
         polar : boolean, optional
             If True, equivalent to projection='polar'.
 
-        This method also takes the keyword arguments for
-        :class:`~matplotlib.axes.Axes`.
+        **kwargs
+            This method also takes the keyword arguments for
+            :class:`~matplotlib.axes.Axes`.
 
         Returns
-        ------
+        -------
         axes : Axes
             The added axes.
 
@@ -1022,8 +1023,9 @@ def add_subplot(self, *args, **kwargs):
         polar : boolean, optional
             If True, equivalent to projection='polar'.
 
-        This method also takes the keyword arguments for
-        :class:`~matplotlib.axes.Axes`.
+        **kwargs
+            This method also takes the keyword arguments for
+            :class:`~matplotlib.axes.Axes`.
 
         Returns
         -------
@@ -1038,6 +1040,8 @@ def add_subplot(self, *args, **kwargs):
 
         Examples
         --------
+        ::
+
             fig.add_subplot(111)
 
             # equivalent but more general
@@ -1762,9 +1766,10 @@ def savefig(self, fname, **kwargs):
 
         The output formats available depend on the backend being used.
 
-        Arguments:
+        Parameters
+        ----------
 
-          *fname*:
+        fname : str or file-like object
             A string containing a path to a filename, or a Python
             file-like object, or possibly some backend-dependent object
             such as :class:`~matplotlib.backends.backend_pdf.PdfPages`.
@@ -1777,29 +1782,33 @@ def savefig(self, fname, **kwargs):
             If *fname* is not a string, remember to specify *format* to
             ensure that the correct backend is used.
 
-        Keyword arguments:
+        Other Parameters
+        ----------------
 
-          *dpi*: [ *None* | ``scalar > 0`` | 'figure']
+        dpi : [ *None* | scalar > 0 | 'figure']
             The resolution in dots per inch.  If *None* it will default to
             the value ``savefig.dpi`` in the matplotlibrc file. If 'figure'
             it will set the dpi to be the value of the figure.
 
-          *facecolor*, *edgecolor*:
-            the colors of the figure rectangle
+        facecolor : color spec or None, optional
+            the facecolor of the figure; if None, defaults to savefig.facecolor
+
+        edgecolor : color spec or None, optional
+            the edgecolor of the figure; if None, defaults to savefig.edgecolor
 
-          *orientation*: [ 'landscape' | 'portrait' ]
+        orientation : {'landscape', 'portrait'}
             not supported on all backends; currently only on postscript output
 
-          *papertype*:
+        papertype : str
             One of 'letter', 'legal', 'executive', 'ledger', 'a0' through
             'a10', 'b0' through 'b10'. Only supported for postscript
             output.
 
-          *format*:
+        format : str
             One of the file extensions supported by the active
             backend.  Most backends support png, pdf, ps, eps and svg.
 
-          *transparent*:
+        transparent : bool
             If *True*, the axes patches will all be transparent; the
             figure patch will also be transparent unless facecolor
             and/or edgecolor are specified via kwargs.
@@ -1808,21 +1817,21 @@ def savefig(self, fname, **kwargs):
             transparency of these patches will be restored to their
             original values upon exit of this function.
 
-          *frameon*:
+        frameon : bool
             If *True*, the figure patch will be colored, if *False*, the
             figure background will be transparent.  If not provided, the
             rcParam 'savefig.frameon' will be used.
 
-          *bbox_inches*:
+        bbox_inches : str or `~matplotlib.transforms.Bbox`, optional
             Bbox in inches. Only the given portion of the figure is
             saved. If 'tight', try to figure out the tight bbox of
-            the figure.
+            the figure. If None, use savefig.bbox
 
-          *pad_inches*:
+        pad_inches : scalar, optional
             Amount of padding around the figure when bbox_inches is
-            'tight'.
+            'tight'. If None, use savefig.pad_inches
 
-          *bbox_extra_artists*:
+        bbox_extra_artists : list of `~matplotlib.artist.Artist`, optional
             A list of extra artists that will be considered when the
             tight bbox is calculated.
 
@@ -2016,17 +2025,20 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
         """
         Adjust subplot parameters to give specified padding.
 
-        Parameters:
+        Parameters
+        ----------
 
-          pad : float
+        pad : float
             padding between the figure edge and the edges of subplots,
             as a fraction of the font-size.
-          h_pad, w_pad : float
+
+        h_pad, w_pad : float, optional
             padding (height/width) between edges of adjacent subplots.
             Defaults to `pad_inches`.
-          rect : if rect is given, it is interpreted as a rectangle
-            (left, bottom, right, top) in the normalized figure
-            coordinate that the whole subplots area (including
+
+        rect : tuple (left, bottom, right, top), optional
+            a rectangle (left, bottom, right, top) in the normalized
+            figure coordinate that the whole subplots area (including
             labels) will fit into. Default is (0, 0, 1, 1).
         """
 
diff --git a/lib/matplotlib/tests/test_artist.py b/lib/matplotlib/tests/test_artist.py
@@ -246,3 +246,13 @@ def test_setp():
     sio = io.StringIO()
     plt.setp(lines1, 'zorder', file=sio)
     assert sio.getvalue() == '  zorder: float \n'
+
+
+def test_None_zorder():
+    fig, ax = plt.subplots()
+    ln, = ax.plot(range(5), zorder=None)
+    assert ln.get_zorder() == mlines.Line2D.zorder
+    ln.set_zorder(123456)
+    assert ln.get_zorder() == 123456
+    ln.set_zorder(None)
+    assert ln.get_zorder() == mlines.Line2D.zorder
diff --git a/lib/matplotlib/tests/test_png.py b/lib/matplotlib/tests/test_png.py
@@ -2,16 +2,15 @@
                         unicode_literals)
 
 import six
-
+from six import BytesIO
 import glob
 import os
-
 import numpy as np
+import pytest
 
 from matplotlib.testing.decorators import image_comparison
 from matplotlib import pyplot as plt
 import matplotlib.cm as cm
-
 import sys
 on_win = (sys.platform == 'win32')
 
@@ -46,3 +45,28 @@ def test_imread_png_uint16():
 
     assert (img.dtype == np.uint16)
     assert np.sum(img.flatten()) == 134184960
+
+
+def test_truncated_file(tmpdir):
+    d = tmpdir.mkdir('test')
+    fname = str(d.join('test.png'))
+    fname_t = str(d.join('test_truncated.png'))
+    plt.savefig(fname)
+    with open(fname, 'rb') as fin:
+        buf = fin.read()
+    with open(fname_t, 'wb') as fout:
+        fout.write(buf[:20])
+
+    with pytest.raises(Exception):
+        plt.imread(fname_t)
+
+
+def test_truncated_buffer():
+    b = BytesIO()
+    plt.savefig(b)
+    b.seek(0)
+    b2 = BytesIO(b.read(20))
+    b2.seek(0)
+
+    with pytest.raises(Exception):
+        plt.imread(b2)
diff --git a/src/_png.cpp b/src/_png.cpp
@@ -194,18 +194,18 @@ static PyObject *Py_write_png(PyObject *self, PyObject *args, PyObject *kwds)
 
     switch (channels) {
     case 1:
-	png_color_type = PNG_COLOR_TYPE_GRAY;
-	break;
+        png_color_type = PNG_COLOR_TYPE_GRAY;
+        break;
     case 3:
-	png_color_type = PNG_COLOR_TYPE_RGB;
-	break;
+        png_color_type = PNG_COLOR_TYPE_RGB;
+        break;
     case 4:
-	png_color_type = PNG_COLOR_TYPE_RGB_ALPHA;
-	break;
+        png_color_type = PNG_COLOR_TYPE_RGB_ALPHA;
+        break;
     default:
         PyErr_SetString(PyExc_ValueError,
-			"Buffer must be an NxMxD array with D in 1, 3, 4 "
-			"(grayscale, RGB, RGBA)");
+                        "Buffer must be an NxMxD array with D in 1, 3, 4 "
+                        "(grayscale, RGB, RGBA)");
         goto exit;
     }
 
@@ -349,20 +349,20 @@ static PyObject *Py_write_png(PyObject *self, PyObject *args, PyObject *kwds)
     sig_bit.alpha = 0;
     switch (png_color_type) {
     case PNG_COLOR_TYPE_GRAY:
-	sig_bit.gray = 8;
-	sig_bit.red = 0;
-	sig_bit.green = 0;
-	sig_bit.blue = 0;
-	break;
+        sig_bit.gray = 8;
+        sig_bit.red = 0;
+        sig_bit.green = 0;
+        sig_bit.blue = 0;
+        break;
     case PNG_COLOR_TYPE_RGB_ALPHA:
-	sig_bit.alpha = 8;
-	// fall through
+        sig_bit.alpha = 8;
+        // fall through
     case PNG_COLOR_TYPE_RGB:
-	sig_bit.gray = 0;
-	sig_bit.red = 8;
-	sig_bit.green = 8;
-	sig_bit.blue = 8;
-	break;
+        sig_bit.gray = 0;
+        sig_bit.red = 8;
+        sig_bit.green = 8;
+        sig_bit.blue = 8;
+        break;
     default:
         PyErr_SetString(PyExc_RuntimeError, "internal error, bad png_color_type");
         goto exit;
@@ -408,13 +408,21 @@ static void _read_png_data(PyObject *py_file_obj, png_bytep data, png_size_t len
     Py_ssize_t bufflen;
     if (read_method) {
         result = PyObject_CallFunction(read_method, (char *)"i", length);
-        if (PyBytes_AsStringAndSize(result, &buffer, &bufflen) == 0) {
-            if (bufflen == (Py_ssize_t)length) {
-                memcpy(data, buffer, length);
+        if (result) {
+            if (PyBytes_AsStringAndSize(result, &buffer, &bufflen) == 0) {
+                if (bufflen == (Py_ssize_t)length) {
+                    memcpy(data, buffer, length);
+                } else {
+                    PyErr_SetString(PyExc_IOError, "read past end of file");
+                }
             } else {
-                PyErr_SetString(PyExc_IOError, "read past end of file");
+                PyErr_SetString(PyExc_IOError, "failed to copy buffer");
             }
+        } else  {
+            PyErr_SetString(PyExc_IOError, "failed to read file");
         }
+
+
     }
     Py_XDECREF(read_method);
     Py_XDECREF(result);
@@ -424,6 +432,10 @@ static void read_png_data(png_structp png_ptr, png_bytep data, png_size_t length
 {
     PyObject *py_file_obj = (PyObject *)png_get_io_ptr(png_ptr);
     _read_png_data(py_file_obj, data, length);
+    if (PyErr_Occurred()) {
+        png_error(png_ptr, "failed to read file");
+    }
+
 }
 
 static PyObject *_read_png(PyObject *filein, bool float_result)
@@ -481,6 +493,9 @@ static PyObject *_read_png(PyObject *filein, bool float_result)
         }
         Py_XDECREF(read_method);
         _read_png_data(py_file, header, 8);
+        if (PyErr_Occurred()) {
+            goto exit;
+        }
     }
 
     if (png_sig_cmp(header, 0, 8)) {
@@ -503,7 +518,9 @@ static PyObject *_read_png(PyObject *filein, bool float_result)
     }
 
     if (setjmp(png_jmpbuf(png_ptr))) {
-        PyErr_SetString(PyExc_RuntimeError, "Error setting jump");
+        if (!PyErr_Occurred()) {
+            PyErr_SetString(PyExc_RuntimeError, "error setting jump");
+        }
         goto exit;
     }
 
