3 ƽh @s<ddlZddlmZGdddZddZeZddZdS) N)cbookc@sBeZdZdZddZddZddZeej dd d d d Z d S) 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 :/tmp/pip-build-7iwl8md4/matplotlib/matplotlib/docstring.py__init__!szSubstitution.__init__cCs|jr|j|j;_|S)N)__doc__r)rfuncr r r __call__&szSubstitution.__call__cOs|jj||dS)zW Update ``self.params`` (which must be a dict) with the supplied args. N)rupdate)rrrr r r r+szSubstitution.updatez3.3zassign to the params attribute) alternativecCs|}||_|S)a( In the case where the params is a mutable sequence (list or dictionary) and it may change before this class is called, one may explicitly use a reference to the params rather than using *args or **kwargs which will copy the values and not reference them. )r)clsrresultr r r from_params1s zSubstitution.from_paramsN) __name__ __module__ __qualname__r r rr classmethodrZ deprecatedrr r r r rs rcsfdd}|S)z;Copy a docstring from another source function (if present).csjrj|_|S)N)r )target)sourcer r do_copyAszcopy..do_copyr )rrr )rr copy?s rcCstj||_t|S)z@Dedent *func*'s docstring, then interpolate it with ``interpd``.)inspectgetdocr interpd)r r r r dedent_interpdMs r)rZ matplotlibrrrrrr r r r s  9