Merge pull request #15966 from jklymak/fix-check-subplot-syntax

timhoffm · web-flow · commit e5283e0ba305 · 2019-12-18T07:46:09.000+01:00
FIX: check subplot kwargs
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -438,8 +438,12 @@ def __init__(self, fig, rect,
         self._sharex = sharex
         self._sharey = sharey
         if sharex is not None:
+            if not isinstance(sharex, _AxesBase):
+                raise TypeError('sharex must be an axes, not a bool')
             self._shared_x_axes.join(self, sharex)
         if sharey is not None:
+            if not isinstance(sharey, _AxesBase):
+                raise TypeError('sharey must be an axes, not a bool')
             self._shared_y_axes.join(self, sharey)
         self.set_label(label)
         self.set_figure(fig)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -954,6 +954,10 @@ def subplot(*args, **kwargs):
         cbook._warn_external("The subplot index argument to subplot() appears "
                              "to be a boolean. Did you intend to use "
                              "subplots()?")
+    # Check for nrows and ncols, which are not valid subplot args:
+    if 'nrows' in kwargs or 'ncols' in kwargs:
+        raise TypeError("subplot() got an unexpected keyword argument 'ncols' "
+                         "and/or 'nrows'.  Did you intend to call subplots()?")
 
     fig = gcf()
     a = fig.add_subplot(*args, **kwargs)
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -5489,6 +5489,13 @@ def test_shared_scale():
         assert ax.get_xscale() == 'linear'
 
 
+def test_shared_bool():
+    with pytest.raises(TypeError):
+        plt.subplot(sharex=True)
+    with pytest.raises(TypeError):
+        plt.subplot(sharey=True)
+
+
 def test_violin_point_mass():
     """Violin plot should handle point mass pdf gracefully."""
     plt.violinplot(np.array([0, 0]))
diff --git a/lib/matplotlib/tests/test_pyplot.py b/lib/matplotlib/tests/test_pyplot.py
@@ -51,3 +51,10 @@ def test_pyplot_box():
 def test_stackplot_smoke():
     # Small smoke test for stackplot (see #12405)
     plt.stackplot([1, 2, 3], [1, 2, 3])
+
+
+def test_nrows_error():
+    with pytest.raises(TypeError):
+        plt.subplot(nrows=1)
+    with pytest.raises(TypeError):
+        plt.subplot(ncols=1)
