U \Sh@sdZddlmZddlZddlZddlZddlZddlZddlZddlm Z ddlm Z m Z m Z m Z mZmZmZddlmZddlmZmZddlmZdd lmZdd lmZdd lmZmZmZdd l m!Z!dd l"m#Z#ddl$m%Z%ddl&m'Z'm(Z(m)Z)m*Z*ddl+m,Z,ddl-m.Z.m/Z/ddl0m1Z1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8m9Z9m:Z:ddl;mZ>ddl?m@Z@mAZAmBZBmCZCddlDmEZEmFZFe6GeHZIeJdejKZLdddddd d!d"ZMGd#d$d$eZNGd%d&d&eZOd}d(d)d*d+d,d-ZPd~d(d.d)d/d0d1d2ZQd(d.d3d4d5d6ZRGd7d8d8e2ZSdd(d.d)d9d:d;d<ZTdd(d.d)d=d>d?d@ZUddAd(d)dBdCdDdEZVGdFdGdGZWGdHdIdIeWe8ZXGdJdKdKeWe9ZYGdLdMdMeWe:ZZGdNdOdOe%ee[e[fZ\GdPdQdQe\Z]GdRdSdSe]Z^GdTdUdUe\Z_GdVdWdWe\Z`GdXdYdYe\ZaGdZd[d[eaZbGd\d]d]eaZcGd^d_d_eaZdGd`dadae\ZeGdbdcdce\ZfGdddedee<ZgGdfdgdge<ZhGdhdidie4Zidjd(d(dkdBdldmdnZjGdodpdpe(ZkGdqdrdre'ZldjdsdtdkdudvdwdxZmdjdydzd{d|ZndS)zThe Python domain.) annotationsN) Parameter)AnyIterableIteratorList NamedTupleTuplecast)nodes)ElementNode) directives)Inliner)addnodes)desc_signature pending_xrefpending_xref_condition)Sphinx)Builder)ObjectDescription)DomainIndex IndexEntryObjType)BuildEnvironment)___)TokenTokenProcessor)XRefRole)logging)Field GroupedField TypedField)SphinxDirective)signature_from_str)find_pending_xref_conditionmake_id make_refnodenested_parse_with_titles) OptionSpec TextlikeNodeaM^ ([\w.]*\.)? # class name(s) (\w+) \s* # thing name (?: \[\s*(.*)\s*])? # optional: type parameters list (?: \(\s*(.*)\s*\) # optional: arguments (?:\s* -> \s* (.*))? # return annotation )? $ # and nothing more modulekeywordoperatorobject exception statementzbuilt-in function)r-r.r/r0r1r2builtinc@s.eZdZUded<ded<ded<ded<dS) ObjectEntrystrdocnamenode_idobjtypeboolaliasedN__name__ __module__ __qualname____annotations__r@r@H/root/rtd-docs/venv/lib/python3.8/site-packages/sphinx/domains/python.pyr4Bs r4c@s6eZdZUded<ded<ded<ded<ded<dS) ModuleEntryr5r6r7synopsisplatformr9 deprecatedNr;r@r@r@rArBIs rBFr5r9ztuple[str, str, str, bool]) reftargetsuppress_prefixreturncCsd}|dr$|dd}|}d}nV|drJ|dd}|dd}n0|r^|dd}n|drv|d d}n|}|d ks|drd }nd }||||fS) zLParse a type string and return (reftype, reftarget, title, refspecific flag)F.NT~typing.Noneobjclass) startswithsplit)rFrG refspecifictitlereftyper@r@rAparse_reftargetQs"     rWBuildEnvironment | Nonezaddnodes.pending_xref)targetenvrGrHc Cs|r |jd|jdd}ni}t||\}}}}|jjrj|dd}td|ddtd|d dg}n t|g}t d |d |||d |S) z0Convert a type string to a cross reference node. py:modulepy:class)r[r\rIrLresolved condition*py) refdomainrVrFrT)r]) ref_contextgetrWconfig!python_use_unqualified_type_namesrSrr Textr) rYrZrGkwargsrVrUrT shortname contnodesr@r@rA type_to_xrefls(     rl list[Node]) annotationrZrHcs|jjdddfdd dddfdd ztj|d d }g}|D]}t|tjrp||d qPt|tjr| r|rt|d t j r|d  d kr| |tt||d dq|tt||qP||qP|WStk rt||gYSXdS)zParse type annotation.zast.ASTrmnoderHcst|tjr.t|jdd|jgSt|tjrh|j}| |j | |j |St|tj rt t ddt gSt|tjr(|jtkrt ddgSt|jtrt dt|jgSt|jtrt dt|jgSt|jtrt dt|jgStt|jgSt|tjr@|jSt|tjrX|jSt|tjrtt ddgSt|tjrt ddg}|jr|jD]4}| ||t dd|t q|||t dd |St|tj r"t!fd d |j"DgSt|tj#r>t|j$gSt|tj%rt&|jd dd krh|Srt&|jd ddkr|S|j}|t dd| |j'|t dd |ddkrt(|ddddD]*\}}t|tjrt)dd|||<q|St|tj*r<|j |j+St|tj,r|jrg}|jD]4}| ||t dd|t q\||nt ddt ddg}|St-dS)NrrIr]|z...rK[,]c3s|]}|VqdSNr@).0eunparser@rA sz5_parse_annotation..unparse..id>UnionOptionalLiteral)r~typing.LiteralrJ)start()). isinstanceast Attributer rhvalueattrBinOpleftextendoprightBitOrrdesc_sig_spacedesc_sig_punctuationConstantEllipsisr9desc_sig_keywordreprintZdesc_sig_literal_numberr5Zdesc_sig_literal_stringExprrInvertreltsappendpopModulesumbodyNamer{ Subscriptgetattrslice enumerateliteralUnaryOpoperandr SyntaxError)rpresultelemiZsubnode_unparse_pep_604_annotationZshort_literalsryr@rArys "               z"_parse_annotation..unparsez ast.Subscriptcs|j}t|tjr|j}g}t|tjrr||jd|jddD]$}|t||qJn||t |jdddkr|t| t d|S)NrrJr{r]r}rO) rrrrrr rrrrrr rh)rpZ subscriptZ flattenedeltrxr@rArs  z6_parse_annotation.._unparse_pep_604_annotationT) type_commentsrrLrK)rGN)rf"python_display_short_literal_typesrparserr rrrhstriprrastextrrlr5r)rnrZtreerrpr@rrA_parse_annotations(S   rcsdeZdZdddfdd Zdddd Zddd d Zddd d dZdddddddZZS)_TypeParameterListParserr5rOsigrHcs(|dd}t|gg|_dS)N r])replacersuper__init__ type_params)selfr signature __class__r@rArsz!_TypeParameterListParser.__init__z list[Token]rHcCsg}|r||jdD]0\}}|jtj|gkr||tj|g7}qq|jtjkrl||tj7}q|jtjdgtjdgtjdgr| qq|S)N))rr){})rrrt:=rs) fetch_tokenrcurrenttokenOPZ fetch_untilINDENTDEDENTmatchr)rtokensZldelimZrdelimr@r@rAfetch_type_param_specs"   z._TypeParameterListParser.fetch_type_param_speccCs(|r$|jtjkr|jj}|jrb|jtjdgtjdgrb|jtjdgkrZt j }qht j }nt j }t j }t j }||jr|jtjdgtjdgr|jtjdgkr|}||}|jtjdgkr|}||}|t j kr |t j kr td|jd||||f}|j|qdS)Nra**rrz6type parameter bound or constraint is not allowed for z parameters)rrrNAMErrpreviousrrrVAR_POSITIONAL VAR_KEYWORDPOSITIONAL_OR_KEYWORDemptyr_build_identifierr descriptionrr)rtp_nametp_kindtp_ann tp_defaultr type_paramr@r@rAr!s,        z_TypeParameterListParser.parse)rrHc slddlm}mfddfdd}g}t|}|D]b}|tjdgtjdgtjd gs|tjd gtjd gg}||j||d q||j q8t tj d ddd}d}|||||gD]\}}} |j||d } || |tjd gtjd goZ|tj tj tjtjdgtjdgtjdgoX| tj tj tjtjdgtjdgtjd g }qd |S)Nr)chainteecs |\}}t|dt||Sru)nextzip)iterableab)rr@rApairwiseDs  z<_TypeParameterListParser._build_identifier..pairwisec3s.|D]\\}}\}}|||fVq dSrur@)rrZ_zrc)rr@rA triplewiseIsz>_TypeParameterListParser._build_identifier..triplewiserrrrrar)nativer])rLrLz Frrtr) itertoolsrriterrrrr_pformat_tokenrr ENDMARKERrNUMBERSTRINGjoinr) rrrrZidentstokZis_unpack_operatorstoprafteridentr@)rrrArAs<     z*_TypeParameterListParser._build_identifierFrr9)rrrHcCs|r |jS|tjtjrdS|tjdgtjdgtjdgrJ|jdS|tjdgtjdgtjdgtjd gtjd gtjd gtjd gtjd gtjdgtjdgtjdgtjdgtjdgtjdgtjdgtjdgtjdgtjdgtjdgtjdgtjdgr d|jdS|jS)Nr]rrs# rrq&^<>+-rar@/z//%z<>z>>>z<=z>=z==z!=)rrrNEWLINErr)rrrr@r@rArks>   z'_TypeParameterListParser._pformat_token)F) r<r=r>rrrrr __classcell__r@r@rrArs  *rz!addnodes.desc_type_parameter_list)tp_listrZmulti_line_parameter_listrHc Cst|}||d<t|}||jD]\}}}}|tjtjhkrNtdt } |tj krr| t dd7} n|tj kr| t dd7} | t d|7} |tjk rVt||} | sq(| tdd7} | t7} tj d | } |drN|drN| } | dr$| dr$| | 7} n(| tdd7} | | 7} | tdd7} n| | 7} |tjk r| t7} | t dd 7} | t7} | tjd|d gd d 7} || 7}q(|S)z5Parse a list of type parameters according to PEP 695.rzQpositional-only or keyword-only parameters are prohibited in type parameter listsr]rarrrrr default_valueFclassesZsupport_smartquotes)r]r])rZdesc_type_parameter_listrrrrPOSITIONAL_ONLY KEYWORD_ONLYrZdesc_type_parameterrdesc_sig_operatorr desc_sig_namerrrrrRendswithrr inline) rrZrrparserrrrrrprnZ type_ann_exprZ type_ann_textr@r@rA_parse_type_listsP            r zaddnodes.desc_parameterlist)arglistrZrrHc Cst|}||d<td|}d}|jD]}|j|jkrb||jkrb|tddtdd7}|j|j kr||j |jdfkr|tddtdd7}t}|j|j kr|tdd7}|t d|j 7}nD|j|jkr|tdd7}|t d|j 7}n|t d|j 7}|j|jk r^t|j|}|tdd7}|t7}|tj d |7}|j|jk r|j|jk r|t7}|tdd 7}|t7}n|tdd 7}|tjd|jd gd d 7}||7}|j}q,|tjkr|tddtdd7}|S)z*Parse a list of arguments using AST parserrz(%s)Nr]rrarrrrFr)r]r])rdesc_parameterlistr& parametersvalueskindrdesc_parameterrrrrrnamerrnrrrrdefaultr rr) r rZrparamsrZ last_kindparamrpchildrenr@r@rA_parse_arglistsN       rrrO)signoder rrHc Cst}||d<|g}z`|dD]<}|}d}}|drx|t|d|d7<|dd}q:|d r||dd}qx|d r|d s|d7}|dd}q|dr|d7}|dd}q|r|dt d d t ||7<|rJ|t|d|d7<|d8}q|r$||d8}qJq$t |dkrvt Wn6t k rt}|t ||7}||7}Yn X||7}dS) z"Parse" a list of arguments separated by commas. Arguments can have "optional" annotations given by enclosing them in brackets. Currently, this will split at any comma, even if it's inside a string literal (e.g. default argument value). rrsrrrrLrJNrtz[]r]) rr rSrrRrZ desc_optionalrrrrlen IndexError)rr rZ paramliststackargumentZ ends_openZ ends_closer@r@rA_pseudo_parse_arglistsP       rc sleZdZejddddfdddddddddd fd d Zejddddfddddddddd d d d ZZS) PyXrefMixinNr5ztype[TextlikeNode]z Node | NonerXzInliner | Noner ) rolenamedomainrY innernodecontnoderZinlinerlocationrHc  stj||||||ddd} t| trd| d<|jd| d<|jd| d<t|\} } } } | | kr| | d<| | d<| | || | 7} nZ|jj r| j }| | dd }|d |}t d d |d d t d|d dig}| || S)N)r#r$TrTr[r\rVrFrIrLr]r^r_r`ra)r]r])r make_xrefrrrdrerWclearrfrgrrSrr)rrr rYr!r"rZr#r$rrVrFZreftitlerrrjZtextnoderkrr@rAr%8s6    zPyXrefMixin.make_xrefrmc  Csd} t| } t| |} t|o*||k} d} g}td| D]`}| rRt|}| s`| |rv| |pp|||n| | |||||||||dkr@d} q@|S)Nz>(\s*[\[\]\(\),](?:\s*o[rf]\s)?\s*|\s+o[rf]\s+|\s*\|\s*|\.\.\.)F)r~rz~typing.LiteralT) recompilerSr9rfilterr rhrrr%)rrr rYr!r"rZr#r$delimsZ delims_reZ sub_targetsZsplit_contnodeZ in_literalresultsZ sub_targetr@r@rA make_xrefs`s*    zPyXrefMixin.make_xrefs)r<r=r>r Zemphasisr%r,rr@r@rrAr7s$-rc@s eZdZdS)PyFieldNr<r=r>r@r@r@rAr-sr-c@s eZdZdS)PyGroupedFieldNr.r@r@r@rAr/sr/c@s eZdZdS) PyTypedFieldNr.r@r@r@rAr0sr0c @s@eZdZUdZejejejejejejejejdZded<e de dddd d d e d e d dddd d e de dddd de de dddde de dddddgZdZddd d!d"Zd#d$d%d&Zdd'd(d)d*d+Zd'd,d-d.d/Zdd(dd0d1d2Zd(dd'd3d4d5d6Zd3d$d7d8Zd3d$d9d:Zd'dd-d;d<Zd=S)>PyObjectz Description of a general Python object. :cvar allow_nesting: Class is an object that allows for nested namespaces :vartype allow_nesting: bool )noindex noindexentrynocontentsentrysingle-line-parameter-listsingle-line-type-parameter-listr- canonicalrnr+ option_spec parameterZ Parameters)rr9argrr.kwargZkwparamrQ)Z paramtypetypeT)labelnamesZ typerolenameZ typenames can_collapsevariable Variables)varZivarZcvar)vartype exceptionsZRaisesexc)Zraisesraiser1except)r=rr>r?Z returnvalueZReturnsF)ZreturnsrH)r=has_argr>Z returntypez Return type)Zrtype)r=rHr>Z bodyrolenamer5list[nodes.Node]rcCsgS)zTMay return a prefix to put before the object name in the signature. r@rrr@r@rAget_signature_prefixszPyObject.get_signature_prefixr9rcCsdS)zqMay return true if an empty argument list is to be generated even if the document contains none. Fr@rr@r@rA needs_arglistszPyObject.needs_arglistrtuple[str, str]rrrHc Cst|}|dkrt|\}}}}}|jd|jjd} |jjd} | rd} |r|| ksp|| dr||} |t | d d}q|r| d||} q| d|} n$d} |r| d} ||} nd} |} | |d<| |d <| |d <|jj j p |jj jp d } t |}|d }d |jkoR||d|d | koNd kn}|d}d|jko||d|d | kod kn}||}|rt|tkrtd|d|tjt|df|7}|r|t||7}n0| r$| r$|jj jr$| d}|t||7}|t||7}|rz|t||j|7}Wn6tk r}ztjd|||dW5d}~XYnX|rz|t||j|7}Wnftk rt|||YnFt tfk r }z"tjd|||dt|||W5d}~XYnXn|!r$|t"7}|rLt#||j}|tj$|df|7}|jd}|r|td|dt%t&'|7}| |fS)aJTransform 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 Nr-r[r\FrITr]rQfullnamerr5rJr6z^Python directive method get_signature_prefix() must return a list of nodes. Return value was 'z'.z could not parse tp_list (%r): %sr$z could not parse arglist (%r): %srnr)( py_sig_rer ValueErrorgroupsoptionsrerZrdrRrlstriprstriprf$python_maximum_signature_line_lengthZmaximum_signature_line_lengthspanrKr<r5 TypeErrorrdesc_annotation desc_addnameadd_module_namesZ desc_namer  ExceptionloggerwarningrrrNotImplementedErrorrMr rZ desc_returnsrr rh)rrrmprefixrrr Zretannmodname classnameZ add_modulerPmax_lenZsig_lenZ tp_list_spanrZ arglist_spanZmulti_line_type_parameter_listZ sig_prefixZnodetextrErannor@r@rAhandle_signatures        (  (         zPyObject.handle_signatureztuple[str, ...])sig_noderHcCsDd|kr dS|d}|d}|r2|f|dSt|dSdS)NrPr@r-rI)rerStuple)rrkrfrPr@r@rA_object_hierarchy_parts:s z PyObject._object_hierarchy_parts)rfrrHcCs tddS)z2Return the text for the index entry of the object.z!must be implemented in subclassesN)rc)rrfrr@r@rAget_index_textEszPyObject.get_index_textrOname_clsrrrHc Cs|jd|jjd}|r$|dnd|d}t|j|jjd|}|d||jj|t t |j d}|j ||j ||d|jd }|r|j ||j |d |d d |jkr|||} | r|jd d| |ddfdS)Nr-r[rIr]ridsrbrSr7T)r:r$r3entriessingle)rWrerZrdr(statedocumentrnote_explicit_targetr PythonDomain get_domain note_objectr8rn indexnode) rrprrrfrPr7r canonical_name indextextr@r@rAadd_target_and_indexIs    zPyObject.add_target_and_indexcCsd}|jr2|jd\}}|jr$|}n|r2|d}|rb||jjd<|jrb|jjdg}||d|jkr|jjdg}||jjd|jd|jjd<dS) aHandle object nesting before content :py:class:`PyObject` represents Python language constructs. For constructs that are nestable, such as a Python classes, this method will build up a stack of the nesting hierarchy so that it can be later de-nested correctly, in :py:meth:`after_content`. For constructs that aren't nestable, the stack is bypassed, and instead only the most recent object is tracked. This object prefix name will be removed with :py:meth:`after_content`. NrLrIr\ py:classesr- py:modulesr[) r> allow_nestingrrZrd setdefaultrrWre)rrerPZ name_prefixrmodulesr@r@rAbefore_content^s     zPyObject.before_contentcCs|jjdg}|jr8z |Wntk r6YnXt|dkrL|dnd|jjd<d|jkr|jjdg}|r||jjd<n|jjddS) a^Handle object de-nesting after content If this class is a nestable object, removing the last nested class prefix ends further nesting in the object. If this class is not a nestable object, the list of classes should not be altered as we didn't affect the nesting levels in :py:meth:`before_content`. r~rrLNr\r-rr[)rZrdrrrrrrW)rrrr@r@rA after_contents    zPyObject.after_contentcCs|dsdS|jjj}|jd}|jr8|dkr8d}nd}|d^}}|jdkrd|d||S|jdkrv||S|jd krd |||gSdS) NZ _toc_partsr]r8>methodfunction()r rPZhideallrI)rerZapprfparentZadd_function_parenthesesZtoc_object_entries_show_parentsr)rrkrfr8Zparensparentsrr@r@rA_toc_entry_names      zPyObject._toc_entry_nameN)r<r=r>__doc__rflag unchangedr8r?r0rr/r"r-Zdoc_field_typesrrKrMrjrmrnr}rrrr@r@r@rAr1sX      x !r1cseZdZUdZejZded<ede j iddddd Z d d d d Z dddddfdd Z ddddddZZS) PyFunctionzDescription of a function.r+r8asyncr5rIrcCs&d|jkrtddtgSgSdS)Nrr])rWrrrrJr@r@rArKs   zPyFunction.get_signature_prefixr9rcCsdSNTr@rLr@r@rArMszPyFunction.needs_arglistrNrrOroc st|||d|jkr|jd|jjd}|dd}|\}}|rvtd||f}|jdd||d dfn&d |d }|jdd ||d dfdS) Nr3r-r[rqr%s() (in module %s)rrrsr]zbuilt-in function; rpair) rr}rWrerZrdrrzr) rrprrrfr7rclstextrr@rAr}s   zPyFunction.add_target_and_index str | NonerfrprHcCsdSrur@rrfrpr@r@rArnszPyFunction.get_index_text)r<r=r>rr1r8copyr?updaterrrKrMr}rnrr@r@rrArs rcsJeZdZdZddfdd Zdddd fd d Zd dd dZZS)PyDecoratorFunctionzDescription of a decorator.rmrcsd|_tS)Nz py:functionrrrunrLrr@rArszPyDecoratorFunction.runr5rrNrOcs&t||}|dtdd|SNrrrrjinsertrr^rrrretrr@rArjsz$PyDecoratorFunction.handle_signaturer9cCsdSNFr@rLr@r@rArMsz!PyDecoratorFunction.needs_arglistr<r=r>rrrjrMrr@r@rrArsrcsdeZdZUdZejZded<ee j e j dddddfd d Z dddd d d Z Z S) PyVariablezDescription of a variable.r+r8r<rr5rrNrOc st||\}}|jd}|rTt||j}|tj|dtddt f|7}|jd}|r|t|dt tddt t |7}||fSNr<r]rrr rrjrWrerrZrr]rrr rhrrrrPretyprrrr@rArjs&       zPyVariable.handle_signaturercCs,|\}}|rtd||fStd|SdS)N%s (in module %s)z%s (built-in variable))r)rrfrprrr@r@rArnszPyVariable.get_index_textr<r=r>rr1r8rr?rrrrjrnrr@r@rrArs rc@sZeZdZUdZejZded<ede j idZ dddd d Z dd dd d dZ dS) PyClasslikezO Description of a class-like object (classes, interfaces, exceptions). r+r8finalTr5rIrcCsDd|jkr,tdtt|jtgSt|jtgSdS)Nr)rWr rhrrr8rJr@r@rArKs   z PyClasslike.get_signature_prefixrNrcCsL|jdkr2|std|dStd|d|fS|jdkrD|dSdSdS)NrQz%s (built-in class)rz%s (class in %s)r1r])r8rrr@r@rArns  zPyClasslike.get_index_textN)r<r=r>rr1r8rr?rrrrrKrnr@r@r@rArs rc@steZdZUdZejZded<ee j e j e j e j e j dddddZ d d d d d Z d dd dddZ dS)PyMethodzDescription of a method.r+r8)abstractmethodr classmethodr staticmethodr9rcCsdSrr@rLr@r@rArM2szPyMethod.needs_arglistr5rIrcCsg}d|jkr,|td|td|jkrT|td|td|jkr||td|td|jkr|td|td|jkr|td|t|S)NrrabstractrrrZstaticrWrr rhrrrrrer@r@rArK5s"     zPyMethod.get_signature_prefixrNrcCs|\}}z0|dd\}}|r6|jjjr6d||g}Wn8tk rp|r`td||fYSd|YSYnXd|jkrtd||fSd|jkrtd||fStd ||fSdS) NrIrJrz%s()rz%s() (%s class method)rz%s() (%s static method)z%s() (%s method))rsplitrZrfr_rrUrrW)rrfrprrclsnameZmethnamer@r@rArnHs  zPyMethod.get_index_textN)r<r=r>rr1r8rr?rrrrMrKrnr@r@r@rAr&s rcs:eZdZUdZejZded<ddfdd ZZ S) PyClassMethodzDescription of a classmethod.r+r8rmrcsd|_d|jd<tS)N py:methodTrrrWrrrLrr@rAras zPyClassMethod.run r<r=r>rr1r8rr?rrr@r@rrAr\s rcs:eZdZUdZejZded<ddfdd ZZ S)PyStaticMethodzDescription of a staticmethod.r+r8rmrcsd|_d|jd<tS)NrTrrrLrr@rArms zPyStaticMethod.runrr@r@rrArhs rcsJeZdZdZddfdd Zdddd fd d Zd dd dZZS)PyDecoratorMethodz!Description of a decoratormethod.rmrcsd|_tS)NrrrLrr@rArwszPyDecoratorMethod.runr5rrNrOcs&t||}|dtdd|Srrrrr@rArj{sz"PyDecoratorMethod.handle_signaturer9cCsdSrr@rLr@r@rArMszPyDecoratorMethod.needs_arglistrr@r@rrArtsrcsdeZdZUdZejZded<ee j e j dddddfd d Z dddd d d Z Z S) PyAttributeDescription of an attribute.r+r8rr5rrNrOc st||\}}|jd}|rTt||j}|tj|dtddt f|7}|jd}|r|t|dt tddt t |7}||fSrrrrr@rArjs&       zPyAttribute.handle_signaturercCs~|\}}z0|dd\}}|r6|jjjr6d||g}Wn4tk rl|r`td||fYS|YSYnXtd||fS)NrIrJrz%s (%s attribute)rrZrfr_rrUrrrfrprrrattrnamer@r@rArnszPyAttribute.get_index_textrr@r@rrArs rcsneZdZdZejZeej ej ej dddddfdd Z dd d d d Z dddd ddZ ZS) PyPropertyr)rrr<r5rrNrOcs\t||\}}|jd}|rTt||j}|tj|dtddt f|7}||fS)Nr<r]r) rrjrWrerrZrr]rr)rrrrPrerrrr@rArjs    zPyProperty.handle_signaturerIrcCsvg}d|jkr,|td|td|jkrT|td|t|td|t|S)NrrrrQpropertyrrr@r@rArKs  zPyProperty.get_signature_prefixrcCs~|\}}z0|dd\}}|r6|jjjr6d||g}Wn4tk rl|r`td||fYS|YSYnXtd||fS)NrIrJrz%s (%s property)rrr@r@rArnszPyProperty.get_index_text)r<r=r>rr1r8rrrrrrjrKrnrr@r@rrArs   rc@sVeZdZUdZdZdZdZdZddddej ej ej d Z d e d <d d ddZ dS)PyModulez8 Directive to mark description of a new module. TrJrFcCs|Srur@xr@r@rAzPyModule.cCs|Srur@rr@r@rArr)rDrCr2r4rEr+r8rmrc Cs*tt|jd}|jd}d|jk}||jjd<t }|j j |_ t |j |j ||jg}|st|j|j j d|}tjdd|gdd}|||j j |||||jd d|jd dd |jk|j|d||d ||d |}tjd||ddfgd} || ||j|S)Nrbrr2r[r-r]T)rqZismodrCrDrErSzmodule; r)rr)r rwrZrx argumentsrrWrdr sectionrtrur*contentZcontent_offsetr(rYZset_source_inforv note_modulereryrrindexrr) rr rfr2Z content_noderr7rYr|inoder@r@rArs4          z PyModule.runN) r<r=r>r has_contentrequired_argumentsoptional_argumentsfinal_argument_whitespacerrr8r?rr@r@r@rArs rc@s<eZdZUdZdZdZdZdZiZde d<ddd d Z d S) PyCurrentModulez This directive is just to tell Sphinx that we're documenting stuff in module foo, but links to module foo won't lead here. FrJrr+r8rmrcCs8|jd}|dkr(|jjddn ||jjd<gS)NrrOr[)rrrZrdr)rrfr@r@rAr&s  zPyCurrentModule.runN) r<r=r>rrrrrr8r?rr@r@r@rArs  rc@s$eZdZdddddddddZd S) PyXRefRolerr r9r5rN)rZrefnodehas_explicit_titlerUrYrHcCs|jd|d<|jd|d<|sv|d}|d}|dddkrv|dd}|d}|dkrv||dd}|dddkr|dd}d|d <||fS) Nr[r\rIrKrrJrLTrT)rdrerXrfind)rrZrrrUrYdotr@r@rA process_link0s     zPyXRefRole.process_linkN)r<r=r>rr@r@r@rAr/srrr )rr r8rrHcCsx|dkr dS|D]b}t|tjrtttj|}t|D]8}ttj|d }|dksf| dr8| |q8qdS)z+Filter ``:meta:`` field from its docstring.rbNrmetazmeta ) rr field_listr rfieldreversedZ field_bodyrrrRremove)rr r8rrpfieldsr field_namer@r@rAfilter_meta_fieldsFs  rc@s6eZdZdZdZedZedZd dddd d ZdS) PythonModuleIndexz< Index subclass to provide the Python module index. ZmodindexzPython Module IndexrNzIterable[str] | Nonez/tuple[list[tuple[str, list[IndexEntry]]], bool])docnamesrHc Csi}|jjjd}t|tdd}t|jjdddd}d}d }|D]D\}\}} } } } |rj||krjqH|D]&} || rn|t| d}| }qqnd}|s|d}}||d  g}| d d }||krN||kr|rH|d }t |d d |d |d|d|d|d|d <n*||sH| t ||d dddddd }n |d 7}d }| rht dnd}| t ||||| | || |}qHt|||k}t|}||fS)NZmodindex_common_prefixT)keyreversercSs |dS)Nr)lowerrr@r@rArfrz,PythonModuleIndex.generate..)rr]rrIrLrJrQrRZ Deprecated)r rZrfsortedrdataitemsrRrrrSrrr)rrrZignoresrZ prev_modnameZ num_toplevelsrfr6r7rC platformsrEignorestrippedrrpackagelastsubtypeZ qualifierZcollapseZsorted_contentr@r@rAgenerate^s\        zPythonModuleIndex.generate)N) r<r=r>rrr localnamerjrr@r@r@rArUs rc@s"eZdZUdZdZdZeedddeedddeeddd deed d ddeed d deed d deedd deedddeeddddeedddd Zde d<e e e e e eeeeeeeed Zeeeddeeeeddeed ZiidZde d<egZedd d!d"ZdWd%d%d%d&d'd(d)d*d+Zed,d d-d.Zd%d%d%d%d&d(d/d0d1Z d%d(d2d3d4Z!d5d6d(d7d8d9Z"dXd;d%d%d%dd?d@dAZ#d;d%dBd%d%dCdDdEdFdGdHZ$d;d%dBd%dCdDdIdJdKdLZ%dBd%d%dMdDdNdOdPZ&dQd dRdSZ'dDd*s z)PythonDomain.find_obj..r)rrZobjtypes_for_rolerr8r) rrZrfrgrr<r matchesZnewnamerPr@r rAfind_objsN         zPythonDomain.find_objrrr Element | None)rZ fromdocnamebuilderr<rYrpr"rHcCs>|d}|d} |dr"dnd} |||| ||| } | sZ|dkrZ|||| |d| } | sz|dkrz|||| |d| } | sdSt| dkrd d | D} t| dkr| } n*tjtd |d d d| Ddd|d| d\} }|ddkr|||| |St |d}|r|j }n|g}t |||d|d|| SdS)Nr[r\rTrJrrrrcSsg|]}|djs|qS)rJ)r:)rvrdr@r@rAr Xs z-PythonDomain.resolve_xref..z5more than one target found for cross-reference %r: %sz, css|]}|dVqdS)rNr@)rvrr@r@rArz]sz,PythonDomain.resolve_xref..refpython)r<rr$rr-r^) rehasattrr rrarbrr_make_module_refnoder'rr))rrZrrr<rYrpr"rfrr r Z canonicalsrrPrrr@r@rA resolve_xref?s@          zPythonDomain.resolve_xrefzlist[tuple[str, Element]])rZrrrYrpr"rHc Cs|d}|d}g} |||||dd} t| dk} | D]\} } | rP| jrPq<| ddkrx| d|||| |fqrrr=rrrr?rrrrrrrrrrrrrrZrolesrrindicesrrryrrrrr rrrrrr@r@r@rArwsx    8/# rwrrr)rrZrpr"rHcCsddddd}|ddkr"dS|d d krB|d d krB|S|d d kr||d }ttt|drp|S||r||SdS)z1Do not emit nitpicky warnings for built-in types.r5r9)srHcSs$|dr|ddd}|tjkS)NrMrIrJ)rRrStyping__all__)rr@r@rAistypings z"builtin_resolver..istypingrcrbNrV)rQrPrFrO)rQrPrE)reinspectisclassrbuiltins)rrZrpr"rrFr@r@rAbuiltin_resolvers r!r)rrHcCsp|d|t|ddd|jdddtdhd|ddd|dt|jd td d d d dddS)Nzsphinx.directivesrgFrZrZ)typesrzobject-description-transformzmissing-referencei)priorityr3rRT)versionZ env_versionZparallel_read_safeZparallel_write_safe)Zsetup_extensionZ add_domainrwZadd_config_valuerconnectrr!)rr@r@rAsetups    r&)F)NF)NF)NF)F)or __future__rrr rr'rrrrrrrrr r Zdocutilsr Zdocutils.nodesr r Zdocutils.parsers.rstrZdocutils.parsers.rst.statesrZsphinxrZsphinx.addnodesrrrZsphinx.applicationrZsphinx.buildersrZsphinx.directivesrZsphinx.domainsrrrrZsphinx.environmentrZ sphinx.localerrZsphinx.pycode.parserrrZ sphinx.rolesr Z sphinx.utilr!Zsphinx.util.docfieldsr"r#r$Zsphinx.util.docutilsr%Zsphinx.util.inspectr&Zsphinx.util.nodesr'r(r)r*Zsphinx.util.typingr+r, getLoggerr<rar(VERBOSErTZpairindextypesr4rBrWrlrrr rrrr-r/r0r5r1rrrrrrrrrrrrrrrrwr!r&r@r@r@rAs  $                >66L&%6  -36H