3
8ßL]  ã               @   s„   d Z ddlZddl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 dd„ ZG d	d
„ d
eƒZdd„ Zdd„ ZdS )z‚
    A Trait Documenter
    (Subclassed from the autodoc ClassLevelDocumenter)

    :copyright: Copyright 2012 by Enthought, Inc

é    N)ÚClassLevelDocumenteré   )Ú	TraitType)ÚMetaHasTraitsc             C   s   t |tƒo| |jkS )zJ Check if the name is in the list of class defined traits of ``cls``.
    )Ú
isinstancer   Z__class_traits__)ÚnameÚcls© r	   ú@/tmp/pip-install-5sebvq2j/traits/traits/util/trait_documenter.pyÚ_is_class_trait   s    r   c               @   sX   e Zd ZdZdZdZdZdZedd„ ƒZ	dd	d
„Z
ddd„Zdd„ Zdd„ Zdd„ ZdS )ÚTraitDocumenteraŒ   Specialized Documenter subclass for trait attributes.

    The class defines a new documenter that recovers the trait definition
    signature of module level and class level traits.

    To use the documenter, append the module path in the extension
    attribute of the `conf.py`.

    .. warning::

        Using the TraitDocumenter in conjunction with TraitsDoc is not
        advised.

    ZtraitattributeÚ	attributeé<   é   c             C   s"   |rt t|ƒtƒpt||jƒ}|S )z? Check that the documented member is a trait instance.
        )Ú
issubclassÚtyper   r   Úobject)r   ÚmemberZ
membernameZisattrÚparentÚcheckr	   r	   r
   Úcan_document_member7   s    z#TraitDocumenter.can_document_memberFc             C   s   dS )z" Trait attributes have no members Nr	   )ÚselfZall_membersr	   r	   r
   Údocument_membersB   s    z TraitDocumenter.document_membersc             C   s   t j| |dd� dS )z- Never try to get a docstring from the trait.T)Úno_docstringN)r   Úadd_content)r   Zmore_contentr   r	   r	   r
   r   F   s    zTraitDocumenter.add_contentc             C   sÜ   y`t | jƒ tj| j  }| _x"| jdd… D ]}| j||ƒ}q.W | jd }|| _d| _|| _	dS  t
k
rÖ } zZ| jjrœ| jjj rœ| jjjtjƒ jƒ ƒ d}| jj|j| jt| jƒ|ƒƒ | jjƒ  dS d}~X nX dS )zy Get the Trait object.

        Notes
        -----
        Code adapted from autodoc.Documenter.import_object.

        Né   Tzeautodoc can't import/find {0} {r1}, it reported error: "{2}", please check your spelling and sys.pathFéÿÿÿÿr   )Ú
__import__ÚmodnameÚsysÚmodulesÚmoduleZobjpathZget_attrÚobject_namer   r   Ú	ExceptionÚenvÚappÚquietÚinfoÚ	tracebackÚ
format_excÚrstripÚ	directiveÚwarnÚformatÚobjtypeÚstrÚfullnameZnote_reread)r   ÚcurrentÚpartr   ÚerrÚmsgr	   r	   r
   Úimport_objectJ   s$    


zTraitDocumenter.import_objectc             C   sD   t j| |ƒ | jƒ }d|kr.|jdƒd d }| jdj|ƒdƒ dS )zo Add the directive header 'attribute' with the annotation
        option set to the trait definition.

        Ú
r   u    â€¦z   :annotation: = {0}z	<autodoc>N)r   Úadd_directive_headerÚ_get_trait_definitionÚ	partitionZadd_liner-   )r   ÚsigÚ
definitionr	   r	   r
   r7   l   s
    z$TraitDocumenter.add_directive_headerc       	      C   s¤   t j| jƒ}tj|ƒ}tj|jƒ}d}d}xL|svt|ƒ}|rX|dd… t	j
dfkrXd}q,|dd… t	j| jfkr,d}q,W t|ƒ}tj|ƒjƒ }tjr tj|dƒ}|S )z1 Retrieve the Trait attribute definition
        FNr   ú=Tzutf-8)ÚinspectÚ	getsourcer   ÚsixÚStringIOÚtokenizeÚgenerate_tokensÚreadlineÚnextÚtokenÚOPÚNAMEr"   Ú_get_definition_tokensÚ
untokenizeÚstripÚPY2Ú	text_type)	r   ÚsourceZ	string_ioÚtokensZtrait_foundZ
name_foundÚitemÚdefinition_tokensr;   r	   r	   r
   r8   }   s"    
z%TraitDocumenter._get_trait_definitionN)F)F)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r.   ZdirectivetypeZmember_orderÚpriorityÚclassmethodr   r   r   r5   r7   r8   r	   r	   r	   r
   r      s   

"r   c       	      C   s€   g }d}xr| D ]j\}}}}}|dkr,|d }|t jkr8P |||d | d |d f|d | d |d f|f}|j|ƒ qW |S )zÔ Given the tokens, extracts the definition tokens.

    Parameters
    ----------
    tokens : iterator
        An iterator producing tokens.

    Returns
    -------
    A list of tokens for the definition.
    Nr   r   )rE   ÚNEWLINEÚappend)	rN   rP   Ú
first_liner   r   ÚstartÚstopZ	line_textrO   r	   r	   r
   rH   š   s    
rH   c             C   s   | j tƒ dS )zA Add the TraitDocumenter in the current sphinx autodoc instance. N)Zadd_autodocumenterr   )r%   r	   r	   r
   Úsetup¾   s    r\   )rT   r=   r   rE   rA   r(   r?   Zsphinx.ext.autodocr   Ztrait_handlersr   Z
has_traitsr   r   r   rH   r\   r	   r	   r	   r
   Ú<module>   s   |$