
    ZOg                     *   S r SSKrSSKr1 Skr1 SkrSS1rSS1rS	S
1r " S S\	5      r
 " S S\R                  5      r " S S\R                  5      r " S S5      r " S S\5      r " S S\5      r " S S\5      r " S S\5      r " S S5      rg)zCommon methods for parsing.    N>   argkeyparamkeywordargument	attribute	parameter>   raiseexceptraises	exceptiondeprecation
deprecatedreturnreturnsyieldyieldsc                       \ rS rSrSrSrg)
ParseError   z*Base class for all parsing related errors. N)__name__
__module____qualname____firstlineno____doc____static_attributes__r       \/Users/admin/workspace/ai/Jarvis/env/lib/python3.13/site-packages/docstring_parser/common.pyr   r      s    4r   r   c                   ,    \ rS rSrSrSrSrSrSrSr	Sr
g	)
DocstringStyle   zDocstring style.               r   N)r   r   r   r   r   RESTGOOGLENUMPYDOCEPYDOCAUTOr   r   r   r   r!   r!      s    DFHFDr   r!   c                   $    \ rS rSrSrSrSrSrSrg)RenderingStyle"   z1Rendering style when unparsing parsed docstrings.r#   r$   r%   r   N)	r   r   r   r   r   COMPACTCLEANEXPANDEDr   r   r   r   r.   r.   "   s    ;GEHr   r.   c                   b    \ rS rSrSrS\R                  \   S\R                  \   SS4S jr	Sr
g)	DocstringMeta*   zDocstring meta information.

Symbolizes lines in form of

    :param arg: description
    :raises ValueError: if something happens
argsdescriptionr   Nc                     Xl         X l        g)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r6   r7   )selfr6   r7   s      r   __init__DocstringMeta.__init__3   s     	&r   r9   )r   r   r   r   r   TListstrOptionalr;   r   r   r   r   r4   r4   *   s4    'FF3K'./jjo'	'r   r4   c                      ^  \ rS rSrSrS\R                  \   S\R                  \   S\S\R                  \   S\R                  \	   S\R                  \   S	S
4U 4S jjr
SrU =r$ )DocstringParamA   z*DocstringMeta symbolizing :param metadata.r6   r7   arg_name	type_nameis_optionaldefaultr   Nc                 T   > [         TU ]  X5        X0l        X@l        XPl        X`l        gInitialize self.N)superr;   rD   rE   rF   rG   )r:   r6   r7   rD   rE   rF   rG   	__class__s          r   r;   DocstringParam.__init__D   s'     	+ "&r   )rD   rG   rF   rE   r   r   r   r   r   r=   r>   r?   r@   boolr;   r   __classcell__rL   s   @r   rB   rB   A   s}    4ffSk ZZ_ 	
 ::c? ZZ% C 
 r   rB   c                      ^  \ rS rSrSr SS\R                  \   S\R                  \   S\R                  \   S\	S\R                  \   S	S4U 4S
 jjjr
SrU =r$ )DocstringReturnsU   z7DocstringMeta symbolizing :returns or :yields metadata.Nr6   r7   rE   is_generatorreturn_namer   c                 H   > [         TU ]  X5        X0l        X@l        XPl        grI   )rK   r;   rE   rU   rV   )r:   r6   r7   rE   rU   rV   rL   s         r   r;   DocstringReturns.__init__X   s#     	+"(&r   )rU   rV   rE   NrN   rQ   s   @r   rS   rS   U   so    A (,'ffSk' ZZ_' ::c?	'
 ' ZZ_' 
' 'r   rS   c                      ^  \ rS rSrSrS\R                  \   S\R                  \   S\R                  \   SS4U 4S jjr	S	r
U =r$ )
DocstringRaisesg   z+DocstringMeta symbolizing :raises metadata.r6   r7   rE   r   Nc                 <   > [         TU ]  X5        X0l        X l        grI   )rK   r;   rE   r7   )r:   r6   r7   rE   rL   s       r   r;   DocstringRaises.__init__j   s     	+"&r   )r7   rE   r   r   r   r   r   r=   r>   r?   r@   r;   r   rP   rQ   s   @r   r[   r[   g   sN    5	'ffSk	' ZZ_	' ::c?		'
 
	' 	'r   r[   c                      ^  \ rS rSrSrS\R                  \   S\R                  \   S\R                  \   SS4U 4S jjr	S	r
U =r$ )
DocstringDeprecatedv   z/DocstringMeta symbolizing deprecation metadata.r6   r7   versionr   Nc                 <   > [         TU ]  X5        X0l        X l        grI   )rK   r;   rc   r7   )r:   r6   r7   rc   rL   s       r   r;   DocstringDeprecated.__init__y   s     	+&r   )r7   rc   r_   rQ   s   @r   ra   ra   v   sN    9	'ffSk	' ZZ_	' C		'
 
	' 	'r   ra   c                   $   \ rS rSrSr S SS jjr\S\R                  \	   4S j5       r
\S\R                  \   4S j5       r\S\R                  \   4S j5       r\S\R                  \   4S	 j5       r\S\R                  \   4S
 j5       rSrg)	Docstring   z Docstring object representation.Nr   c                 V    SU l         SU l        SU l        SU l        / U l        Xl        g)rJ   NF)short_descriptionlong_descriptionblank_after_short_descriptionblank_after_long_descriptionmetastyle)r:   ro   s     r   r;   Docstring.__init__   s0    
 "& $-2*,1)	
r   c                 t    U R                    Vs/ s H  n[        U[        5      (       d  M  UPM     sn$ s  snf )z0Return a list of information on function params.)rn   
isinstancerB   r:   items     r   paramsDocstring.params   s)     "&Oj~.NOOO   55c                 t    U R                    Vs/ s H  n[        U[        5      (       d  M  UPM     sn$ s  snf )zLReturn a list of information on the exceptions that the function
may raise.
)rn   rr   r[   rs   s     r   r   Docstring.raises   s2     "YY
&T*T?*KDY
 	
 
rw   c                 \    U R                    H  n[        U[        5      (       d  M  Us  $    g)zUReturn a single information on function return.

Takes the first return information.
Nrn   rr   rS   rs   s     r   r   Docstring.returns   s*     IID$ 011  r   c                 t    U R                    Vs/ s H  n[        U[        5      (       d  M  UPM     sn$ s  snf )z0Return a list of information on function return.r{   rs   s     r   many_returnsDocstring.many_returns   s3     "YY
&T*T;K*LDY
 	
 
rw   c                 \    U R                    H  n[        U[        5      (       d  M  Us  $    g)z:Return a single information on function deprecation notes.N)rn   rr   ra   rs   s     r   r   Docstring.deprecation   s*     IID$ 344  r   )rm   rl   rk   rn   rj   ro   rY   )r   N)r   r   r   r   r   r;   propertyr=   r>   rB   ru   r[   r   r@   rS   r   r~   ra   r   r   r   r   r   rg   rg      s    * 
 

 P~. P P 
/ 
 
 $45   
aff%56 
 
 QZZ(;<  r   rg   )r   enumtypingr=   PARAM_KEYWORDSRAISES_KEYWORDSDEPRECATION_KEYWORDSRETURNS_KEYWORDSYIELDS_KEYWORDSRuntimeErrorr   Enumr!   r.   r4   rB   rS   r[   ra   rg   r   r   r   <module>r      s    !   =%|4 i( H%5 5TYY TYY ' '.] ('} '$'m ''- '5 5r   