4[g RdZddlZgdZd dZdZdZdZdZdd Zd Z d Z d Z y)zk Utilities to allow inserting docstring fragments for common parameters into function and method docstringsN) docformatinherit_docstring_fromindentcount_linesfilldoc unindent_dictunindent_stringextend_notes_in_docstringreplace_notes_in_docstring doc_replacec|s|S|i}|s|S|jj}t|dkrd}nt|dd}d|z}i}|j D]\\}}|jj} |dg}|ddD]} |j || zdj |||<^||zS#t$r|||<YtwxYw)aV Fill a function docstring from variables in dictionary Adapt the indent of the inserted docs Parameters ---------- docstring : string docstring from function, possibly with dict formatting strings docdict : dict, optional dictionary with keys that match the dict formatting strings and values that are docstring fragments to be inserted. The indentation of the inserted docstrings is set to match the minimum indentation of the ``docstring`` by adding this indentation to all lines of the inserted string, except the first. Returns ------- outstring : string string with requested ``docdict`` strings inserted Examples -------- >>> 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' Nr  ) expandtabs splitlineslenritemsappendjoin IndexError) docstringdocdictlinesicountindentindentednamedstrnewlineslines L/var/www/html/bid-api/venv/lib/python3.12/site-packages/scipy/_lib/doccer.pyrr s@    " - - /E 5zA~"59- 6\FHmmo d!,,. "azHab t ,"!YYx0HTN & x  "!HTN "s8CCCcfd}|S)a 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: ... 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. ' ct|jj}|j}| ||_|S|t|z}||_|S)N)super)getattr__name____doc__dict)func cls_docstringfunc_docstring new_docstringclss r"_docz$inherit_docstring_from.._docusST]]3;;   !(DL +T -FFM(DL )r.r/s` r"rrHsZ Kr0cfd}|S)z This decorator replaces the decorated function's docstring with the docstring from corresponding method in `cls`. It extends the 'Notes' section of that docstring to include the given `notes`. ct|jj}||S|jd}|dk(r!|jd}|dk(r t |}|d|z||dz|_|S)N References  Examples r&r'r(findr)r*r+ end_of_notesr.notess r"r/z'extend_notes_in_docstring.._docsT]]3;;   K$))*@A 2 (--.BCLr!"=1 %m|4u<%lm45  r0r1r.r:r/s`` r"r r s  Kr0cfd}|S)z This decorator replaces the decorated function's docstring with the docstring from corresponding method in `cls`. It replaces the 'Notes' section of that docstring with the given `notes`. c"t|jj}d}||S|j|}|jd}|dk(r!|jd}|dk(r t |}|d|t |zz||dz|_|S)Nz Notes ----- r4r5r6r7)r*r+ notes_headerstart_of_notesr9r.r:s r"r/z(replace_notes_in_docstring.._docsT]]3;; 7   K&++L9$))*@A 2 (--.BCLr!"=1 %&I~L8I'IJ%lm45  r0r1r;s`` r"r r s" Kr0ctj}|D]6}|j}|st|t |t |z }8|tjk(ry|S)a) 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 r)sysmaxsizelstripminr)rindentnor!strippeds r"rrsT{{H;;= 8SYX%>?H3;; Or0c,|r tfd}|S)a 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>t|j|_|SN)rr()frs r"decoratezfilldoc..decoratesaii1 r0)r)runindent_paramsrKs` r"rrs"( Or0cVi}|jD]\}}t|||<|S)z# Unindent all strings in a docdict )rr)rcan_dictrrs r"rrs.Hmmo d(.& Or0c|jj}t|}|dk(r|Sdj|Dcgc]}||d c}Scc}w)z Set docstring to minimum indent for all lines, including first >>> unindent_string(' two') 'two' >>> unindent_string(' two\n three') 'two\n three' rrN)rrrr)rrrr!s r"rrsY  " - - /E u %F { 996d67m6 776s AcR|jxsdj||fd}|S)aDecorator to take the docstring from obj, with oldval replaced by newval Equivalent to ``func.__doc__ = obj.__doc__.replace(oldval, newval)`` Parameters ---------- obj : object The object to take the docstring from. oldval : string The string to replace from the original docstring. newval : string The string to replace ``oldval`` with. c|_|SrI)r()r*docs r"innerzdoc_replace..inners  r0)r(replace)objoldvalnewvalrTrSs @r"r r s, ;; " % %ff 5C Lr0rI)T) r(rA__all__rrr r rrrrr r1r0r"rZsE2  8 v6r0624 8r0