o
    ZhY                     @   s   d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl	m
Z
mZ ddlZddlZdd ZG dd	 d	ZG d
d deZedg dZG dd deZdd ZG dd deZG dd deZG dd deZdddZdS )z=Extract reference documentation from the NumPy source tree.

    N)warn)
namedtuple)CallableMappingc                 C   sP   | r| d   s| d= | r| d   r| r&| d   s&| d= | r&| d   r| S )z<Remove leading and trailing blank lines from a list of linesr   strip)l r
   Q/var/www/html/lang_env/lib/python3.10/site-packages/pyarrow/vendored/docscrape.pystrip_blank_lines   s   r   c                   @   sj   e Zd ZdZdd Zdd Zdd Zdd	 Zd
d Zdd Z	dd Z
dd Zdd ZdddZdd ZdS )Readerz!A line-based string reader.

    c                 C   s*   t |tr	|| _n|d| _|   dS )zs
        Parameters
        ----------
        data : str
           String with lines separated by '\n'.

        
N)
isinstancelist_strsplitreset)selfdatar
   r
   r   __init__#   s   
zReader.__init__c                 C   
   | j | S N)r   r   nr
   r
   r   __getitem__2      
zReader.__getitem__c                 C   s
   d| _ d S )Nr   )_lr   r
   r
   r   r   5   r   zReader.resetc                 C   s(   |   s| | j }|  jd7  _|S dS )N    )eofr   )r   outr
   r
   r   read8   s
   
zReader.readc                 C   s4   | | j d  D ]}| r d S |  j d7  _ qd S Nr   )r   r   )r   r	   r
   r
   r   seek_next_non_empty_line@   s
   zReader.seek_next_non_empty_linec                 C   s   | j t| jkS r   r   lenr   r   r
   r
   r   r!   G      z
Reader.eofc                 C   sb   | j }| |d  D ]%}||r| || j    S |  j d7  _ |  r.| || j d    S q	g S r$   )r   r!   )r   Zcondition_funcstartliner
   r
   r   read_to_conditionJ   s   zReader.read_to_conditionc                 C   s   |    dd }| |S )Nc                 S   s
   |    S r   r   r*   r
   r
   r   is_emptyW   r   z0Reader.read_to_next_empty_line.<locals>.is_empty)r%   r+   )r   r-   r
   r
   r   read_to_next_empty_lineT   s   
zReader.read_to_next_empty_linec                 C   s   dd }|  |S )Nc                 S   s   |   ot|  t| kS r   )r   r'   lstripr,   r
   r
   r   is_unindented]   s   z:Reader.read_to_next_unindented_line.<locals>.is_unindented)r+   )r   r0   r
   r
   r   read_to_next_unindented_line\   s   
z#Reader.read_to_next_unindented_liner   c                 C   s&   | j | t| jk r| | j |  S dS Nr    r&   r   r
   r
   r   peeka   s   zReader.peekc                 C   s   d | j  S r2   )joinr   r   r   r
   r
   r   r-   g      zReader.is_emptyN)r   )__name__
__module____qualname____doc__r   r   r   r#   r%   r!   r+   r.   r1   r3   r-   r
   r
   r
   r   r      s    

r   c                   @   s   e Zd Zdd ZdS )
ParseErrorc                 C   s&   | j d }t| drd|| jf }|S )Nr   	docstringz%s in %r)argshasattrr;   )r   messager
   r
   r   __str__l   s   

zParseError.__str__N)r6   r7   r8   r?   r
   r
   r
   r   r:   k   s    r:   	Parameter)nametypedescc                   @   s  e Zd ZdZi ddddgdg dg dg dg d	g d
g dg dg dg dg dg dg dg dddddi iZd`ddZdd Zdd Zdd Zdd Z	d d! Z
d"d# Zd$d% Zd&d' Zdad)d*Zd+Zd,Zd-Zd.e e d/ e d0 Zed1d2Zed3d4Zd5Zed6e d7 Zed8e d9 e d: d0 d; e Zd<Zd=d> Zd?d@ ZdAdB ZdCdD ZedEdF Z dbdHdIZ!dcdKdLZ"dddNdOZ#dPdQ Z$dRdS Z%dTdU Z&dVdW Z'dXdY Z(dZd[ Z)d\d] Z*ded^d_Z+dS )fNumpyDocStringzParses a numpydoc string to an abstract representation

    Instances define a mapping from section title to structured data.

    	Signaturer    SummaryExtended Summary
ParametersReturnsYieldsReceivesRaisesWarnsOther Parameters
AttributesMethodsSee AlsoNotesWarnings
ReferencesExamplesindexNc              
   C   s\   |}t |d}t|| _t| j| _z| 	  W d S  t
y- } z||_ d }~ww )Nr   )textwrapdedentr   r   _doccopydeepcopysections_parsed_data_parser:   r;   )r   r;   configZorig_docstringer
   r
   r   r      s   
zNumpyDocString.__init__c                 C   r   r   )r]   )r   keyr
   r
   r   r      r   zNumpyDocString.__getitem__c                 C   s.   || j vr| jd| dd d S || j |< d S )NzUnknown section %sFerror)r]   _error_location)r   ra   valr
   r
   r   __setitem__   s   
zNumpyDocString.__setitem__c                 C   
   t | jS r   )iterr]   r   r
   r
   r   __iter__   r   zNumpyDocString.__iter__c                 C   rg   r   )r'   r]   r   r
   r
   r   __len__   r   zNumpyDocString.__len__c                 C   s   | j   | j  rdS | j   }|drdS | j d }t|dkrSt|dhdhfv rSt|t|krSd| j j	d d	 d
 }| j
d|||f dd |dt| pd|dt| S )NF
.. index::Tr      -=r      z...z4potentially wrong underline length... 
%s 
%s in 
%srb   )rY   r%   r!   r3   r   
startswithr'   setr4   r   rd   )r   l1l2Zsnipr
   r
   r   _is_at_section   s   


0$zNumpyDocString._is_at_sectionc                 C   sb   d}d}t |D ]
\}}| r nqt |d d d D ]
\}}| r& nq||t||  S )Nr   r   )	enumerater   r'   )r   docijr*   r
   r
   r   _strip   s   zNumpyDocString._stripc                 C   sZ   | j  }|  s+| j  s+| j d s|dg7 }|| j  7 }|  s+| j  r|S )Nr   r    )rY   r.   rt   r!   r3   r   )r   sectionr
   r
   r   _read_to_next_section   s   

z$NumpyDocString._read_to_next_sectionc                 c   s|    | j  s<|  }|d  }|dr||dd  fV  nt|dk r)tV  n|| |dd  fV  | j  rd S d S )Nr   ..r   ro   )rY   r!   r{   r   rp   r'   StopIterationry   )r   r   rA   r
   r
   r   _read_sections   s   

zNumpyDocString._read_sectionsFc           	      C   s   t |}t|}g }| sQ|  }d|v r+|jddd\}}| | }}n|r3d|}}n|d}}| }t |}t|}|t	||| | r|S )Nz :r   )maxsplitr    )
dedent_linesr   r!   r#   r   r   r1   r   appendr@   )	r   contentsingle_element_is_typerparamsheaderarg_nameZarg_typerC   r
   r
   r   _parse_param_list   s"   
z NumpyDocString._parse_param_listz:(?P<role>(py:)?\w+):z'`(?P<name>(?:~\w+\.)?[a-zA-Z0-9_\.-]+)`z(?P<name2>[a-zA-Z0-9_\.-]+)(|)roleZrolenextrA   Znamenextz/(?P<description>\s*:(\s+(?P<desc>\S+.*))?)?\s*$z^\s*z\s*z^\s*(?P<allfuncs>z(?P<morefuncs>([,]\s+z)*)z(?P<trailing>[,\.])?r|   c                    s8  t |}g } fdd}g }|D ]   sqj }d}|r<|d}|dr<|r<jd|d f dd |sK d	rK|   q|rg }|d
}	 | sZn'||\}	}
}||	|
f ||d  }|r|d dkr|dd  }qUt	t
d|g}|||f qd  q|S )z
        func_name : Descriptive text
            continued text
        another_func_name : Descriptive text
        func_name1, func_name2, :meth:`func_name`, func_name3

        c                    sP   j | }|sd  |d}|r|dn|d}||| fS )zMatch ':role:`name`' or 'name'.Error parsing See Also entry r   rA   Zname2)	_func_rgxmatchrd   groupend)textmr   rA   r*   r   r
   r   parse_item_name-  s   
z7NumpyDocString._parse_see_also.<locals>.parse_item_nameNrC   ZtrailingzGUnexpected comma or period after function list at index %d of line "%s"Frb    ZallfuncsTr   ,r   r   )r   r   	_line_rgxr   r   rd   r   rp   r   r   filter)r   r   itemsr   restZ
line_matchdescriptionfuncsr   rA   r   Z	match_endr
   r   r   _parse_see_also   sH   		

zNumpyDocString._parse_see_alsoc                 C   sz   dd }i }| d}t|dkr||d  dd |d< |D ]}| d}t|d	kr:||d	  d||d < q |S )
zT
        .. index: default
           :refguide: something, else, and more

        c                 S   s   dd | D S )Nc                 S      g | ]}|  qS r
   r   .0sr
   r
   r   
<listcomp>^      zFNumpyDocString._parse_index.<locals>.strip_each_in.<locals>.<listcomp>r
   )lstr
   r
   r   strip_each_in]  s   z2NumpyDocString._parse_index.<locals>.strip_each_inz::r   r   r   default:ro   )r   r'   )r   rz   r   r   r"   r*   r
   r
   r   _parse_indexW  s   

zNumpyDocString._parse_indexc                 C   s   |   rdS 	 | j }ddd |D  }td}||r+|| d< |   s+q	 |dur4|| d< |   s@|  | d	< dS dS )
z%Grab signature (if given) and summaryNTr   c                 S   r   r
   r   r   r
   r
   r   r   r  r   z1NumpyDocString._parse_summary.<locals>.<listcomp>z^([\w., ]+=)?\s*[\w\.]+\(.*\)$rE   rF   rG   )	rt   rY   r.   r4   r   recompiler   r{   )r   summaryZsummary_strcompiledr
   r
   r   _parse_summaryj  s    


zNumpyDocString._parse_summaryc                 C   s<  | j   |   t|  }tdd |D }d|v }d|v }|r*|r*d}t||s6d|v r6d}t||D ]c\}}|dscd	d
 |dD }d	|}| 
|rc| d|d	| j jf  |dv ro| || |< q8|dv r}| j|dd| |< q8|dr| ||| d< q8|dkr| || d< q8|| |< q8d S )Nc                 S   s   g | ]\}}|qS r
   r
   )r   rz   r   r
   r
   r   r     r   z)NumpyDocString._parse.<locals>.<listcomp>rI   rJ   z5Docstring contains both a Returns and Yields section.rK   z5Docstring contains a Receives section but not Yields.r|   c                 s   s    | ]}|  V  qd S r   )
capitalizer   r
   r
   r   	<genexpr>  s    z(NumpyDocString._parse.<locals>.<genexpr>r   z#The section %s appears twice in  %sr   )rH   rN   rO   rP   )rI   rJ   rL   rM   rK   T)r   rk   rV   rQ   )rY   r   r   r   r~   rq   
ValueErrorrp   r   r4   getrd   r   r   r   r   )r   r\   Zsection_namesZhas_returnsZ
has_yieldsmsgrz   r   r
   r
   r   r^     s@   





zNumpyDocString._parsec                 C   s$   t | dr| jS t | dr| jS d S )N_cls_f)r=   r   r   r   r
   r
   r   _obj  s
   

zNumpyDocString._objTc                 C   st   | j d ur.zt| j }W n ty   d }Y nw |d| j j 7 }||r+d| dnd7 }|r4t|t| d S )Nz in the docstring of z in .r    )r   inspectgetsourcefile	TypeErrorr6   r   r   )r   r   rc   filenamer
   r
   r   rd     s   
zNumpyDocString._error_locationrm   c                 C   s   |t || gS r   )r'   )r   rA   symbolr
   r
   r   _str_header  r(   zNumpyDocString._str_header   c                    s    fdd|D S )Nc                    s   g | ]}d   | qS )r   r
   )r   r*   indentr
   r   r     s    z.NumpyDocString._str_indent.<locals>.<listcomp>r
   )r   rv   r   r
   r   r   _str_indent  r5   zNumpyDocString._str_indentc                 C   s&   | d r| d  ddgdg S dgS )NrE   *z\*r    )replacer   r
   r
   r   _str_signature  s   zNumpyDocString._str_signaturec                 C      | d r| d dg S g S )NrF   r    r
   r   r
   r
   r   _str_summary     zNumpyDocString._str_summaryc                 C   r   )NrG   r    r
   r   r
   r
   r   _str_extended_summary  r   z$NumpyDocString._str_extended_summaryc                 C   s   g }| | rH||  |7 }| | D ]1}g }|jr||j |jr'||j |d|g7 }|jrBd|j rB|| |j7 }q|dg7 }|S )Nz : r    )r   rA   r   rB   r4   rC   r   r   )r   rA   r"   parampartsr
   r
   r   _str_param_list  s   
zNumpyDocString._str_param_listc                 C   s4   g }| | r||  |7 }|| | 7 }|dg7 }|S r2   )r   )r   rA   r"   r
   r
   r   _str_section  s   
zNumpyDocString._str_sectionc           
      C   s   | d sg S g }||  d7 }|dg7 }d}| d D ]T\}}t|ts%J g }|D ]\}}|r6d||f }	n|r?d||f }	nd| }	||	 q)d|}	||	g7 }|rc|| d|g7 }d}qd}|| | jg7 }q|rv|dg7 }|dg7 }|S )	NrQ   r    Tz:%s:`%s`z`%s`_, r   F)r   r   r   r   r4   r   empty_description)
r   	func_roler"   Zlast_had_descr   rC   linksfuncr   linkr
   r
   r   _str_see_also  s6   




zNumpyDocString._str_see_alsoc                 C   sv   | d }g }d}| dd}|rd}|d| g7 }| D ]\}}|dkr&qd}|d|d|f g7 }q|r9|S dS )	NrV   Fr   r    Tz.. index:: %sz
   :%s: %sr   )r   r   r4   )r   idxr"   Zoutput_indexZdefault_indexrz   Z
referencesr
   r
   r   
_str_index  s   zNumpyDocString._str_indexc                 C   s   g }||   7 }||  7 }||  7 }dD ]	}|| |7 }q|| d7 }|| |7 }dD ]	}|| |7 }q0dD ]	}|| |7 }q<||  7 }d|S )N)rH   rI   rJ   rK   rN   rL   rM   rS   )rR   rT   rU   )rO   rP   r   )r   r   r   r   r   r   r   r4   )r   r   r"   Z
param_listr   r
   r
   r   r?     s   
zNumpyDocString.__str__r   )F)T)rm   )r   )r    ),r6   r7   r8   r9   r\   r   r   rf   ri   rj   rt   ry   r{   r~   r   _roleZ_funcbacktickZ
_funcplainZ	_funcnamer   Z_funcnamenextZ_descriptionr   r   r   r   r   r   r   r   r^   propertyr   rd   r   r   r   r   r   r   r   r   r   r?   r
   r
   r
   r   rD   v   s    	


'7&



 rD   c                 C   s   t d| dS )z"Deindent a list of lines maximallyr   )rW   rX   r4   r   )linesr
   r
   r   r   .  s   r   c                       s.   e Zd Zd	ddZdd Z fddZ  ZS )
FunctionDocr   Nc                 C   sP   || _ || _|d u r|d u rtdt|pd}|d u ri }t| || d S )NzNo function or docstring givenr    )r   r   r   r   getdocrD   r   )r   r   r   rv   r_   r
   r
   r   r   4  s   zFunctionDoc.__init__c                 C   sF   t | jd| jj}t| jrt | jd| jj}||fS | j}||fS )Nr6   __call__)getattrr   	__class__r6   r   isclassr   )r   	func_namer   r
   r
   r   get_func@  s   zFunctionDoc.get_funcc                    sj   d}|   \}}ddd}| jr)| j|vrtd| j  |d|| jd|f 7 }|t j| jd7 }|S )Nr    functionmethod)r   methzWarning: invalid role %sz.. %s:: %s
    

)r   )r   r   printr   superr?   )r   r"   r   r   Zrolesr   r
   r   r?   H  s   
zFunctionDoc.__str__)r   NN)r6   r7   r8   r   r   r?   __classcell__r
   r
   r   r   r   3  s    
r   c                   @   s   e Zd ZdddZdS )ObjDocNc                 C   s&   || _ |d u r	i }tj| ||d d S )Nr_   )r   rD   r   )r   objrv   r_   r
   r
   r   r   [  s   zObjDoc.__init__)NN)r6   r7   r8   r   r
   r
   r
   r   r   Z  s    r   c                   @   sD   e Zd ZdgZddedfddZedd Zedd	 Zd
d Z	dS )ClassDocr   Nr    c              
   C   s  t |s|d urtd| || _dtjv rddlm} nt }|d u r'i }|	dd| _
|r9|ds9|d7 }|| _|d u rM|d u rHtdt|}t| | |	d	g }||u r_d }|	d
g }|	ddr||urdd }	d| jfd| jffD ]C\}
}| |
 sg }t|D ],}||v s|r||vrqztt| j|}|t|d|	| W q ty   Y qw || |
< q}d S d S d S )Nz$Expected a class or None, but got %rZsphinxr   )ALLZshow_inherited_class_membersTr   z&No class or documentation string givenmemberszexclude-membersZshow_class_membersc                 S   s   | sg S |   S r   )
splitlines)r   r
   r
   r   splitlines_x  s   z'ClassDoc.__init__.<locals>.splitlines_xrP   rO   r    )r   r   r   r   sysmodulesZsphinx.ext.autodocr   objectr   show_inherited_membersendswith_modpydocr   rD   r   methods
propertiessortedr   r   r@   AttributeError)r   clsrv   
modulenamefunc_docr_   r   Z_membersZ_excluder   fieldr   Zdoc_listrA   Zdoc_itemr
   r
   r   r   f  s`   

zClassDoc.__init__c                    (    j d u rg S  fddt j D S )Nc                    s<   g | ]\}}| d r| jv rt|tr |r|qS )_)rp   extra_public_methodsr   r   _is_show_memberr   rA   r   r   r
   r   r     s    
z$ClassDoc.methods.<locals>.<listcomp>r   r   
getmembersr   r
   r   r   r        
zClassDoc.methodsc                    r   )Nc                    sD   g | ]\}}| d s |du st|tst|r |r|qS )r   N)rp   r   r   r   isdatadescriptorr  r  r   r
   r   r     s    z'ClassDoc.properties.<locals>.<listcomp>r  r   r
   r   r   r     r  zClassDoc.propertiesc                 C   s   | j rdS || jjvrdS dS )NTF)r   r   __dict__)r   rA   r
   r
   r   r    s
   zClassDoc._is_show_member)
r6   r7   r8   r  r   r   r   r   r   r  r
   r
   r
   r   r   b  s    
6
	
	r   c                 C   s   |d u rt | rd}nt | rd}n
t| trd}nd}|d u r$i }|dkr0t| t||dS |dv r;t| ||dS |d u rDt| }t	| ||dS )	Nclassmoduler   r   )r   rv   r_   )r   r   )rv   r_   r   )
r   r   ismoduler   r   r   r   r   r   r   )r   whatrv   r_   r
   r
   r   get_doc_object  s"   



r  )NNN)r9   r   rW   r   r   warningsr   collectionsr   collections.abcr   r   rZ   r   r   r   	Exceptionr:   r@   rD   r   r   r   r   r  r
   r
   r
   r   <module>   s.   	M   ;'V