B cw @sTddlZGdddZddZGdddeZGdd d eZd d ZeZZdS) Nc@s(eZdZdZddZddZddZdS) 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)selfargskwargsrr3lib/python3.7/site-packages/matplotlib/docstring.py__init__szSubstitution.__init__cCs|jrt|j|j|_|S)N)__doc__inspectZcleandocr)rfuncrrr __call__$szSubstitution.__call__cOs|jj||dS)zW Update ``self.params`` (which must be a dict) with the supplied args. N)rupdate)rrrrrr r)szSubstitution.updateN)__name__ __module__ __qualname__r r rrrrrr rsrccs*|Vx|D]}t|EdHqWdS)N)__subclasses___recursive_subclasses)clssubclsrrr r0src@seZdZddZdS)_ArtistKwdocLoaderc s|dst||dtd ddlm}m}yfddt|D\}Wn,tk r|}zt||Wdd}~XYnX||||S)Nz:kwdocr)Artistkwdoccsg|]}|jkr|qSr)r).0r)namerr =sz2_ArtistKwdocLoader.__missing__..) endswithKeyErrorlenZmatplotlib.artistrrr ValueError setdefault)rkeyrrrer)rr __missing__7s z_ArtistKwdocLoader.__missing__N)rrrr$rrrr r6srcs(eZdZdZddZfddZZS)_ArtistPropertiesSubstitutiona A `.Substitution` with two additional features: - 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. - 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). cCs t|_dS)N)rr)rrrr r Psz&_ArtistPropertiesSubstitution.__init__cs0t|t|tr,|jtjkr,||j|S)N)superr isinstancetyper object)robj) __class__rr rSs  z&_ArtistPropertiesSubstitution.__call__)rrrr r r __classcell__rr)r+r r%Ds r%csfdd}|S)z;Copy a docstring from another source function (if present).csjrj|_|S)N)r )target)sourcerr do_copy\szcopy..do_copyr)r.r/r)r.r copyZs r0) r rrdictrr%r0Zdedent_interpdZinterpdrrrr s ,