\c@sdZddlZddlmZddlmZddlmZddlm Z m Z ddl m Z m Z ddlmZdd lmZmZmZdd lmZmZdd lmZdd lmZdd lmZmZmZddlm Z ddl!m"Z"e#ryddl$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1nej2e3Z4ej5dej6Z7iedd6edd6edd6edd6edd6edd6edd6Z8e e8de e _8dZ9de:fd YZ;d!e;efd"YZ<d#e;efd$YZ=d%e;efd&YZ>d'efd(YZ?d)e?fd*YZ@d+e?fd,YZAd-e?fd.YZBd/e:fd0YZCd1eCe@fd2YZDd3eCeBfd4YZEd5e fd6YZFd7e fd8YZGd9efd:YZHd;efd<YZId=efd>YZJd?ZKdS(@s sphinx.domains.python ~~~~~~~~~~~~~~~~~~~~~ The Python domain. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. iN(tnodes(t directives(t iteritems(taddnodestlocale(tDeprecatedDicttRemovedInSphinx30Warning(tObjectDescription(tDomaintObjTypetIndex(t_t__(tXRefRole(tlogging(tFieldt GroupedFieldt TypedField(tSphinxDirective(t make_refnode(tAnytDicttIterabletIteratortListtTupletUnion(tSphinx(tBuilder(tBuildEnvironments ^ ([\w.]*\.)? # class name(s) (\w+) \s* # thing name (?: \(\s*(.*)\s*\) # optional: arguments (?:\s* -> \s* (.*))? # return annotation )? $ # and nothing more tmoduletkeywordtoperatortobjectt exceptiont statementsbuilt-in functiontbuiltinsdsphinx.locale.pairindextypes is deprecated. Please use sphinx.domains.python.pairindextypes instead.cCs#tj}|g}yx|jdD]}|j}d}}xJ|jdr|jtj|dc|d7<|dj}qGWx-|jdr|j|dj}qWx=|jdr|jd r|d7}|d j}qWx-|jdr0|d7}|d j}qW|rV|dctj ||7( tsuperR;t make_xreftTrueR+R)ttraverseRtTexttparenttindex( tselftrolenametdomainttargett innernodetcontnodetenvtresulttprefixttexttnode((s4lib/python2.7/site-packages/sphinx/domains/python.pyRAvs     "c Csd}tj|}tj||} t|o?|j|k} g} xtd| D]q} | rytj| }n|j | r| j |p|| | q[| j |j ||| |||q[W| S(Ns((\s*[\[\]\(\),](?:\s*or\s)?\s*|\s+or\s+)( tretcompileR)tbooltastexttfiltertNoneRRDtmatchR,RA( RGRHRIRJRKRLRMtdelimst delims_ret sub_targetstsplit_contnodetresultst sub_target((s4lib/python2.7/site-packages/sphinx/domains/python.pyt make_xrefss N(t__name__t __module__RtemphasisRWRAR_(((s4lib/python2.7/site-packages/sphinx/domains/python.pyR;us  tPyFieldcBseZejdddZRS(cCsF|dkr!|dkr!d}ntt|j||||||S(NtclassRWtobj(R@RcRA(RGRHRIRJRKRLRM((s4lib/python2.7/site-packages/sphinx/domains/python.pyRAs N(R`RaRRbRWRA(((s4lib/python2.7/site-packages/sphinx/domains/python.pyRcstPyGroupedFieldcBseZRS((R`Ra(((s4lib/python2.7/site-packages/sphinx/domains/python.pyRfst PyTypedFieldcBseZejdddZRS(cCsF|dkr!|dkr!d}ntt|j||||||S(NRdRWRe(R@RgRA(RGRHRIRJRKRLRM((s4lib/python2.7/site-packages/sphinx/domains/python.pyRAs N(R`RaRRbRWRA(((s4lib/python2.7/site-packages/sphinx/domains/python.pyRgstPyObjectcBsLeZdZiejd6ejd6ejd6Zeddeddd3dddd4de eddeddddd5dddd6de e ddeddddd7de e d#ded$d%e dd8e d(ded)d%e dd9d+dgZe Zd,Zd-Zd.Zd/Zd0Zd1Zd2ZRS(:s Description of a general Python object. :cvar allow_nesting: Class is an object that allows for nested namespaces :vartype allow_nesting: bool tnoindexRt annotationt parametertlabelt ParameterstnamestparamtargR7Rtkwargtkwparamt typerolenameRdt typenamest paramtypettypet can_collapsetvariablet VariablesRHRetvartivartcvartvartypet exceptionstRaisestexctraisestraiseR"texceptt returnvaluetReturnsthas_argtreturnstreturnt returntypes Return typetrtypet bodyrolenamecCsdS(sTMay return a prefix to put before the object name in the signature. t((RGtsig((s4lib/python2.7/site-packages/sphinx/domains/python.pytget_signature_prefixscCstS(sqMay return true if an empty argument list is to be generated even if the document contains none. (tFalse(RG((s4lib/python2.7/site-packages/sphinx/domains/python.pyt needs_arglistscCstj|}|d kr$tn|j\}}}}|jjd|jjjd}|jjjd} | rt } |r|j | r||} |t | j d}q|r| d||} q| d|} n4t } |r|jd} ||} n d} |} ||d<| |d<| |d<|j|} | rh|tj| | 7}n|r|tj||7}nq| r|jjjr|jjd|jjjd}|r|dkr|d} |tj| | 7}qn|jjd }|tj||7}|s|jrE|tj7}n|rd|tj||7}n|r|tjd |d |7}n| |fSt|||r|tj||7}n|r|tjd |d |7}n| |fS( sJTransform a Python signature into RST nodes. Return (fully qualified name of the thing, classname if any). If inside a class, the current class name is handled intelligently: * it is stripped from the displayed name if present * it is added to the full name (return value) if not present Rs py:modulespy:classR=RRdtfullnameR~Rjt N(t py_sig_reRXRWt ValueErrortgroupstoptionstgetRMt ref_contextRR+R1tlstripRBtrstripRRtdesc_annotationt desc_addnametconfigtadd_module_namest desc_nameRR(t desc_returnsR:(RGRR3tmt name_prefixtnameR4tretanntmodnamet classnamet add_moduleRt sig_prefixtnodetexttanno((s4lib/python2.7/site-packages/sphinx/domains/python.pythandle_signaturesf            !  !cCstddS(s2Return the text for the index entry of the object.s!must be implemented in subclassesN(tNotImplementedError(RGRR((s4lib/python2.7/site-packages/sphinx/domains/python.pytget_index_textFscCs[|jjd|jjjd}|r4|dp7d|d}||jjjkr|dj||dj||j |d<|jjj ||jj d d }||kr|j j j d |d |jj||dd d|jn|jj|jf|| Description of a class member (methods, attributes). cCs|jjdS(Ntmethod(RR/(RG((s4lib/python2.7/site-packages/sphinx/domains/python.pyRscCs*|jdkrdS|jdkr&dSdS(Nt staticmethodsstatic t classmethods classmethod R(R(RGR((s4lib/python2.7/site-packages/sphinx/domains/python.pyRs c Cs|\}}|jjj}|jdkry|jdd\}}Wn3tk r{|rptd||fSd|SnX|r|rtd|||fStd||fSn|jdkrQy|jdd\}}Wn3tk r|r td||fSd|SnX|r:|r:td |||fStd ||fSn0|jd kry|jdd\}}Wn3tk r|rtd||fSd|SnX|rtd |||fStd ||fSn|jdkr}y|jdd\}}Wn/tk rB|r;td||fS|SnX|rf|rftd|||fStd||fSndSdS(NRR=is%s() (in module %s)s%s()s%s() (%s.%s method)s%s() (%s method)Rs%s() (%s.%s static method)s%s() (%s static method)Rs%s() (%s.%s class method)s%s() (%s class method)t attributes%s (in module %s)s%s (%s.%s attribute)s%s (%s attribute)R(RMRRRtrsplitRR ( RGRRRtclst add_modulestclsnametmethnametattrname((s4lib/python2.7/site-packages/sphinx/domains/python.pyRsZ           (R`RaRRRR(((s4lib/python2.7/site-packages/sphinx/domains/python.pyRs  tPyDecoratorMixincBs eZdZdZdZRS(s) Mixin for decorator directives. cCs;tt|j||}|jdtjdd|S(Nit@(R@RRtinsertRR(RGRR3tret((s4lib/python2.7/site-packages/sphinx/domains/python.pyRscCstS(N(R(RG((s4lib/python2.7/site-packages/sphinx/domains/python.pyR%s(R`RaRRR(((s4lib/python2.7/site-packages/sphinx/domains/python.pyRs tPyDecoratorFunctioncBseZdZdZRS(sE Directive to mark functions meant to be used as decorators. cCsd|_tj|S(Ns py:function(RRtrun(RG((s4lib/python2.7/site-packages/sphinx/domains/python.pyR.s (R`RaRR(((s4lib/python2.7/site-packages/sphinx/domains/python.pyR*stPyDecoratorMethodcBseZdZdZRS(sC Directive to mark methods meant to be used as decorators. cCsd|_tj|S(Ns py:method(RRR(RG((s4lib/python2.7/site-packages/sphinx/domains/python.pyR9s (R`RaRR(((s4lib/python2.7/site-packages/sphinx/domains/python.pyR5stPyModulecBs]eZdZeZdZdZeZidd6dd6ej d6ej d6Z d Z RS( s8 Directive to mark description of a new module. iicCs|S(N((tx((s4lib/python2.7/site-packages/sphinx/domains/python.pytIstplatformcCs|S(N((R((s4lib/python2.7/site-packages/sphinx/domains/python.pyRJstsynopsisRit deprecatedcCsD|jdj}d|jk}||jjdiiiR<(RRRtrfindRB(RGRMtrefnodethas_explicit_titlettitleRJtdot((s4lib/python2.7/site-packages/sphinx/domains/python.pyt process_links    (R`RaR(((s4lib/python2.7/site-packages/sphinx/domains/python.pyRstPythonModuleIndexcBs8eZdZdZedZedZddZRS(s< Index subclass to provide the Python module index. tmodindexsPython Module IndexRc Cs)i}d}|jjjd}t|dtdt}tt|jjddd}d}d}x|D]\}\}} } } |r||krqonx=|D]/} |j | r|t| }| } PqqWd} |s| d}} n|j |dj g}|j dd}||kr||krV|rd |d d osRvtrefR tpythontlocationR( RthasattrR.RWR1tloggerRR tjoint_make_module_refnodeR(RGRMt fromdocnametbuilderRvRJRQRLRRR(R)RRe((s4lib/python2.7/site-packages/sphinx/domains/python.pyt resolve_xrefcs" c Cs|jd}|jd}g} |j||||dd} x| D]\} } | ddkr| jd|j||| |fqI| jd|j| dt||| d| || fqIW| S(Ns py:modulespy:classiRspy:modspy:i(RR.RWR,R6trole_for_objtypeR( RGRMR7R8RJRQRLRRR]R)RRe((s4lib/python2.7/site-packages/sphinx/domains/python.pytresolve_any_xrefzs  c Cs|jd|\}}}}|} |r:| d|7} n|rS| td7} n|rn| d|d7} nt|||d||| S(NRs: s (deprecated)s (t)smodule-(RR R( RGR8R7RRLRRRRR((s4lib/python2.7/site-packages/sphinx/domains/python.pyR6s ccsx@t|jdD]+\}}||d|dd|dfVqWxMt|jdD]8\}\}}|dkrW|||||dfVqWqWWdS(NRRismodule-Ri(RR(RGRtinfotrefnameRRv((s4lib/python2.7/site-packages/sphinx/domains/python.pyt get_objectss  #& cCs`|jd}|jd}|jd}|dkr=dSdjtd|||gSdS(Ns py:modulespy:classR?R=(RRWR5RV(RGRQRRRJ((s4lib/python2.7/site-packages/sphinx/domains/python.pytget_full_qualified_names  (R`RaRRRlR R R&RRRRRRRRRRBtrolest initial_dataRtindicesR#R%R.R9R;R6R?R@(((s4lib/python2.7/site-packages/sphinx/domains/python.pyRs`           @    cCs-|jtidd6dd6td6td6S(NR$tversionit env_versiontparallel_read_safetparallel_write_safe(t add_domainRRB(tapp((s4lib/python2.7/site-packages/sphinx/domains/python.pytsetups  (LRRRtdocutilsRtdocutils.parsers.rstRtsixRtsphinxRRtsphinx.deprecationRRtsphinx.directivesRtsphinx.domainsRR R t sphinx.localeR R t sphinx.rolesR t sphinx.utilRtsphinx.util.docfieldsRRRtsphinx.util.docutilsRtsphinx.util.nodesRRttypingRRRRRRRtsphinx.applicationRtsphinx.buildersRtsphinx.environmentRt getLoggerR`R4RStVERBOSERtpairindextypesR:R!R;RcRfRgRhRRRRRRRRRRRRJ(((s4lib/python2.7/site-packages/sphinx/domains/python.pyt sh 4        25  K  +H