o hS@sZddlZddlmZddZGdddZGdd d eZGd d d Zd d ZeZ dS)N)_apicfdd}|S)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 cs |_|SN) _kwarg_doc)functexti/var/www/html/construction_image-detection-poc/venv/lib/python3.10/site-packages/matplotlib/_docstring.py decoratorszkwarg_doc..decoratorr )r r r rr kwarg_docs r c@s eZdZdZddZddZdS) SubstitutionaG 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" cOs|r|rtd|p ||_dS)Nz+Only positional or keyword args are allowed) TypeErrorparams)selfargskwargsr r r __init__=szSubstitution.__init__cCs|jr t|j|j|_|Sr)__doc__inspectcleandocr)rrr r r __call__BszSubstitution.__call__N)__name__ __module__ __qualname__rrrr r r r r"s rc@seZdZddZdS)_ArtistKwdocLoaderc s|ds t||dtd ddlm}m}zfddt|D\}Wnty:}zt||d}~ww| |||S)Nz:kwdocr)Artistkwdocc3s|] }|jkr|VqdSr)r).0clsnamer r Os  z1_ArtistKwdocLoader.__missing__..) endswithKeyErrorlenmatplotlib.artistrrrrecursive_subclasses ValueError setdefault)rkeyrrr er r!r __missing__Is  z_ArtistKwdocLoader.__missing__N)rrrr-r r r r rHs rc@s(eZdZdZddZddZddZdS) _ArtistPropertiesSubstitutionaQ 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. cCs t|_dSr)rr)rr r r rns z&_ArtistPropertiesSubstitution.__init__cKs|jjdi|dS)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)rrr r r registerqsz&_ArtistPropertiesSubstitution.registercCs>|jr t|j|j|_t|tr|jtjkr||j|Sr)rrrr isinstancetyperobject)robjr r r rzs  z&_ArtistPropertiesSubstitution.__call__N)rrrrrr0rr r r r r.Vs  r.cr)z;Copy a docstring from another source function (if present).csjrj|_|Sr)r)targetsourcer r do_copyszcopy..do_copyr )r7r8r r6r copys r9) rrr rdictrr.r9interpdr r r r s &,