a
    hS                     @   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dZdd ZdddZG dd deZG dd deZdS )z=Extract reference documentation from the NumPy source tree.

    N)warn)
namedtuple)CallableMappingc                 C   s4   | r| d   s| d= q | r0| d   s0| d= q| S )z<Remove leading and trailing blank lines from a list of linesr   strip)l r
   Q/var/www/html/assistant/venv/lib/python3.9/site-packages/scipy/_lib/_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   s
   | j | S N)r   r   nr
   r
   r   __getitem__,   s    zReader.__getitem__c                 C   s
   d| _ d S )Nr   )_lr   r
   r
   r   r   /   s    zReader.resetc                 C   s,   |   s$| | j }|  jd7  _|S dS d S )N    )eofr   )r   outr
   r
   r   read2   s
    
zReader.readc                 C   s4   | | j d  D ] }| r  q0q|  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   A   s    z
Reader.eofc                 C   sb   | j }| |d  D ]J}||r0| || 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_conditionD   s    zReader.read_to_conditionc                 C   s   |    dd }| |S )Nc                 S   s
   |    S r   r   r'   r
   r
   r   is_emptyQ   s    z0Reader.read_to_next_empty_line.<locals>.is_empty)r#   r(   )r   r*   r
   r
   r   read_to_next_empty_lineN   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_unindentedW   s    z:Reader.read_to_next_unindented_line.<locals>.is_unindented)r(   )r   r-   r
   r
   r   read_to_next_unindented_lineV   s    z#Reader.read_to_next_unindented_liner   c                 C   s*   | j | t| jk r"| | j |  S dS d S Nr   r$   r   r
   r
   r   peek[   s    zReader.peekc                 C   s   d | j  S r/   )joinr   r   r   r
   r
   r   r*   a   s    zReader.is_emptyN)r   )__name__
__module____qualname____doc__r   r   r   r!   r#   r   r(   r+   r.   r0   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}|S )Nr   	docstring in )argshasattrr7   )r   messager
   r
   r   __str__f   s    

zParseError.__str__N)r2   r3   r4   r<   r
   r
   r
   r   r6   e   s   r6   	Parameter)nametypedescc                   @   s  e Zd ZdZddgg g g g g g g g g g g g g ddi dZi f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dMddZdZdZdZde e d e d Zedd Zed!d"Zd#Zed$e d% Zed&e d' e d( d d) e Zd*Zd+d, Zd-d. Zd/d0 Zd1d2 ZdNd4d5ZdOd7d8Z dPd:d;Z!d<d= Z"d>d? Z#d@dA Z$dBdC Z%dDdE Z&dFdG Z'dHdI Z(dQdJdKZ)dLS )RNumpyDocStringzParses a numpydoc string to an abstract representation

    Instances define a mapping from section title to structured data.

    r   )	SignatureSummaryExtended Summary
ParametersReturnsYieldsReceivesRaisesWarnsOther Parameters
AttributesMethodsSee AlsoNotesWarnings
ReferencesExamplesindexc              
   C   sj   |}t |d}t|| _t| j| _z| 	  W n, t
yd } z||_ W Y d }~n
d }~0 0 d S Nr   )textwrapdedentr   r   _doccopydeepcopysections_parsed_data_parser6   r7   )r   r7   configZorig_docstringer
   r
   r   r      s    
zNumpyDocString.__init__c                 C   s
   | j | S r   )r[   )r   keyr
   r
   r   r      s    zNumpyDocString.__getitem__c                 C   s,   || j vr| jd| dd n
|| j |< d S )NzUnknown section %sFerror)r[   _error_location)r   r_   valr
   r
   r   __setitem__   s    
zNumpyDocString.__setitem__c                 C   s
   t | jS r   )iterr[   r   r
   r
   r   __iter__   s    zNumpyDocString.__iter__c                 C   s
   t | jS r   )r%   r[   r   r
   r
   r   __len__   s    zNumpyDocString.__len__c                 C   sh   | j   | j  rdS | j   }|dr4dS | j d }|dt| pf|dt| S )NF
.. index::Tr   -=)rW   r#   r   r0   r   
startswithr%   )r   l1l2r
   r
   r   _is_at_section   s    


zNumpyDocString._is_at_sectionc                 C   sb   d}d}t |D ]\}}| r q&qt |d d d D ]\}}| r8 qNq8||t||  S )Nr   r   )	enumerater   r%   )r   docijr'   r
   r
   r   _strip   s    zNumpyDocString._stripc                 C   sJ   | j  }|  sF| j  sF| j d s6|dg7 }|| j  7 }q
|S )Nr   r   )rW   r+   rn   r   r0   r   )r   sectionr
   r
   r   _read_to_next_section   s    

z$NumpyDocString._read_to_next_sectionc                 c   sn   | j  sj|  }|d  }|dr<||dd  fV  q t|dk rPtV  q || |dd  fV  q d S )Nr   ..r      )rW   r   ru   r   rk   r%   StopIterationrs   )r   r   r>   r
   r
   r   _read_sections   s    

zNumpyDocString._read_sectionsFc           	      C   s   t |}g }| s|  }d|v r@|dd d \}}n|rPd| }}n
|d }}| }t|}t|}|t	||| q|S )N : rw   r   )
r   r   r!   r   r   r.   dedent_linesr   appendr=   )	r   contentsingle_element_is_typerparamsheaderZarg_nameZarg_typer@   r
   r
   r   _parse_param_list   s    
z NumpyDocString._parse_param_listz:(?P<role>\w+):z'`(?P<name>(?:~\w+\.)?[a-zA-Z0-9_\.-]+)`z(?P<name2>[a-zA-Z0-9_\.-]+)(|)roleZrolenextr>   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>[,\.])?rv   c                    s,  g } fdd}g }|D ]}|  s(q j|}d}|rp|d}|drp|rp jd|d|f dd |s|d	r||   q|rg }|d
}	|	  sq||	\}
}}||
|f |	|d   }	|	r|	d dkr|	dd   }	qtt	d|g}|||f qt
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                    sL    j | }|std|  |d}|r4|dn|d}||| fS )zMatch ':role:`name`' or 'name'.%s is not a item namer   r>   Zname2)	_func_rgxmatchr6   groupend)textmr   r>   r   r
   r   parse_item_name  s    
z7NumpyDocString._parse_see_also.<locals>.parse_item_nameNr@   ZtrailingzGUnexpected comma or period after function list at index %d of line "%s"Fr`    Zallfuncsr   ,r   r   )r   	_line_rgxr   r   rb   r   rk   r|   r   filterr6   )r   r}   itemsr   restr'   Z
line_matchdescriptionfuncsr   r>   r   Z	match_endr
   r   r   _parse_see_also  sF    		


zNumpyDocString._parse_see_alsoc                 C   sz   dd }i }| d}t|dkr<||d  dd |d< |D ]4}| d}t|d	kr@||d	  d||d < q@|S )
zU
        .. index:: default
           :refguide: something, else, and more

        c                 S   s   dd | D S )Nc                 S   s   g | ]}|  qS r
   r   .0sr
   r
   r   
<listcomp>Q      zFNumpyDocString._parse_index.<locals>.strip_each_in.<locals>.<listcomp>r
   )lstr
   r
   r   strip_each_inP  s    z2NumpyDocString._parse_index.<locals>.strip_each_inz::r   r   r   default:rw   )r   r%   )r   rt   r}   r   r    r'   r
   r
   r   _parse_indexJ  s    

zNumpyDocString._parse_indexc                 C   s   |   rdS | j }ddd |D  }td}||rX|| d< |   sXqqXq|durh|| d< |   s||  | d< dS )	z%Grab signature (if given) and summaryNr   c                 S   s   g | ]}|  qS r
   r   r   r
   r
   r   r   e  r   z1NumpyDocString._parse_summary.<locals>.<listcomp>z^([\w., ]+=)?\s*[\w\.]+\(.*\)$rB   rC   rD   )	rn   rW   r+   r1   r   recompiler   ru   )r   summaryZsummary_strcompiledr
   r
   r   _parse_summary]  s    


zNumpyDocString._parse_summaryc                 C   s.  | j   |   t|  }dd |D }d|v }d|v }|rP|rPd}t||shd|v rhd}t||D ]\}}|dsd	d
 |dD }d|}| 	|r| 
d|  |dv r| || |< ql|dv r| j|dd| |< ql|dr| ||| d< ql|dkr | || d< ql|| |< qld S )Nc                 S   s   h | ]\}}|qS r
   r
   )r   rt   r}   r
   r
   r   	<setcomp>x  r   z(NumpyDocString._parse.<locals>.<setcomp>rF   rG   z5Docstring contains both a Returns and Yields section.rH   z5Docstring contains a Receives section but not Yields.rv   c                 s   s   | ]}|  V  qd S r   )
capitalizer   r
   r
   r   	<genexpr>  r   z(NumpyDocString._parse.<locals>.<genexpr>r   zThe section %s appears twice)rE   rK   rL   rM   )rF   rG   rI   rJ   rH   T)r~   rh   rS   rN   )rW   r   r   r   ry   
ValueErrorrk   r   r1   getrb   r   r   r   )r   rZ   Zsection_namesZhas_returnsZ
has_yieldsmsgrt   r}   r
   r
   r   r\   s  s>    




zNumpyDocString._parseTc                 C   sh   t | drJzt| j}W n ty0   d }Y n0 |d| j d| d }|rXt|nt|dd d S )N_objz in the docstring of r8   .   )
stacklevel)r:   inspectgetsourcefiler   	TypeErrorr   r   )r   r   ra   filenamer
   r
   r   rb     s    


zNumpyDocString._error_locationri   c                 C   s   |t || gS r   r%   )r   r>   symbolr
   r
   r   _str_header  s    zNumpyDocString._str_header   c                 C   s$   g }|D ]}|d| | g7 }q|S )Nr   r
   )r   rp   indentr    r'   r
   r
   r   _str_indent  s    zNumpyDocString._str_indentc                 C   s*   | d r | d  ddgdg S dgS d S )NrB   *z\*r   )replacer   r
   r
   r   _str_signature  s    zNumpyDocString._str_signaturec                 C   s   | d r| d dg S g S d S )NrC   r   r
   r   r
   r
   r   _str_summary  s    zNumpyDocString._str_summaryc                 C   s   | d r| d dg S g S d S )NrD   r   r
   r   r
   r
   r   _str_extended_summary  s    z$NumpyDocString._str_extended_summaryc                 C   s   g }| | r||  |7 }| | D ]b}g }|jr<||j |jrN||j |d|g7 }|jr"d|j r"|| |j7 }q"|dg7 }|S )Nrz   r   )r   r>   r|   r?   r1   r@   r   r   )r   r>   r    parampartsr
   r
   r   _str_param_list  s    
zNumpyDocString._str_param_listc                 C   s4   g }| | r0||  |7 }|| | 7 }|dg7 }|S r/   )r   )r   r>   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sJJ g }|D ]J\}}|rrd| d| d}	n |rd| d| d}	nd| }	||	 qRd|}	||	g7 }|r|| d	|g7 }d}q4d
}|| | jg7 }q4|r|dg7 }|dg7 }|S )NrN   r   Tr   z:``z`%s`_, r   F)r   r   r   r|   r1   r   empty_description)
r   	func_roler    Zlast_had_descr   r@   linksfuncr   linkr
   r
   r   _str_see_also  s6    




zNumpyDocString._str_see_alsoc                 C   sz   | d }g }d}| dd}|r$d}|d| g7 }| D ].\}}|dkrLq:d}|d|d|g7 }q:|rr|S dS d S )	NrS   Fr   r   Tz.. index:: %sz
   :{}: {}r   )r   r   formatr1   )r   idxr    Zoutput_indexZdefault_indexrt   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 }q`dD ]}|| |7 }qx||  7 }d|S )N)rE   rF   rG   rH   rK   rI   rJ   rP   )rO   rQ   rR   )rL   rM   r   )r   r   r   r   r   r   r   r1   )r   r   r    Z
param_listr   r
   r
   r   r<     s    zNumpyDocString.__str__N)F)T)ri   )r   )r   )*r2   r3   r4   r5   rZ   r   r   rd   rf   rg   rn   rs   ru   ry   r   _roleZ_funcbacktickZ
_funcplainZ	_funcnamer   Z_funcnamenextZ_descriptionr   r   r   r   r   r   r   r   r\   rb   r   r   r   r   r   r   r   r   r   r<   r
   r
   r
   r   rA   p   s   
%6'


 rA   r   c                    s6   d|  | d u r S |  d}d fdd|D S )Nr   r   c                 3   s   | ]} | V  qd S r   r
   )r   r	   Z
indent_strr
   r   r   %  r   zindent.<locals>.<genexpr>)r   r1   )strr   linesr
   r   r   r      s
    
r   c                 C   s   t d| dS )z"Deindent a list of lines maximallyr   )rU   rV   r1   r   )r   r
   r
   r   r{   (  s    r{   ri   c                 C   s   | d |t |   d S rT   r   )r   styler
   r
   r   r   -  s    r   c                       s4   e Zd Zddi fddZdd Z fddZ  ZS )	FunctionDocr   Nc                 C   sD   || _ || _|d u r2|d u r$tdt|p0d}t| || d S )NzNo function or docstring givenr   )_fr   r   r   getdocrA   r   )r   r   r   rp   r]   r
   r
   r   r   2  s    zFunctionDoc.__init__c                 C   s@   t | jd| jj}t| jr2t | jd| jj}n| j}||fS )Nr2   __call__)getattrr   	__class__r2   r   isclassr   )r   	func_namer   r
   r
   r   get_func<  s
    zFunctionDoc.get_funcc                    sj   d}|   \}}ddd}| jrR| j|vr8td| j  |d|| jd|7 }|t j| jd7 }|S )Nr   functionmethod)r   methzWarning: invalid role %sz.. {}:: {}
    

)r   )r   r   printr   r   superr<   )r   r    r   r   Zrolesr   r
   r   r<   D  s    
zFunctionDoc.__str__)r2   r3   r4   r   r   r<   __classcell__r
   r
   r   r   r   1  s   
r   c                   @   sD   e Zd ZdgZddei 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d| _
|rf|dsf|d7 }|| _|d u r|d u rtdt|}t| | |	d	g }||u rd }|	d
g }|	ddr||urdd }	d| jfd| jffD ]\}
}| |
 sg }t|D ]f}||v s|r0||vr0qz,tt| j|}|t|d|	| W n typ   Y n0 q|| |
< qd 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 d S r   )
splitlines)r   r
   r
   r   splitlines_xy  s    z'ClassDoc.__init__.<locals>.splitlines_xrM   rL   r   )r   r   r   _clssysmodulesZsphinx.ext.autodocr   objectr   show_inherited_membersendswith_modpydocr   rA   r   methods
propertiessortedr   r|   r=   AttributeError)r   clsrp   
modulenameZfunc_docr]   r   Z_membersZ_excluder   fieldr   Zdoc_listr>   Zdoc_itemr
   r
   r   r   Z  sV    



zClassDoc.__init__c                    s(    j d u rg S  fddt j D S )Nc                    s<   g | ]4\}}| d r | jv rt|tr |r|qS )_)rk   extra_public_methodsr   r   _is_show_memberr   r>   r   r   r
   r   r     s
   



z$ClassDoc.methods.<locals>.<listcomp>r   r   
getmembersr   r
   r   r   r     s    
zClassDoc.methodsc                    s(    j d u rg S  fddt j D S )Nc                    sD   g | ]<\}}| d s|du s2t|ts2t|r |r|qS )r   N)rk   r   propertyr   isdatadescriptorr   r   r   r
   r   r     s
   


z'ClassDoc.properties.<locals>.<listcomp>r   r   r
   r   r   r     s    
zClassDoc.propertiesc                 C   s   | j r
dS || jjvrdS dS )NTF)r   r   __dict__)r   r>   r
   r
   r   r     s
    zClassDoc._is_show_member)
r2   r3   r4   r   r   r   r   r   r   r   r
   r
   r
   r   r   V  s   
4
	
	r   )r   )ri   )r5   r   rU   r   r   warningsr   collectionsr   collections.abcr   r   rX   r   r   r   	Exceptionr6   r=   rA   r   r{   r   r   r   r
   r
   r
   r   <module>   s,   	L   3

%