o ]i @sdZddlZddlmZddlmZddlmZddl m Z m Z m Z m Z mZddlmZmZejd ejfZe s:Jd e jejd d ed ejeje de dedef ddZdS)z.Utility functions for working with docstrings.N)ChainMap) Signature)chain) DocstringMetaDocstringParamDocstringReturnsDocstringStyleRenderingStyle)composeparse.)excludestylerendering_styleothersrrrreturncs dtdtffdd }|S)aqA function decorator that parses the docstrings from `others`, programmatically combines them with the parsed docstring of the decorated function, and replaces the docstring of the decorated function with the composed result. Only parameters that are part of the decorated functions signature are included in the combined docstring. When multiple sources for a parameter or docstring metadata exists then the decorator will first default to the wrapped function's value (when available) and otherwise use the rightmost definition from ``others``. The following example illustrates its usage: >>> def fun1(a, b, c, d): ... '''short_description: fun1 ... ... :param a: fun1 ... :param b: fun1 ... :return: fun1 ... ''' >>> def fun2(b, c, d, e): ... '''short_description: fun2 ... ... long_description: fun2 ... ... :param b: fun2 ... :param c: fun2 ... :param e: fun2 ... ''' >>> @combine_docstrings(fun1, fun2) >>> def decorated(a, b, c, d, e, f): ... ''' ... :param e: decorated ... :param f: decorated ... ''' >>> print(decorated.__doc__) short_description: fun2 long_description: fun2 :param a: fun1 :param b: fun1 :param c: fun2 :param e: fun2 :param f: decorated :returns: fun1 >>> @combine_docstrings(fun1, fun2, exclude=[DocstringReturns]) >>> def decorated(a, b, c, d, e, f): pass >>> print(decorated.__doc__) short_description: fun2 long_description: fun2 :param a: fun1 :param b: fun1 :param c: fun2 :param e: fun2 :param others: callables from which to parse docstrings. :param exclude: an iterable of ``DocstringMeta`` subclasses to exclude when combining docstrings. :param style: style composed docstring. The default will infer the style from the decorated function. :param rendering_style: The rendering style used to compose a docstring. :return: the decorated function with a modified docstring. funcrc s(t|}t|jp d}ddD|g}ttdd|Dt|D]}|js+q%|j|_|j|_t|D]}|j s>q8|j |_ |j |_ i}|D])}i}|j D]}t |}|vr]qR| |g|qR|D]\}}|||<qkqKfdd|jD|t<tt||_ t|d|_|S)NcSsg|] }t|jp dqS)r)r __doc__).0otherr r Z/var/www/html/stock_analysis/be/venv/lib/python3.10/site-packages/docstring_parser/util.py asz7combine_docstrings..wrapper..css |] }dd|jDVqdS)cSsi|]}|j|qSr )arg_name)rparamr r r eszAcombine_docstrings..wrapper...Nparams)rdocr r r ds  z6combine_docstrings..wrapper..csg|] }|vr|qSr r )rnamerr rrs )rr)r from_callabler rdictrreversedshort_descriptionblank_after_short_descriptionlong_descriptionblank_after_long_descriptionmetatype setdefaultappenditems parametersrlistrvaluesr ) rsigcomb_docdocsrcombinedmetasr) meta_typerrrrrrwrapper]sV       z#combine_docstrings..wrapper)_Func)rrrrr8r r7rcombine_docstringssG4r:)rtypingT collectionsrinspectr itertoolsrcommonrrrr r parserr r CallableAnyr9AUTOCOMPACTIterableTyper:r r r rs.