B ]”t\Ëã@sfddlZddlZddlmZGdd„deƒZGdd„deƒZdd„Zd d „ZeƒZ d d „Z d d„Z dS)éN)Úcbookc@s4eZdZdZdd„Zdd„Zdd„Zedd „ƒZd S) Ú Substitutiona/ A decorator to take a function's docstring and perform string substitution on it. This decorator should be robust even if func.__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&t|ƒrt|ƒrtdƒ‚|p||_dS)Nz+Only positional or keyword args are allowed)ÚlenÚAssertionErrorÚparams)ÚselfÚargsÚkwargs©r ú3lib/python3.7/site-packages/matplotlib/docstring.pyÚ__init__#szSubstitution.__init__cCs|jo|j|j|_|S)N)Ú__doc__r)rÚfuncr r r Ú__call__(szSubstitution.__call__cOs|jj||ŽdS)z=Assume self.params is a dict and update it with supplied argsN)rÚupdate)rrr r r r r,szSubstitution.updatecCs|ƒ}||_|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)ÚclsrÚresultr r r Ú from_params0szSubstitution.from_paramsN) Ú__name__Ú __module__Ú __qualname__r r rrÚ classmethodrr r r r rs rc@s"eZdZdZddd„Zdd„ZdS) ÚAppenderaf A function decorator that will append an addendum to the docstring of the target function. This decorator should be robust even if func.__doc__ is None (for example, if -OO was passed to the interpreter). Usage: construct a docstring.Appender with a string to be joined to the original docstring. An optional 'join' parameter may be supplied which will be used to join the docstring and addendum. e.g. add_copyright = Appender("Copyright (c) 2009", join=' ') @add_copyright def my_dog(has='fleas'): "This docstring will have a copyright below" pass ÚcCs||_||_dS)N)ÚaddendumÚjoin)rrrr r r r PszAppender.__init__cCs$|j|jg}|jo|j |¡|_|S)N)r rr)rrZdocitemsr r r rTs zAppender.__call__N)r)rrrr r rr r r r r=s rcCs|jot |j¡|_|S)zDedent a docstring (if present))r rÚdedent)rr r r rZsrcs‡fdd„}|S)z:Copy a docstring from another source function (if present)csˆjrˆj|_|S)N)r )Útarget)Úsourcer r Údo_copybszcopy..do_copyr )rrr )rr Úcopy`s r cCs tt|ƒƒS)zXA special case of the interpd that first performs a dedent on the incoming docstring)Úinterpdr)rr r r Údedent_interpdmsr"cs ‡fdd„S)zOA decorator that will copy the docstring from the source and then dedent itcsttˆƒ|ƒƒS)N)rr )r)rr r Úzszcopy_dedent..r )rr )rr Ú copy_dedentssr$) ÚsysÚtypesZ matplotlibrÚobjectrrrr r!r"r$r r r r Ús 6