Merge pull request #17236 from stefraynaud/default_contour_linewidth

QuLogic · web-flow · commit cd755c4222c3 · 2020-05-06T16:35:57.000-04:00
Add the "contour.linewidths" configuration option
diff --git a/doc/users/next_whats_new/2020-05-04-add-rcparams-contour-linewidth.rst b/doc/users/next_whats_new/2020-05-04-add-rcparams-contour-linewidth.rst
@@ -0,0 +1,9 @@
+Add :rc:`contour.linewidth` to rcParams
+---------------------------------------
+
+The new config option :rc:`contour.linewidth` allows to control the default
+linewidth of contours as a float. When set to ``None``, the linewidths fall
+back to :rc:`lines.linewidth`. The config value is overidden as usual
+by the ``linewidths`` argument passed to `~.axes.Axes.contour` when
+it is not set to ``None``.
+
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -1257,7 +1257,10 @@ def _process_linewidths(self):
         linewidths = self.linewidths
         Nlev = len(self.levels)
         if linewidths is None:
-            tlinewidths = [(mpl.rcParams['lines.linewidth'],)] * Nlev
+            default_linewidth = mpl.rcParams['contour.linewidth']
+            if default_linewidth is None:
+                default_linewidth = mpl.rcParams['lines.linewidth']
+            tlinewidths = [(default_linewidth,)] * Nlev
         else:
             if not np.iterable(linewidths):
                 linewidths = [linewidths] * Nlev
@@ -1749,7 +1752,7 @@ def _initialize_x_y(self, z):
             however introduce rendering artifacts at chunk boundaries depending
             on the backend, the *antialiased* flag and value of *alpha*.
 
-        linewidths : float or sequence of float, default: :rc:`lines.linewidth`
+        linewidths : float or array-like, default: :rc:`contour.linewidth`
             *Only applies to* `.contour`.
 
             The line width of the contour lines.
@@ -1759,6 +1762,8 @@ def _initialize_x_y(self, z):
             If a sequence, the levels in ascending order will be plotted with
             the linewidths in the order specified.
 
+            If None, this falls back to :rc:`lines.linewidth`.
+
         linestyles : {*None*, 'solid', 'dashed', 'dashdot', 'dotted'}, optional
             *Only applies to* `.contour`.
 
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -1203,6 +1203,7 @@ def _convert_validator_spec(key, conv):
     # contour props
     'contour.negative_linestyle': ['dashed', _validate_linestyle],
     'contour.corner_mask':        [True, validate_bool],
+    'contour.linewidth':          [None, validate_float_or_None],
 
     # errorbar props
     'errorbar.capsize':      [0, validate_float],
diff --git a/lib/matplotlib/tests/test_contour.py b/lib/matplotlib/tests/test_contour.py
@@ -5,7 +5,7 @@
 from numpy.testing import assert_array_almost_equal
 import matplotlib as mpl
 from matplotlib.testing.decorators import image_comparison
-from matplotlib import pyplot as plt
+from matplotlib import pyplot as plt, rc_context
 from matplotlib.colors import LogNorm
 import pytest
 
@@ -375,3 +375,20 @@ def test_contour_uneven():
     ax = axs[1]
     cs = ax.contourf(z, levels=[2, 4, 6, 10, 20])
     fig.colorbar(cs, ax=ax, spacing='uniform')
+
+
+@pytest.mark.parametrize(
+    "rc_lines_linewidth, rc_contour_linewidth, call_linewidths, expected", [
+        (1.23, None, None, 1.23),
+        (1.23, 4.24, None, 4.24),
+        (1.23, 4.24, 5.02, 5.02)
+        ])
+def test_contour_linewidth(
+        rc_lines_linewidth, rc_contour_linewidth, call_linewidths, expected):
+
+    with rc_context(rc={"lines.linewidth": rc_lines_linewidth,
+                        "contour.linewidth": rc_contour_linewidth}):
+        fig, ax = plt.subplots()
+        X = np.arange(4*3).reshape(4, 3)
+        cs = ax.contour(X, linewidths=call_linewidths)
+        assert cs.tlinewidths[0][0] == expected
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -576,6 +576,9 @@
 ## ***************************************************************************
 #contour.negative_linestyle: dashed  # string or on-off ink sequence
 #contour.corner_mask:        True    # {True, False, legacy}
+#contour.linewidth:          None    # {float, None} Size of the contour
+                                     # linewidths. If set to None,
+                                     # it falls back to `line.linewidth`.
 
 
 ## ***************************************************************************
