3
W­E^ë  ã               @   s  d Z ddlZddlmZ ddlmZ ddlmZ ddlm	Z	 yddl
ZddlZddlZW n ek
rp   dZY nX dZd	d
„ Zdd„ Zdd„ Zd"dd„ZddddddœZdd„ Zd#dd„Zerðejjjjdeƒ xejƒ D ]\ZZeeeƒ qÚW ejdƒZejdƒZ dd„ Z!d d!„ Z"dS )$zBMisc. utility functions/classes for admin documentation generator.é    N)ÚHeaderParseError)ÚHeaderParser)Úreverse)Ú	mark_safeFTc             C   s"   | j }t| d| jjƒ}|d | S )NÚ__qualname__Ú.)Ú
__module__ÚgetattrÚ	__class__Ú__name__)Z	view_funcÚmod_nameZ	view_name© r   ú@/tmp/pip-build-78s3knkw/Django/django/contrib/admindocs/utils.pyÚget_view_name   s    r   c                sh   |  s| j ƒ  rdS | jƒ jƒ }tdd„ |D ƒƒ‰ |d jƒ g‡ fdd„|dd… D ƒ }d	j|ƒj ƒ S )
zœ
    Uniformly trim leading/trailing whitespace from docstrings.

    Based on https://www.python.org/dev/peps/pep-0257/#handling-docstring-indentation
    Ú c             s   s*   | ]"}|j ƒ rt|ƒt|j ƒ ƒ V  qd S )N)ÚlstripÚlen)Ú.0Úliner   r   r   ú	<genexpr>$   s    z!trim_docstring.<locals>.<genexpr>r   c                s   g | ]}|ˆ d … j ƒ ‘qS )N)Úrstrip)r   r   )Úindentr   r   ú
<listcomp>%   s    z"trim_docstring.<locals>.<listcomp>é   NÚ
)ÚstripÚ
expandtabsÚ
splitlinesÚminr   Újoin)Ú	docstringÚlinesZtrimmedr   )r   r   Útrim_docstring   s    (r"   c             C   s¶   t | ƒ} tjd| ƒ}|d }t|ƒdkr2d}i }nztƒ }y|j|d ƒ}W n* tk
rt   i }dj|dd… ƒ}Y n8X t|j	ƒ ƒ}|ršdj|dd… ƒ}ndj|dd… ƒ}|||fS )	zN
    Parse out the parts of a docstring.  Return (title, body, metadata).
    z\n{2,}r   r   r   z

Néÿÿÿÿr#   )
r"   ÚreÚsplitr   r   Úparsestrr   r   ÚdictÚitems)r    ÚpartsÚtitleÚbodyÚmetadataÚparserr   r   r   Úparse_docstring)   s"    r.   c             C   sR   dd|t dƒjdƒdddœ}|o&d| }d}tjj||  |d	d
|d�}t|d ƒS )z<
    Convert the string from reST to an XHTML fragment.
    Té   zdjango-admindocs-docrootú/F)Zdoctitle_xformZinitial_header_levelÚdefault_reference_contextÚ	link_baseZraw_enabledZfile_insertion_enabledz<%s>z7
.. default-role:: cmsreference

%s

.. default-role::
NÚhtml)Úsource_pathZdestination_pathZwriter_nameZsettings_overridesÚfragment)r   r   ÚdocutilsÚcoreZpublish_partsr   )Útextr1   Zthing_being_parsedZ	overridesÚsourcer)   r   r   r   Ú	parse_rstC   s    	
r:   z%s/models/%s/z%s/views/%s/z%s/templates/%s/z%s/filters/#%sz%s/tags/#%s)ÚmodelÚviewÚtemplateÚfilterÚtagc                s$   d‡ fdd„	}t jjjj| |ƒ d S )Nc                sB   |d kri }t jj||fdˆ |jjj|jƒ f i|—Ž}|gg fS )NÚrefuri)r6   ÚnodesÚ	referenceÚdocumentÚsettingsr2   Úlower)ÚnameÚrawtextr8   ÚlinenoÚinlinerÚoptionsÚcontentÚnode)Úurlbaser   r   Ú_rolen   s    z$create_reference_role.<locals>._role)NN)r6   ÚparsersÚrstÚrolesÚregister_canonical_role)ZrolenamerM   rN   r   )rM   r   Úcreate_reference_rolem   s    rS   c       	      C   sP   |d kri }|j jj}tjj||fdt| |j jj|jƒ f i|—Ž}|gg fS )Nr@   )	rC   rD   r1   r6   rA   rB   ÚROLESr2   rE   )	rF   rG   r8   rH   rI   rJ   rK   ÚcontextrL   r   r   r   Údefault_reference_role~   s    
rV   Zcmsreferencez\(\?P(<\w+>)z\(c             C   sÒ   dd„ t j| ƒD ƒ}g }x–|D ]Ž\}}}d	\}}xzt| |d… ƒD ]f\}}	|	dkrd|dkrd|d7 }n|	dkr||dkr||d8 }|	}|dkrB|j| ||| d … |fƒ P qBW qW x|D ]\}
}| j|
|ƒ} q¶W | S )
a  
    Find named groups in `pattern` and replace them with the group name. E.g.,
    1. ^(?P<a>\w+)/b/(\w+)$ ==> ^<a>/b/(\w+)$
    2. ^(?P<a>\w+)/b/(?P<c>\w+)/$ ==> ^<a>/b/<c>/$
    3. ^(?P<a>\w+)/b/(\w+) ==> ^<a>/b/(\w+)
    4. ^(?P<a>\w+)/b/(?P<c>\w+) ==> ^<a>/b/<c>
    c             S   s(   g | ] }|j d ƒ|jd ƒ|jdƒf‘qS )r   r   )ÚstartÚendÚgroup)r   Úmr   r   r   r   ¢   s   z(replace_named_groups.<locals>.<listcomp>r   Nú(ú\ú)r   )r   N)Únamed_group_matcherÚfinditerÚ	enumerateÚappendÚreplace)ÚpatternZnamed_group_indicesZgroup_pattern_and_namerW   rX   Z
group_nameÚunmatched_open_bracketsÚ	prev_charÚidxÚvalZgroup_patternr   r   r   Úreplace_named_groups™   s"    	

rh   c             C   s^  dd„ t j| ƒD ƒ}g }xŒ|D ]„}d\}}xvt| |d d… ƒD ]^\}}|dkrb|dkrb|d7 }n|dkrz|dkrz|d8 }|}|dkr@|j||d	 | fƒ P q@W qW g }d}	x4|D ],\}}
|	rÈ||	ksÎ|	 rÜ|j||
fƒ |
}	q´W |�rVg d }}	xD|D ]<\}}
|	�r|j| |	|… ƒ |j| d|… d
 ƒ |
}	� qúW |j| |	d… ƒ dj|ƒS | S dS )a)  
    Find unnamed groups in `pattern` and replace them with '<var>'. E.g.,
    1. ^(?P<a>\w+)/b/(\w+)$ ==> ^(?P<a>\w+)/b/<var>$
    2. ^(?P<a>\w+)/b/((x|y)\w+)$ ==> ^(?P<a>\w+)/b/<var>$
    3. ^(?P<a>\w+)/b/(\w+) ==> ^(?P<a>\w+)/b/<var>
    4. ^(?P<a>\w+)/b/((x|y)\w+) ==> ^(?P<a>\w+)/b/<var>
    c             S   s   g | ]}|j d ƒ‘qS )r   )rW   )r   rZ   r   r   r   r   Ç   s    z*replace_unnamed_groups.<locals>.<listcomp>r   Nr[   r\   r]   r   é   z<var>r   )r   N)Úunnamed_group_matcherr_   r`   ra   r   )rc   Zunnamed_group_indicesZgroup_indicesrW   rd   re   rf   rg   Zgroup_start_end_indicesZprev_endrX   Zfinal_patternr   r   r   Úreplace_unnamed_groups¿   s:    





rk   )N)NN)#Ú__doc__r$   Zemail.errorsr   Úemail.parserr   Zdjango.urlsr   Zdjango.utils.safestringr   Zdocutils.corer6   Zdocutils.nodesZdocutils.parsers.rst.rolesÚImportErrorZdocutils_is_availabler   r"   r.   r:   rT   rS   rV   rO   rP   rQ   rR   r(   rF   rM   Úcompiler^   rj   rh   rk   r   r   r   r   Ú<module>   s>   

"


&