σ Λ½χXc@`s†dZddlmZmZmZddlZdddddd gZdd „Zd „Z d „Z e d „Z d„Z d„ZdS(sk Utilities to allow inserting docstring fragments for common parameters into function and method docstringsi(tdivisiontprint_functiontabsolute_importNt docformattinherit_docstring_fromtindentcount_linestfilldoct unindent_dicttunindent_stringc C`s|s |S|dkri}n|s)|S|jƒjƒ}t|ƒdkrVd}nt|dƒ}d|}i}x”|jƒD]†\}}|jƒjƒ}yJ|dg}x#|dD]} |j|| ƒqΌWdj|ƒ||>> docformat(' Test string with %(value)s', {'value':'inserted value'}) ' Test string with inserted value' >>> docstring = 'First line\n Second line\n %(value)s' >>> inserted_string = "indented\nstring" >>> docdict = {'value': inserted_string} >>> docformat(docstring, docdict) 'First line\n Second line\n indented\n string' iiit s N( tNonet expandtabst splitlinestlenRtitemstappendtjoint IndexError( t docstringtdocdicttlinesticounttindenttindentedtnametdstrtnewlinestline((s0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pyR s,       c`s‡fd†}|S(sΥ This decorator modifies the decorated function's docstring by replacing occurrences of '%(super)s' with the docstring of the method of the same name from the class `cls`. If the decorated method has no docstring, it is simply given the docstring of `cls`s method. Parameters ---------- cls : Python class or instance A class with a method with the same name as the decorated method. The docstring of the method in this class replaces '%(super)s' in the docstring of the decorated method. Returns ------- f : function The decorator function that modifies the __doc__ attribute of its argument. Examples -------- In the following, the docstring for Bar.func created using the docstring of `Foo.func`. >>> class Foo(object): ... def func(self): ... '''Do something useful.''' ... return ... >>> class Bar(Foo): ... @inherit_docstring_from(Foo) ... def func(self): ... '''%(super)s ... Do it fast. ... ''' ... return ... >>> b = Bar() >>> b.func.__doc__ 'Do something useful. Do it fast. ' c`sVtˆ|jƒj}|j}|dkr6||_n|td|ƒ}||_|S(Ntsuper(tgetattrt__name__t__doc__R tdict(tfunct cls_docstringtfunc_docstringt new_docstring(tcls(s0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pyt_docts    ((R%R&((R%s0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pyRGs- cC`setj}xB|D]:}|jƒ}|rt|t|ƒt|ƒƒ}qqW|tjkradS|S(s) Minimum indent for all lines in line list >>> lines = [' one', ' two', ' three'] >>> indentcount_lines(lines) 1 >>> lines = [] >>> indentcount_lines(lines) 0 >>> lines = [' one'] >>> indentcount_lines(lines) 1 >>> indentcount_lines([' ']) 0 i(tsystmaxsizetlstriptminR (RtindentnoRtstripped((s0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pyR€s   &c`s(|rtˆƒ‰n‡fd†}|S(sΆ Return docstring decorator using docdict variable dictionary Parameters ---------- docdict : dictionary dictionary containing name, docstring fragment pairs unindent_params : {False, True}, boolean, optional If True, strip common indentation from all parameters in docdict Returns ------- decfunc : function decorator that applies dictionary to input function docstring c`st|jˆƒ|_|S(N(RR(tf(R(s0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pytdecorate­s(R(Rtunindent_paramsR.((Rs0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pyR™scC`s7i}x*|jƒD]\}}t|ƒ||>> unindent_string(' two') 'two' >>> unindent_string(' two\n three') 'two\n three' is (R R RR(RRRR((s0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pyR»s   (Rt __future__RRRR't__all__R RRRtTrueRRR(((s0/tmp/pip-build-7oUkmx/scipy/scipy/misc/doccer.pyts   ; 9