util.cpython-312.pyc•5.66 kB
�
lMg� � � � d Z ddlZddlmZ ddlmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZ ddlmZmZ ej$ d ej& f Ze sJ �d
e
j* ej, d �d ed
ej. ej0 e
de
dedef
d�Zy)z.Utility functions for working with docstrings.� N)�ChainMap)� Signature)�chain� )�
DocstringMeta�DocstringParam�DocstringReturns�DocstringStyle�RenderingStyle)�compose�parse.� )�exclude�style�rendering_style�othersr r r �returnc �8 � ���� dt dt f� ���fd� }|S )aq A 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
<BLANKLINE>
long_description: fun2
<BLANKLINE>
: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
<BLANKLINE>
long_description: fun2
<BLANKLINE>
: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.
�funcr c � �� t j | � }t | j xs d� }�
D �cg c] }t |j xs d� �� c}|gz }t t d� |D � � � }t
|� D ]2 }|j s�|j |_ |j |_ n t
|� D ]2 }|j s�|j |_ |j |_
n i }|D ]c }i }|j D ]3 } t | � }
|
� v r�|j |
g � j | � �5 |j � D ]
\ }
} | ||
< � �e |j D � cg c] } | |v s�|| �� c} |t" < t% t' |j) � � � |_ t+ |���� | _ | S c c}w c c} w )N� c 3 �p K � | ]) }|j D �ci c] }|j |�� c}�� �+ y c c}w �w)N)�params�arg_name)�.0�doc�params �aC:\Users\noahv\Documents\GitHub\clickup-operator\.venv\Lib\site-packages\docstring_parser/util.py� <genexpr>z6combine_docstrings.<locals>.wrapper.<locals>.<genexpr>c s: � �� � � #�� 9<�
�
�C�
�u�U�^�^�U�*�
�C� #�� D�s �6�1�
6)r r )r �
from_callabler
�__doc__�dictr �reversed�short_description� blank_after_short_description�long_description� blank_after_long_description�meta�type�
setdefault�append�items�
parametersr �listr �valuesr )r �sig�comb_doc�other�docsr r �combined�metasr( � meta_type�namer r r r s ����r �wrapperz#combine_docstrings.<locals>.wrapper\ s� �� ��%�%�d�+���� � �+��,��8>�?��u��e�m�m�)�r�*��?�8�*�L��� �� #��
�
�� �D�>�C��(�(��),�)>�)>�H� &��1�1�
� 2�
� "� �D�>�C��'�'��(+�(<�(<�H� %��0�0�
� 1�
� "� ���C��E����� ��J� � ��'� �� � ��B�/�6�6�t�<� !�
&+�[�[�]�!��D�&*���#� &3� � &)�^�^�$
�%3�T�t�v�~�F�4�L�^�$
�� � � �U�H�O�O�$5� 6�7��
� � �E�?�
�� � � ��] @��N$
s � F?�+ G�5G)�_Func)r r r r r8 s ```` r �combine_docstringsr: s$ �� �N2�e� 2�� 2� 2�h �N� )r! �typing�T� collectionsr �inspectr � itertoolsr �commonr r r r
r �parserr r
�Callable�Anyr9 �AUTO�COMPACT�Iterable�Typer: r r; r �<module>rI s� �� 4� � � � �� � #� �
�
�3����:� ��� ��
24� *� /� /�&4�&<�&<� {�
�{�
�Z�Z����}�-�
.�{� �{� $� {�
� {r;