2
2
import contextlib
3
3
from functools import wraps
4
4
import inspect
5
+ from inspect import Signature , Parameter
5
6
import logging
6
7
from numbers import Number
7
8
import re
10
11
import numpy as np
11
12
12
13
import matplotlib as mpl
13
- from . import _api , cbook
14
+ from . import _api , cbook , docstring
14
15
from .path import Path
15
16
from .transforms import (Bbox , IdentityTransform , Transform , TransformedBbox ,
16
17
TransformedPatchPath , TransformedPath )
@@ -84,6 +85,12 @@ def _stale_axes_callback(self, val):
84
85
_XYPair = namedtuple ("_XYPair" , "x y" )
85
86
86
87
88
+ class _Unset :
89
+ def __repr__ (self ):
90
+ return "<UNSET>"
91
+ UNSET = _Unset ()
92
+
93
+
87
94
class Artist :
88
95
"""
89
96
Abstract base class for objects that render into a FigureCanvas.
@@ -93,6 +100,55 @@ class Artist:
93
100
94
101
zorder = 0
95
102
103
+ def __init_subclass__ (cls ):
104
+ # Inject custom set() methods into the subclass with signature and
105
+ # docstring based on the subclasses' properties.
106
+
107
+ if not hasattr (cls .set , '_autogenerated_signature' ):
108
+ # Don't overwrite cls.set if the subclass or one of its parents
109
+ # has defined a set method set itself.
110
+ # If there was no explicit definition, cls.set is inherited from
111
+ # the hierarchie of auto-generated set methods, which hold the
112
+ # flag _autogenerated_signature.
113
+ return
114
+
115
+ def set (self , ** kwargs ):
116
+ Artist .set (self , ** kwargs )
117
+
118
+ cls .set = set
119
+ cls ._update_set_signature_and_docstring ()
120
+
121
+ _PROPERTIES_EXCLUDED_FROM_SET = [
122
+ 'navigate_mode' , # not a user-facing function
123
+ 'figure' , # changing the figure is such a profound operation
124
+ # that we don't want this in set()
125
+ '3d_properties' , # cannot be used as a keyword do to leading digit
126
+ ]
127
+
128
+ @classmethod
129
+ def _update_set_signature_and_docstring (cls ):
130
+ """
131
+ Update the signature of the set function to list all properties
132
+ as keyword arguments.
133
+
134
+ Property aliases are not listed in the signature for brevity, but
135
+ are still accepted as keyword arguments.
136
+ """
137
+ cls .set .__signature__ = Signature (
138
+ [Parameter ("self" , Parameter .POSITIONAL_OR_KEYWORD ),
139
+ * [Parameter (prop , Parameter .KEYWORD_ONLY , default = UNSET )
140
+ for prop in ArtistInspector (cls ).get_setters ()
141
+ if prop not in Artist ._PROPERTIES_EXCLUDED_FROM_SET ]])
142
+ cls .set ._autogenerated_signature = True
143
+
144
+ cls .set .__doc__ = "\n " .join ([
145
+ "Set multiple properties at once." ,
146
+ "" ,
147
+ "Supported properties are:" ,
148
+ "" ,
149
+ f"%({ cls .__name__ } :kwdoc)s" ])
150
+ docstring .dedent_interpd (cls .set )
151
+
96
152
def __init__ (self ):
97
153
self ._stale = True
98
154
self .stale_callback = None
@@ -1096,7 +1152,9 @@ def properties(self):
1096
1152
return ArtistInspector (self ).properties ()
1097
1153
1098
1154
def set (self , ** kwargs ):
1099
- """A property batch setter. Pass *kwargs* to set properties."""
1155
+ # docstring and signature are auto-generated via
1156
+ # Artist._update_set_signature_and_docstring() at the end of the
1157
+ # module.
1100
1158
kwargs = cbook .normalize_kwargs (kwargs , self )
1101
1159
return self .update (kwargs )
1102
1160
@@ -1656,3 +1714,7 @@ def kwdoc(artist):
1656
1714
return ('\n ' .join (ai .pprint_setters_rest (leadingspace = 4 ))
1657
1715
if mpl .rcParams ['docstring.hardcopy' ] else
1658
1716
'Properties:\n ' + '\n ' .join (ai .pprint_setters (leadingspace = 4 )))
1717
+
1718
+ # We defer this to the end of them module, because it needs ArtistInspector
1719
+ # to be defined.
1720
+ Artist ._update_set_signature_and_docstring ()
0 commit comments