U
    GvfPT  ã                   @   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	eƒZG d
d„ deƒZeddddgƒ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
   ú9/tmp/pip-unpacked-wheel-96ln3f52/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f }|S )Nr   Ú	docstringz%s in %r)Ú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ÚNumpyDocStringzƒParses 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   sh   |}t  |¡ d¡}t|ƒ| _t | j¡| _z|  	¡  W n* t
k
rb } z||_‚ W 5 d }~X Y nX 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   )rZ   )r   Úkeyr
   r
   r   r   ™   s    zNumpyDocString.__getitem__c                 C   s,   || j kr| jd| dd n
|| j |< d S )NzUnknown section %sF©Úerror)rZ   Ú_error_location)r   r^   Úvalr
   r
   r   Ú__setitem__œ   s    
zNumpyDocString.__setitem__c                 C   s
   t | jƒS r   )ÚiterrZ   r   r
   r
   r   Ú__iter__¢   s    zNumpyDocString.__iter__c                 C   s
   t | jƒS r   )r%   rZ   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   ú-ú=)rV   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   )rV   r+   rm   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   é   )rV   r   rt   r   rj   r%   ÚStopIterationrr   )r   r   r=   r
   r
   r   Ú_read_sectionsÎ   s    

zNumpyDocString._read_sectionsFc           	      C   sŠ   t |ƒ}g }| ¡ s†| ¡  ¡ }d|kr@| d¡d d… \}}n|rPd| }}n
|d }}| ¡ }t|ƒ}t|ƒ}| t	|||ƒ¡ q|S )Nú : rv   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>[,\.])?ru   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
¡}	|	  ¡ s¬qú||	ƒ\}
}}| |
|f¡ |	|d…   ¡ }	|	r¢|	d dkr¢|	dd…   ¡ }	q¢t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‰   ra   rŠ   rj   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 )
zT
        .. 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  s     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ú:rv   )r   r%   )r   rs   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k	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  s     z1NumpyDocString._parse_summary.<locals>.<listcomp>z^([\w., ]+=)?\s*[\w\.]+\(.*\)$rA   rB   rC   )	rm   rV   r+   r1   r   ÚreÚcompilerˆ   rt   )r   ÚsummaryZsummary_strZcompiledr
   r
   r   Ú_parse_summary]  s    


zNumpyDocString._parse_summaryc                 C   s2  | j  ¡  |  ¡  t|  ¡ ƒ}tdd„ |D ƒƒ}d|k}d|k}|rT|rTd}t|ƒ‚|sld|krld}t|ƒ‚|D ]¼\}}| d¡s¸d	d
„ | d¡D ƒ}d 	|¡}|  
|¡r¸|  d| ¡ |dkrÐ|  |¡| |< qp|dkrì| j|dd| |< qp| d¡r
|  ||¡| d< qp|dkr$|  |¡| d< qp|| |< qpd S )Nc                 S   s   g | ]\}}|‘qS r
   r
   )r˜   rs   r|   r
   r
   r   rš   x  s     z)NumpyDocString._parse.<locals>.<listcomp>rE   rF   z5Docstring contains both a Returns and Yields section.rG   z5Docstring contains a Receives section but not Yields.ru   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)rD   rJ   rK   rL   )rE   rF   rH   rI   rG   T)r}   rg   rR   rM   )rV   r   r£   r   rx   ÚsetÚ
ValueErrorrj   r   r1   Úgetra   r   rŸ   r–   )r   rY   Zsection_namesZhas_returnsZ
has_yieldsÚmsgrs   r|   r
   r
   r   r[   s  s@    



ÿ ÿ
zNumpyDocString._parseTc                 C   s`   t | dƒrFzt | j¡}W n tk
r2   d }Y nX |d| j|f  }|rTt|ƒ‚nt|ƒ d S )NÚ_objz in the docstring of %s in %s.)r9   ÚinspectÚgetsourcefilerª   Ú	TypeErrorr§   r   )r   r©   r`   Úfilenamer
   r
   r   ra   š  s    

ÿ
zNumpyDocString._error_locationrh   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   ro   Ú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 )NrA   Ú*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 )NrB   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 )NrC   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 )Nry   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ƒsJt‚g }|D ]>\}}|rld||f }	n|r~d||f }	nd| }	| |	¡ qRd |¡}	||	g7 }|rÆ||  d |¡g¡7 }d}q4d}||  | jg¡7 }q4|rì|dg7 }|dg7 }|S )	NrM   r   Tz:%s:`%s`z`%s`_ú, rŽ   F)r±   r   r   ÚAssertionErrorr{   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 |¡f g7 }q:|rr|S dS d S )	NrR   Fr   r   Tz.. index:: %sz
   :%s: %sr¾   )r¨   r’   r1   )r   Úidxr    Zoutput_indexZdefault_indexrs   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)rD   rE   rF   rG   rJ   rH   rI   rO   )rN   rP   rQ   )rK   rL   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)rh   )r²   )r   )*r2   r3   r4   r5   rY   r   r   rc   re   rf   rm   rr   rt   rx   r   Ú_roleZ_funcbacktickZ
_funcplainZ	_funcnamer¶   Z_funcnamenextZ_descriptionr    r¡   r‡   r   rÀ   r–   rŸ   r£   r[   ra   r±   r´   r·   r¸   r¹   r¼   r½   rÅ   rÇ   r;   r
   r
   r
   r   r@   p   sŽ   î
%þýýýüúùÿ6'


 r@   r²   c                    s6   d| ‰ | d k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¥   &  s     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   )rT   rU   r1   r   )rË   r
   r
   r   rz   )  s    rz   rh   c                 C   s   | d |t | ƒ  d S rS   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 kr2|d kr$tdƒ‚t |¡p0d}t | ||¡ d S )NzNo function or docstring givenr   )Ú_frÈ   r§   r«   Úgetdocr@   r   )r   rÃ   r…   ro   r\   r
   r
   r   r   3  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                    sn   d}|   ¡ \}}dddœ}| jrR| j|kr8td| j ƒ |d| | jd¡|f 7 }|t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Ã   rÔ   Zroles©rÒ   r
   r   r;   E  s    ÿ
ÿzFunctionDoc.__str__)r2   r3   r4   r   rÕ   r;   Ú__classcell__r
   r
   rÛ   r   rÍ   2  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 k	rtd| ƒ‚|| _dtjkr<ddlm} ntƒ }| 	dd¡| _
|rf| d¡sf|d7 }|| _|d krŽ|d kr„tdƒ‚t |¡}t | |¡ | 	d	g ¡}||kr²d }| 	d
g ¡}| 	dd¡r‚||k	r‚dd„ }	d| jfd| jffD ]Ž\}
}| |
 sòg }t|ƒD ]h}||ks|r0||kr0qz,t t| j|ƒ¡}| t|d|	|ƒƒ¡ W n tk
rr   Y nX q|| |
< qòd S )Nz$Expected a class or None, but got %rZsphinxr   )ÚALLZshow_inherited_class_membersTÚ.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_xz  s    z'ClassDoc.__init__.<locals>.splitlines_xrL   rK   r   )r«   rÓ   r§   Ú_clsÚsysÚmodulesZsphinx.ext.autodocrÞ   Úobjectr¨   Úshow_inherited_membersÚendswithZ_modÚpydocrÏ   r@   r   ÚmethodsÚ
propertiesÚsortedrÑ   r{   r<   ÚAttributeError)r   Úclsro   Ú
modulenameZfunc_docr\   rÞ   Z_membersZ_excluderâ   Úfieldr’   Zdoc_listr=   Zdoc_itemr
   r
   r   r   [  sX    
 ÿ
ÿ
ÿÿÿ
zClassDoc.__init__c                    s(   ˆ j d krg S ‡ fdd„t ˆ j ¡D ƒS )Nc                    s<   g | ]4\}}|  d ¡r |ˆ jkrt|tƒrˆ  |¡r|‘qS )Ú_)rj   Ú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 krg S ‡ fdd„t ˆ j ¡D ƒS )Nc                    sD   g | ]<\}}|  d ¡s|dks2t|tƒs2t |¡rˆ  |¡r|‘qS )rñ   N)rj   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k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Ý   W  s   ÿ
4
	
	rÝ   )r²   )rh   )r5   r«   rT   r    ré   Úwarningsr   Úcollectionsr   Úcollections.abcr   r   rW   rä   r   ræ   r   Ú	Exceptionr6   r<   r@   r³   rz   r€   rÍ   rÝ   r
   r
   r
   r   Ú<module>   s,   	L   4

%