ó ±éRc@s•ddlmZddlmZddlZddlZdefd„ƒYZdefd„ƒYZd„Z d „Z eƒZ d „Z d „Z dS( iÿÿÿÿ(tprint_function(tcbookNt SubstitutioncBs8eZdZd„Zd„Zd„Zed„ƒZRS(s/ 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,|o | stdƒ‚|p"||_dS(Ns+Only positional or keyword args are allowed(tAssertionErrortparams(tselftargstkwargs((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyt__init__"scCs |jo|j|j|_|S(N(t__doc__R(Rtfunc((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyt__call__&scOs|jj||ŽdS(s=Assume self.params is a dict and update it with supplied argsN(Rtupdate(RRR((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyR *scCs|ƒ}||_|S(s( 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(tclsRtresult((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyt from_params.s  (t__name__t __module__R RR R t classmethodR(((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyRs    tAppendercBs#eZdZdd„Zd„ZRS(sf 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 tcCs||_||_dS(N(taddendumtjoin(RRR((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyRMs cCs1|j|jg}|jo'dj|ƒ|_|S(NR(R RR(RR tdocitems((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyR Qs(RRR RR (((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyR:s cCs"|jotj|jƒ|_|S(sDedent a docstring (if present)(R Rtdedent(R ((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyRVscs‡fd†}|S(s:Copy a docstring from another source function (if present)csˆjrˆj|_n|S(N(R (ttarget(tsource(sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pytdo_copy]s ((RR((RsN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pytcopy[scCsAt|tjƒr1tjddkr1|j}ntt|ƒƒS(sXA special case of the interpd that first performs a dedent on the incoming docstringii(t isinstancettypest MethodTypetsyst version_infotim_functinterpdR(R ((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pytdedent_interpdgs% cs ‡fd†S(sOA decorator that will copy the docstring from the source and then dedent itcsttˆƒ|ƒƒS(N(RR(R(R(sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pytus((R((RsN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyt copy_dedentns(t __future__Rt matplotlibRR RtobjectRRRRR#R$R&(((sN/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/docstring.pyts  4