U Ev f @sXddlZddlmZGdddZGdddeZGdd d eZd d ZeZZ dS) N)_apic@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) TypeErrorparamsselfargskwargsr 9/tmp/pip-unpacked-wheel-7vhvci0g/matplotlib/_docstring.py__init__!szSubstitution.__init__cCs|jrt|j|j|_|SN)__doc__inspectcleandocr)rfuncr r r __call__&szSubstitution.__call__cOs|jj||dS)zW Update ``self.params`` (which must be a dict) with the supplied args. N)rupdaterr r r r+szSubstitution.updateN)__name__ __module__ __qualname__rr rrr r r r rsrc@seZdZddZdS)_ArtistKwdocLoaderc s|dst||dtd ddlm}m}zfddt|D\}Wn,tk r~}zt||W5d}~XYnX| |||S)Nz:kwdocr)Artistkwdoccsg|]}|jkr|qSr )r).0clsnamer r 9s z2_ArtistKwdocLoader.__missing__..) endswithKeyErrorlenZmatplotlib.artistrrrZrecursive_subclasses ValueError setdefault)rkeyrrrer rr __missing__3s z_ArtistKwdocLoader.__missing__N)rrrr'r r r r r2srcs(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|_dSr)rr)rr r r r Lsz&_ArtistPropertiesSubstitution.__init__cs0t|t|tr,|jtjkr,||j|Sr)superr isinstancetyper object)robj __class__r r rOs  z&_ArtistPropertiesSubstitution.__call__)rrrrr r __classcell__r r r.r r(@s r(csfdd}|S)z;Copy a docstring from another source function (if present).csjrj|_|Sr)r)targetsourcer r do_copyXszcopy..do_copyr )r3r4r r2r copyVs r5) rrrdictrr(r5Zdedent_interpdZinterpdr r r r s  ,