Support spine.set() in SpinesProxy.

anntzer · anntzer · commit 877d9772ae97 · 2023-05-18T11:16:31.000+02:00
Artist.set() is a convenient way to set multiple properties at once; it
seems reasonable to also support it in SpinesProxy.
diff --git a/doc/users/next_whats_new/spinesproxyset.rst b/doc/users/next_whats_new/spinesproxyset.rst
@@ -0,0 +1,3 @@
+``SpinesProxy`` now supports calling the ``set()`` method
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+One can now call e.g. ``ax.spines[:].set(visible=False)``.
diff --git a/lib/matplotlib/spines.py b/lib/matplotlib/spines.py
@@ -479,7 +479,7 @@ def set_color(self, c):
 
 class SpinesProxy:
     """
-    A proxy to broadcast ``set_*`` method calls to all contained `.Spines`.
+    A proxy to broadcast ``set_*()`` and ``set()`` method calls to contained `.Spines`.
 
     The proxy cannot be used for any other operations on its members.
 
@@ -493,7 +493,7 @@ def __init__(self, spine_dict):
     def __getattr__(self, name):
         broadcast_targets = [spine for spine in self._spine_dict.values()
                              if hasattr(spine, name)]
-        if not name.startswith('set_') or not broadcast_targets:
+        if (name != 'set' and not name.startswith('set_')) or not broadcast_targets:
             raise AttributeError(
                 f"'SpinesProxy' object has no attribute '{name}'")
 
@@ -531,8 +531,8 @@ class Spines(MutableMapping):
 
         spines[:].set_visible(False)
 
-    The latter two indexing methods will return a `SpinesProxy` that broadcasts
-    all ``set_*`` calls to its members, but cannot be used for any other
+    The latter two indexing methods will return a `SpinesProxy` that broadcasts all
+    ``set_*()`` and ``set()`` calls to its members, but cannot be used for any other
     operation.
     """
     def __init__(self, **kwargs):
diff --git a/lib/matplotlib/tests/test_spines.py b/lib/matplotlib/tests/test_spines.py
@@ -12,6 +12,9 @@ class SpineMock:
         def __init__(self):
             self.val = None
 
+        def set(self, **kwargs):
+            vars(self).update(kwargs)
+
         def set_val(self, val):
             self.val = val
 
@@ -35,6 +38,9 @@ def set_val(self, val):
     spines[:].set_val('y')
     assert all(spine.val == 'y' for spine in spines.values())
 
+    spines[:].set(foo='bar')
+    assert all(spine.foo == 'bar' for spine in spines.values())
+
     with pytest.raises(AttributeError, match='foo'):
         spines.foo
     with pytest.raises(KeyError, match='foo'):

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``SpinesProxy`` now supports calling the ``set()`` method
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	+One can now call e.g. ``ax.spines[:].set(visible=False)``.