o
    Eôj°  ã                   @   sè   d Z ddlZddlZh d£Zh d£ZddhZddhZd	d
hZddhZ	G dd„ de
ƒZG dd„ dejƒZG dd„ dejƒZG dd„ dƒZG dd„ deƒZG dd„ deƒZG dd„ deƒZG dd„ deƒZG dd„ deƒZG dd „ d ƒZdS )!zCommon methods for parsing.é    N>   Ú	parameterÚparamÚkeyÚ	attributeÚargÚkeywordÚargument>   ÚraiseÚ	exceptionÚraisesÚexceptÚdeprecationÚ
deprecatedÚreturnÚreturnsÚyieldZyieldsÚexampleÚexamplesc                   @   s   e Zd ZdZdS )Ú
ParseErrorz*Base class for all parsing related errors.N)Ú__name__Ú
__module__Ú__qualname__Ú__doc__© r   r   úh/var/www/html/academy/tools/voices/clone/sv-venv/lib/python3.10/site-packages/docstring_parser/common.pyr      s    r   c                   @   s$   e Zd ZdZdZdZdZdZdZdS )ÚDocstringStylezDocstring style.é   é   é   é   éÿ   N)	r   r   r   r   ZRESTZGOOGLEZNUMPYDOCZEPYDOCÚAUTOr   r   r   r   r      s    r   c                   @   s   e Zd ZdZdZdZdZdS )ÚRenderingStylez1Rendering style when unparsing parsed docstrings.r   r   r   N)r   r   r   r   ZCOMPACTZCLEANZEXPANDEDr   r   r   r   r"   $   s
    r"   c                   @   s2   e Zd ZdZdeje deje ddfdd„ZdS )ÚDocstringMetaz“Docstring meta information.

    Symbolizes lines in form of

        :param arg: description
        :raises ValueError: if something happens
    ÚargsÚdescriptionr   Nc                 C   s   || _ || _dS )a,  Initialize self.

        :param args: list of arguments. The exact content of this variable is
            dependent on the kind of docstring; it's used to distinguish
            between custom docstring meta information items.
        :param description: associated docstring description.
        N)r$   r%   )Úselfr$   r%   r   r   r   Ú__init__5   s   

zDocstringMeta.__init__)	r   r   r   r   ÚTÚListÚstrÚOptionalr'   r   r   r   r   r#   ,   s    ÿÿþr#   c                       s\   e Zd ZdZdeje deje dedeje deje deje dd	f‡ fd
d„Z	‡  Z
S )ÚDocstringParamz*DocstringMeta symbolizing :param metadata.r$   r%   Úarg_nameÚ	type_nameÚis_optionalÚdefaultr   Nc                    s*   t ƒ  ||¡ || _|| _|| _|| _dS ©úInitialize self.N)Úsuperr'   r-   r.   r/   r0   )r&   r$   r%   r-   r.   r/   r0   ©Ú	__class__r   r   r'   F   s
   

zDocstringParam.__init__©r   r   r   r   r(   r)   r*   r+   Úboolr'   Ú__classcell__r   r   r4   r   r,   C   s"    þýüûúùør,   c                       sV   e Zd ZdZ	ddeje deje deje dedeje ddf‡ fd	d
„Z	‡  Z
S )ÚDocstringReturnsz7DocstringMeta symbolizing :returns or :yields metadata.Nr$   r%   r.   Úis_generatorÚreturn_namer   c                    s$   t ƒ  ||¡ || _|| _|| _dS r1   )r3   r'   r.   r:   r;   )r&   r$   r%   r.   r:   r;   r4   r   r   r'   Z   s   	
zDocstringReturns.__init__©Nr6   r   r   r4   r   r9   W   s     úþýüûúùr9   c                       óD   e Zd ZdZdeje deje deje ddf‡ fdd„Z‡  Z	S )	ÚDocstringRaisesz+DocstringMeta symbolizing :raises metadata.r$   r%   r.   r   Nc                    ó   t ƒ  ||¡ || _|| _dS r1   )r3   r'   r.   r%   )r&   r$   r%   r.   r4   r   r   r'   l   ó   
zDocstringRaises.__init__©
r   r   r   r   r(   r)   r*   r+   r'   r8   r   r   r4   r   r>   i   ó    þýüûr>   c                       r=   )	ÚDocstringDeprecatedz/DocstringMeta symbolizing deprecation metadata.r$   r%   Úversionr   Nc                    r?   r1   )r3   r'   rD   r%   )r&   r$   r%   rD   r4   r   r   r'   {   r@   zDocstringDeprecated.__init__rA   r   r   r4   r   rC   x   rB   rC   c                       r=   )	ÚDocstringExamplez+DocstringMeta symbolizing example metadata.r$   Úsnippetr%   r   Nc                    s   t ƒ  ||¡ || _|| _dS r1   )r3   r'   rF   r%   )r&   r$   rF   r%   r4   r   r   r'   Š   r@   zDocstringExample.__init__rA   r   r   r4   r   rE   ‡   rB   rE   c                   @   sÈ   e Zd ZdZ	d	ddd„Zedeje fdd„ƒZ	edej
e fdd	„ƒZedej
e fd
d„ƒZedeje fdd„ƒZedej
e fdd„ƒZedeje fdd„ƒZedej
e fdd„ƒZdS )Ú	Docstringz Docstring object representation.Nr   c                 C   s(   d| _ d| _d| _d| _g | _|| _dS )r2   NF)Úshort_descriptionÚlong_descriptionÚblank_after_short_descriptionZblank_after_long_descriptionÚmetaÚstyle)r&   rL   r   r   r   r'   ™   s   
zDocstring.__init__c                 C   sJ   g }| j r| | j ¡ | jr| d¡ | jr| | j¡ |s dS d |¡S )z{Return the full description of the function

        Returns None if the docstring did not include any description
        Ú NÚ
)rH   ÚappendrJ   rI   Újoin)r&   Úretr   r   r   r%   ¥   s   

zDocstring.descriptionc                 C   ó   dd„ | j D ƒS )z0Return a list of information on function params.c                 S   ó   g | ]	}t |tƒr|‘qS r   )Ú
isinstancer,   ©Ú.0Úitemr   r   r   Ú
<listcomp>»   s    z$Docstring.params.<locals>.<listcomp>©rK   ©r&   r   r   r   Úparams¸   s   zDocstring.paramsc                 C   rR   )z\Return a list of information on the exceptions that the function
        may raise.
        c                 S   rS   r   )rT   r>   rU   r   r   r   rX   Â   ó
    
ÿÿz$Docstring.raises.<locals>.<listcomp>rY   rZ   r   r   r   r   ½   s   ÿzDocstring.raisesc                 C   ó"   | j D ]}t|tƒr|  S qdS )zeReturn a single information on function return.

        Takes the first return information.
        N)rK   rT   r9   ©r&   rW   r   r   r   r   Æ   s
   

ÿzDocstring.returnsc                 C   rR   )z0Return a list of information on function return.c                 S   rS   r   )rT   r9   rU   r   r   r   rX   Ô   r\   z*Docstring.many_returns.<locals>.<listcomp>rY   rZ   r   r   r   Úmany_returnsÑ   ó   ÿzDocstring.many_returnsc                 C   r]   )z:Return a single information on function deprecation notes.N)rK   rT   rC   r^   r   r   r   r   Ø   s
   

ÿzDocstring.deprecationc                 C   rR   )z2Return a list of information on function examples.c                 S   rS   r   )rT   rE   rU   r   r   r   rX   ã   r\   z&Docstring.examples.<locals>.<listcomp>rY   rZ   r   r   r   r   à   r`   zDocstring.examplesr<   )r   N)r   r   r   r   r'   Úpropertyr(   r+   r*   r%   r)   r,   r[   r>   r   r9   r   r_   rC   r   rE   r   r   r   r   r   rG   –   s(    þ
ý
rG   )r   ÚenumÚtypingr(   ZPARAM_KEYWORDSZRAISES_KEYWORDSZDEPRECATION_KEYWORDSZRETURNS_KEYWORDSZYIELDS_KEYWORDSZEXAMPLES_KEYWORDSÚRuntimeErrorr   ÚEnumr   r"   r#   r,   r9   r>   rC   rE   rG   r   r   r   r   Ú<module>   s&    	
