hSpSSKrSSKJr Sr"SS5r"SS\5r"S S 5rS r\"5r g) N)_apic^U4SjnU$)a Decorator for defining the kwdoc documentation of artist properties. This decorator can be applied to artist property setter methods. The given text is stored in a private attribute ``_kwarg_doc`` on the method. It is used to overwrite auto-generated documentation in the *kwdoc list* for artists. The kwdoc list is used to document ``**kwargs`` when they are properties of an artist. See e.g. the ``**kwargs`` section in `.Axes.text`. The text should contain the supported types, as well as the default value if applicable, e.g.: @_docstring.kwarg_doc("bool, default: :rc:`text.usetex`") def set_usetex(self, usetex): See Also -------- matplotlib.artist.kwdoc c>TUlU$N) _kwarg_doc)functexts G/var/www/html/env/lib/python3.13/site-packages/matplotlib/_docstring.py decoratorkwarg_doc..decorators )r r s` r kwarg_docrs, rc$\rSrSrSrSrSrSrg) Substitution"a A decorator that performs %-substitution on an object's docstring. This decorator should be robust even if ``obj.__doc__`` is None (for example, if -OO was passed to the interpreter). Usage: construct a docstring.Substitution with a sequence or dictionary suitable for performing substitution; then decorate a suitable function with the constructed object, e.g.:: sub_author_name = Substitution(author='Jason') @sub_author_name def some_function(x): "%(author)s wrote this function" # note that some_function.__doc__ is now "Jason wrote this function" One can also use positional arguments:: sub_first_last_names = Substitution('Edgar Allen', 'Poe') @sub_first_last_names def some_function(x): "%s %s wrote the Raven" cVU(aU(a [S5eU=(d UUlg)Nz+Only positional or keyword args are allowed) TypeErrorparams)selfargskwargss r __init__Substitution.__init__=s FIJ Jnf rcUR(a2[R"UR5UR-UlU$r)__doc__inspectcleandocr)rr s r __call__Substitution.__call__Bs- <<"++DLL9DKKGDL rrN)__name__ __module__ __qualname____firstlineno__rrr __static_attributes__rrr rr"s4% rrc\rSrSrSrSrg)_ArtistKwdocLoaderHc$^URS5(d [U5eUS[S5*mSSKJnJn U4Sj[ R"U55unURX"U55$![an[U5UeSnAff=f)Nz:kwdocr)Artistkwdocc3L># UHnURT:XdMUv M g7fr)r#).0clsnames r 1_ArtistKwdocLoader.__missing__..Os&-#DC||t+C#Ds$ $) endswithKeyErrorlenmatplotlib.artistr,r-rrecursive_subclasses ValueError setdefault)rkeyr,r-r0er1s @r __missing___ArtistKwdocLoader.__missing__Is||H%%3- ?S]N#3 '-4#<# B  BrN)r#r$r%r&r=r'rrr r)r)Hs 0rr)c*\rSrSrSrSrSrSrSrg)_ArtistPropertiesSubstitutionVa A class to substitute formatted placeholders in docstrings. This is realized in a single instance ``_docstring.interpd``. Use `~._ArtistPropertiesSubstition.register` to define placeholders and their substitution, e.g. ``_docstring.interpd.register(name="some value")``. Use this as a decorator to apply the substitution:: @_docstring.interpd def some_func(): '''Replace %(name)s.''' Decorating a class triggers substitution both on the class docstring and on the class' ``__init__`` docstring (which is a commonly required pattern for Artist subclasses). Substitutions of the form ``%(classname:kwdoc)s`` (ending with the literal ":kwdoc" suffix) trigger lookup of an Artist subclass with the given *classname*, and are substituted with the `.kwdoc` of that class. c"[5Ulgr)r)r)rs r r&_ArtistPropertiesSubstitution.__init__ns (* rc <URR"S0UD6 g)z Register substitutions. ``_docstring.interpd.register(name="some value")`` makes "name" available as a named parameter that will be replaced by "some value". Nr)rupdate)rrs r register&_ArtistPropertiesSubstitution.registerqs $V$rcUR(a2[R"UR5UR-Ul[ U[ 5(a0UR [R :waU"UR 5 U$r)rrrr isinstancetyperobject)robjs r r &_ArtistPropertiesSubstitution.__call__zsU ;;!**3;;7$++ECK c4 S\\V__%D   rr"N) r#r$r%r&rrrFr r'rrr r@r@Vs.+%rr@c^U4SjnU$)z;Copy a docstring from another source function (if present).cL>TR(aTRUlU$r)r)targetsources r do_copycopy..do_copys >>#^^FN rr)rQrRs` r copyrTs Nr) rrrrdictr)r@rTinterpdrrr rXsA8##L 0 0))X ( )r