o
    Eôjî4  ã                   @   sœ  d Z ddlZddlZddlZddlmZmZ ddlm	Z	 ddl
mZmZmZmZmZmZmZmZmZmZmZmZmZmZ G dd„ de	ƒZG d	d
„ d
eddƒƒZe d¡Ze d¡Ze d¡Zeddejƒeddejƒeddejƒeddejƒeddejƒeddejƒeddejƒeddejƒeddej ƒeddej ƒeddej!ƒed d!ej!ƒgZ"G d"d#„ d#ƒZ#d$ej$e% d%efd&d'„Z&ej'd(fd)ed*ed+e%d%e%fd,d-„Z(dS ).zGoogle-style docstring parsing.é    N)ÚOrderedDictÚ
namedtuple)ÚIntEnumé   )ÚEXAMPLES_KEYWORDSÚPARAM_KEYWORDSÚRAISES_KEYWORDSÚRETURNS_KEYWORDSÚYIELDS_KEYWORDSÚ	DocstringÚDocstringExampleÚDocstringMetaÚDocstringParamÚDocstringRaisesÚDocstringReturnsÚDocstringStyleÚ
ParseErrorÚRenderingStylec                   @   s    e Zd ZdZdZ	 dZ	 dZdS )ÚSectionTypezTypes of sections.r   r   é   N)Ú__name__Ú
__module__Ú__qualname__Ú__doc__ÚSINGULARÚMULTIPLEÚSINGULAR_OR_MULTIPLE© r   r   úh/var/www/html/academy/tools/voices/clone/sv-venv/lib/python3.10/site-packages/docstring_parser/google.pyr      s    r   c                   @   s   e Zd ZdZdS )ÚSectionzA docstring section.N)r   r   r   r   r   r   r   r   r   (   s    r   ZSectionBaseztitle key typez\s*(.+?)\s*\(\s*(.*[^\s]+)\s*\)z.*\. Defaults to (.+)\.z(\s*[^:\s]+:)|([^:]*\]:.*)Ú	ArgumentsÚparamÚArgsZ
ParametersZParamsZRaisesÚraisesZ
ExceptionsZExceptZ
AttributesÚ	attributeZExampleÚexamplesZExamplesZReturnsÚreturnsZYieldsÚyieldsc                	   @   sª   e Zd ZdZ	ddejeje  fdd„Zdd„ Z	d	e
d
e
defdd„Zedede
defdd„ƒZedede
de
defdd„ƒZdefdd„Zd	eje
 defdd„ZdS )ÚGoogleParserz#Parser for Google-style docstrings.NTÚsectionsc                 C   s*   |st }dd„ |D ƒ| _|| _|  ¡  dS )zšSetup sections.

        :param sections: Recognized sections or None to defaults.
        :param title_colon: require colon after section title.
        c                 S   s   i | ]}|j |“qS r   )Útitle)Ú.0Úsr   r   r   Ú
<dictcomp>M   ó    z)GoogleParser.__init__.<locals>.<dictcomp>N)ÚDEFAULT_SECTIONSr)   Útitle_colonÚ_setup)Úselfr)   r0   r   r   r   Ú__init__C   s
   zGoogleParser.__init__c                 C   sH   | j rd}nd}tjdd dd„ | jD ƒ¡ d | d tjd	�| _d S )
Nú:Ú z^(ú|c                 s   s   � | ]	}d |› d�V  qdS )ú(ú)Nr   )r+   Útr   r   r   Ú	<genexpr>X   s   € z&GoogleParser._setup.<locals>.<genexpr>r8   z	[ 	]*$©Úflags)r0   ÚreÚcompileÚjoinr)   ÚMÚ	titles_re)r2   Úcolonr   r   r   r1   Q   s   ÿþýüúzGoogleParser._setupÚtextr*   Úreturnc                 C   sì   | j | }|jtjkrt |¡r|jtjkr|  ||¡S d|vr(td|›d�ƒ‚| 	dd¡\}}|rEd|v rE| 	dd¡\}}|t
 |¡ }|ro|d dkrS|dd… n|}d|v rj| 	dd¡\}}|d t
 |¡ }| d¡}|  |||¡S )	z™Build docstring element.

        :param text: docstring element text
        :param title: title of section containing element
        :return:
        r4   zExpected a colon in Ú.r   Ú
r   ú N)r)   Útyper   r   ÚMULTIPLE_PATTERNÚmatchr   Ú_build_single_metar   ÚsplitÚinspectÚcleandocÚstripÚ_build_multi_meta)r2   rC   r*   ÚsectionÚbeforeÚdescÚ
first_lineÚrestr   r   r   Ú_build_meta_   s&   
ÿ
zGoogleParser._build_metarQ   rS   c                 C   s‚   | j ttB v rt| j g|d | j tv d�S | j tv r"t| j g|d d�S | j tv r0t| j gd |d�S | j tv r9t	dƒ‚t
| j g|d�S )N©ÚargsÚdescriptionÚ	type_nameÚis_generator©rX   rY   rZ   )rX   ÚsnippetrY   zExpected paramenter name.©rX   rY   )Úkeyr	   r
   r   r   r   r   r   r   r   r   )rQ   rS   r   r   r   rK   ƒ   s$   ü

ÿ

ÿ
zGoogleParser._build_single_metarR   c                 C   s  | j tv rUt |¡}|r3| dd¡\}}| d¡r"d}|d d… }n| d¡r0d}|d d… }n
d}n|d }}d }t |¡}|rF| d¡nd }t| j |g|||||d	�S | j tt	B v rjt
| j |g||| j t	v d
�S | j tv ryt| j |g||d�S t| j |g|d�S )Nr   r   ú
, optionalTiöÿÿÿÚ?éÿÿÿÿF)rX   rY   Úarg_namerZ   Úis_optionalÚdefaultrW   r\   r^   )r_   r   ÚGOOGLE_TYPED_ARG_REGEXrJ   ÚgroupÚendswithÚGOOGLE_ARG_DESC_REGEXr   r	   r
   r   r   r   r   )rQ   rR   rS   rJ   rc   rZ   rd   re   r   r   r   rP   ˜   sF   





úü
ÿzGoogleParser._build_multi_metac                 C   s   || j |j< |  ¡  dS )zLAdd or replace a section.

        :param section: The new section.
        N)r)   r*   r1   )r2   rQ   r   r   r   Úadd_sectionÄ   s   zGoogleParser.add_sectionc                 C   sæ  t tjd�}|s
|S t |¡}| j |¡}|r(|d| ¡ … }|| ¡ d… }n|}d}| dd¡}|d p7d|_	t
|ƒdkrX|d pDd}| d¡|_| d¡|_| ¡ pVd|_t| j |¡ƒ}|sd|S g }	tt
|ƒd ƒD ]}
|	 ||
  ¡ ||
d   ¡ f¡ qn|	 |d  ¡ t
|ƒf¡ tƒ }t|	ƒD ]2\}
\}}||
  d¡}|| jvr©q–|||… }t d	|¡}|durÁ|d| ¡ … }| d¡||< q–|sÍ|S | ¡ D ]Ÿ\}}t d
|¡}|såtd|› d�ƒ‚| ¡ }| j| jtjtj fv �rt |¡}|j! |  "||¡¡ qÑd| d }ttj||tj#d�ƒ}|�s%td|› d|› d�ƒ‚g }tt
|ƒd ƒD ]}
| ||
  ¡ ||
d   ¡ f¡ �q/| |d  ¡ t
|ƒf¡ t|ƒD ]\}
\}}|||…  d¡}|j! |  "||¡¡ �qUqÑ|S )zbParse the Google-style docstring into its components.

        :returns: parsed docstring
        )ÚstyleNr5   rF   r   r   z

rb   z\n\Sz^\s*zCan't infer indent from "ú"ú^z(?=\S)r;   zNo specification for "z": ")$r   r   ÚGOOGLErM   rN   rA   ÚsearchÚstartrL   Úshort_descriptionÚlenÚ
startswithÚblank_after_short_descriptionrh   Úblank_after_long_descriptionrO   Úlong_descriptionÚlistÚfinditerÚrangeÚappendÚendr   Ú	enumeraterg   r)   r=   Úitemsr   rH   r   r   r   ÚmetarV   r@   )r2   rC   ÚretrJ   Ú
desc_chunkÚ
meta_chunkÚpartsÚlong_desc_chunkÚmatchesÚsplitsÚjÚchunksrp   r{   r*   Zmeta_detailsZunknown_metaÚchunkZindent_matchÚindentÚpartÚ_reZ	c_matchesZc_splitsr   r   r   ÚparseÍ   s~   
ÿ$

þ
&þzGoogleParser.parse)NT)r   r   r   r   ÚTÚOptionalÚListr   r3   r1   Ústrr   rV   ÚstaticmethodrK   rP   rj   r   rŒ   r   r   r   r   r(   @   s,    ÿ
ÿ$ÿÿÿþ+	r(   rC   rD   c                 C   s   t ƒ  | ¡S )zZParse the Google-style docstring into its components.

    :returns: parsed docstring
    )r(   rŒ   )rC   r   r   r   rŒ   (  s   rŒ   z    Ú	docstringÚrendering_styler‰   c                    sä  dt jtttf f‡ ‡‡fdd„‰dtdt jt j f‡‡fdd„}g ‰| jr,ˆ 	| j¡ | j
r4ˆ 	d¡ | jr=ˆ 	| j¡ | jrEˆ 	d¡ |d	d
d„ | jpNg D ƒƒ |ddd„ | jp[g D ƒƒ |ddd„ | jphg D ƒƒ |ddd„ | jpug D ƒƒ |d| jpg ƒ | jr¢| js¢| j}ˆ 	|r�dnd¡ ˆ 	dtˆd ƒ ¡ ˆ|ƒ | jD ]7}t|tttfƒr°q¥ˆ 	|jd  dd¡ ¡ d ¡ |jr×‡ fdd„|j ¡ D ƒ}ˆ 	d |¡¡ ˆ 	d¡ q¥ˆríˆd síˆ ¡  ˆríˆd rãd ˆ¡S )a  Render a parsed docstring into docstring text.

    :param docstring: parsed docstring representation
    :param rendering_style: the style to render docstrings
    :param indent: the characters used as indentation in the docstring string
    :returns: docstring text
    Úonec                    s<  d}t | tƒr|| jpd7 }nt | tƒr|| jpd7 }t | tƒr-| jr-ˆtjkr*dnd}nd}| jr@|r@|d| j› |› d�7 }n| jrN|| j› |› d�7 }n|d7 }ˆ | }| j	ruˆtj
krudˆ › ˆ › � |g| j	 ¡  ¡}ˆ |¡ d S | j	r—| j	 ¡ ^}}dˆ › ˆ › � |d | g| ¡}ˆ |¡ d S ˆ |¡ d S )	Nr5   ra   r`   z (z):r4   rF   rG   )Ú
isinstancer   rc   r   Úreturn_namerd   r   ÚCOMPACTrZ   rY   ÚEXPANDEDr?   Ú
splitlinesrz   )r”   ÚheadÚoptionalÚbodyÚfirstrU   )r‰   r‚   r“   r   r   Úprocess_one=  s6   


ÿý
ÿ"zcompose.<locals>.process_oneÚnamerX   c                    s2   |rˆ   | ¡ |D ]}ˆ|ƒ q	ˆ   d¡ d S d S )Nr5   )rz   )rŸ   rX   Úarg)r‚   rž   r   r   Úprocess_sectd  s   

üzcompose.<locals>.process_sectr5   zArgs:c                 S   ó   g | ]}|j d  dkr|‘qS )r   r!   ©rX   ©r+   Úpr   r   r   Ú
<listcomp>w  ó    zcompose.<locals>.<listcomp>zAttributes:c                 S   r¢   )r   r$   r£   r¤   r   r   r   r¦   |  r§   zReturns:c                 S   s   g | ]}|j s|‘qS r   ©r[   r¤   r   r   r   r¦   �  ó    zYields:c                 S   s   g | ]}|j r|‘qS r   r¨   r¤   r   r   r   r¦   …  r©   zRaises:ú-rb   r   Ú_r4   c                    s   g | ]}ˆ | ‘qS r   r   )r+   Úl)r‰   r   r   r¦   —  r.   rF   )r�   ÚUnionr   r   r   r�   r�   ÚAnyrq   rz   rt   rv   ru   ÚparamsÚmany_returnsr#   r&   rr   r~   r•   rX   Úreplacer*   rY   r™   r?   Úpop)r’   r“   r‰   r¡   r   r~   Úlinesr   )r‰   r‚   rž   r“   r   Úcompose0  s^   ÿ '

ÿþþÿ

ÿ ÿ
r´   ))r   rM   r=   Útypingr�   Úcollectionsr   r   Úenumr   Úcommonr   r   r   r	   r
   r   r   r   r   r   r   r   r   r   r   r   r>   rf   ri   rI   r   r   r   r/   r(   rŽ   r�   rŒ   r—   r´   r   r   r   r   Ú<module>   sN    @


ô i
ýÿþýü