3 d}@sdZddlmZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddlmZddlmZe jeZd d ZGd d d e Zd dZddZddZdS)zP A Trait Documenter (Subclassed from the autodoc ClassLevelDocumenter) ) import_moduleN)ClassLevelDocumenter)logging) MetaHasTraits) TraitType) generic_traitcCs"t|to ||jko |j|tk S)zJ Check if the name is in the list of class defined traits of ``cls``. ) isinstancerZ__class_traits__r)nameclsr >/tmp/pip-build-7vycvbft/traits/traits/util/trait_documenter.py_is_class_trait"s  r c@sFeZdZdZdZdZdZdZeddZ dd d Z d d Z d dZ dS)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`. Ztraitattribute attribute< cCs"|rtt|tpt||j}|S)z? Check that the documented member is a trait instance. ) issubclasstyperr object)r memberZ membernameZisattrparentcheckr r r can_document_member?s z#TraitDocumenter.can_document_memberFcCsdS)z" Trait attributes have no members Nr )selfZ all_membersr r r document_membersJsz TraitDocumenter.document_memberscCsyTt|j}|_x"|jddD]}|j||}q"W|jd}||_d|_||_dStk r}zZ|j j r|j j j r|j j j t jjd}|jj|j|jt|j||j jdSd}~XnXdS)zy Get the Trait object. Notes ----- Code adapted from autodoc.Documenter.import_object. NTzeautodoc can't import/find {0} {r1}, it reported error: "{2}", please check your spelling and sys.pathFr)rmodnamemoduleZobjpathZget_attr object_namerr Exceptionenvappquietinfo traceback format_excrstripZ directivewarnformatobjtypestrfullnameZ note_reread)rcurrentpartr errmsgr r r import_objectNs"  zTraitDocumenter.import_objectc Cstj||yt|j|jd}Wn.tk rNtjdj|j|jdddSXd|krj|j ddd}|j d j|d dS) zo Add the directive header 'attribute' with the annotation option set to the trait definition. )r trait_namez>No definition for the trait {!r} could be found in class {!r}.T)exc_infoN ru …z :annotation: = {0}z ) radd_directive_headertrait_definitionrr ValueErrorloggerwarningr) partitionZadd_line)rsig definitionr r r r5os  z$TraitDocumenter.add_directive_headerN)F) __name__ __module__ __qualname____doc__r*Z directivetypeZ member_orderpriority classmethodrrr1r5r r r r r,s !rc Cstj|}tj|}tj|j}d}d}xV|s~t|d}|dkrBP|rb|ddtj dfkrbd}q*|ddtj |fkr*d}q*W|st dj ||t |}tj|j} | S)a Retrieve the portion of the source defining a Trait attribute. For example, given a class:: class MyModel(HasStrictTraits) foo = List(Int, [1, 2, 3]) ``trait_definition(cls=MyModel, trait_name="foo")`` returns ``"List(Int, [1, 2, 3])"``. Parameters ---------- cls : MetaHasTraits Class being documented. trait_name : str Name of the trait being documented. Returns ------- str The portion of the source containing the trait definition. For example, for a class trait defined as ``"my_trait = Float(3.5)"``, the returned string will contain ``"Float(3.5)"``. Raises ------ ValueError If *trait_name* doesn't appear as a class-level variable in the source. FN=Tz*No trait definition for {!r} found in {!r})inspect getsourceioStringIOtokenizegenerate_tokensreadlinenexttokenOPNAMEr7r)_get_definition_tokens untokenizestrip) r r2sourceZ string_iotokensZ trait_foundZ name_founditemdefinition_tokensr<r r r r6s*     r6c Csg}d}xr|D]j\}}}}}|dkr,|d}|tjkr8P|||d|d|df|d|d|df|f}|j|qW|S)z Given the tokens, extracts the definition tokens. Parameters ---------- tokens : iterator An iterator producing tokens. Returns ------- A list of tokens for the definition. Nrr)rMNEWLINEappend) rTrV first_linerr startstopZ line_textrUr r r rPs  rPcCs|jtdS)zA Add the TraitDocumenter in the current sphinx autodoc instance. N)Zadd_autodocumenterr)r"r r r setupsr\)r@ importlibrrErGrMrIr%Zsphinx.ext.autodocrZ sphinx.utilrZtraits.has_traitsrZtraits.trait_typerZ traits.traitsr getLoggerr=r8r rr6rPr\r r r r s"        _=$