Method _update_set_signature_and_docstring

lib/matplotlib/artist.py:153–191

Update the signature of the set function to list all properties as keyword arguments. Property aliases are not listed in the signature for brevity, but are still accepted as keyword arguments.

(cls)

    @classmethod
    def _update_set_signature_and_docstring(cls):
        """
        Update the signature of the set function to list all properties
        as keyword arguments.

        Property aliases are not listed in the signature for brevity, but
        are still accepted as keyword arguments.
        """
        cls.set.__signature__ = Signature(
            [Parameter("self", Parameter.POSITIONAL_OR_KEYWORD),
             *[Parameter(prop, Parameter.KEYWORD_ONLY, default=_api.UNSET)
               for prop in ArtistInspector(cls).get_setters()
               if prop not in Artist._PROPERTIES_EXCLUDED_FROM_SET]])
        cls.set._autogenerated_signature = True

        cls.set.__doc__ = ("""\
Set multiple properties at once.

::

    a.set(a=A, b=B, c=C)

is equivalent to ::

    a.set_a(A)
    a.set_b(B)
    a.set_c(C)

In addition to the full property names, aliases are also supported, e.g.
``set(lw=2)`` is equivalent to ``set(linewidth=2)``, but it is an error
to pass both simultaneously.

The order of the individual setter calls matches the order of parameters
in ``set()``. However, most properties do not depend on each other so
that order is rarely relevant.

Supported properties are

""" + kwdoc(cls))

    def __init__(self):
        self._stale = True