FeX_RdZddlmZddlZddlZddlZddlmZmZm Z ddl m Z ddl m Z ddlmZddlmZer2dd lmZdd lmZmZdd lmZdd lmZdd lmZddlmZddlm Z ddl!m"Z"ejFe$Z%ejLdejNZ(e(Z)GddZ*dmdZ+dndodZ,dpdZ-e j\e j^e j`e jbfZ2dqdZ3e j^e j`e jhe jjfZ6e jnfZ8drdZ9dsdZ:dtdZ;dudvdZ dy dzdZ?dsdZ@d{d ZAgd!ZB d|d"ZC d}d#ZDd~d$ZEejLd%ZFejLd&ZGid'd(d)d*d+d,d-d.d/d0d1d2d3d4d5d4d6d7d8d*d9d:d;d<d=d0d>d?d@dAdBd2dCd2idDdEdFdGdHdIdJdGdKd0dLd?dMd2dNdOdPd7dQdRdSdGdTdUdVdOdWdXdYdZd[dEZHd\d]d^d_d`daZI d ddbZJ ddcZK du dddZLddeZMddfZNddgZOe je je je jne jje je jfZUdqdhZVddiZWddjZXddkZYeYe j*_ZddlZ[e[e j*_\y)z3Docutils node-related utility functions for Sphinx.) annotationsN) TYPE_CHECKINGAnyCallable)nodes)addnodes)__)logging)Iterable)ElementNode) Directive)Inliner) StringList)Builder)BuildEnvironment)Tagsz^(.+?)\s*(?$c(eZdZdZddZddZddZy) NodeMatcheraTA helper class for Node.findall(). It checks that the given node is an instance of the specified node-classes and has the specified node-attributes. For example, following example searches ``reference`` node having ``refdomain`` and ``reftype`` attributes:: matcher = NodeMatcher(nodes.reference, refdomain='std', reftype='citation') doctree.findall(matcher) # => [, , ...] A special value ``typing.Any`` matches any kind of node-attributes. For example, following example searches ``reference`` node having ``refdomain`` attributes:: from __future__ import annotations from typing import TYPE_CHECKING, Any matcher = NodeMatcher(nodes.reference, refdomain=Any) doctree.findall(matcher) # => [, , ...] c ||_||_yN)classesattrs)self node_classesrs 3/usr/lib/python3/dist-packages/sphinx/util/nodes.py__init__zNodeMatcher.__init__;s#  cF |jrt||jsy|jrbt|tjsy|jj D]*\}}||vry|t ur|j||k7s*yy#t$rYywxYw)NFT) r isinstancerrr itemsrget Exception)rnodekeyvalues rmatchzNodeMatcher.match?s ||JtT\\$Bzz!$ 6 "&**"2"2"4%JC$$# #%/$ %  s."B&B %B2BBB B B c$|j|Sr)r')rr$s r__call__zNodeMatcher.__call__Uszz$rN)rz type[Node]rrreturnNoner$r r*bool)__name__ __module__ __qualname____doc__rr'r)rrrr$s,, rrcL|jd|jjS)z Return full module dotted path like: 'docutils.nodes.paragraph' :param nodes.Node node: target node :return: full module dotted path .)r/ __class__r.r$s rget_full_module_namer7Ys%oo a 7 78 99rc |jj}|rt ||kDr|d|dz}|S#t$rt|}Y0wxYw)a return DOM XML representation of the specified node like: 'New in version...' :param nodes.Node node: target node :param int length: length of return value to be striped. if false-value is specified, repr_domxml returns full of DOM XML representation. :return: DOM XML representation Nz...)asdomtoxmlr#strlen)r$lengthtexts r repr_domxmlr?csZzz|!!##d)f$GV}u$ K 4ys:AAct|tjr||jsptj dt |t||j}|j|_ |jdz |_ |j|_nAt|tjr'|js|jj|_ t|tjrl|j`tj dt |t||jj|jjc|_ |_ t|tjrl|j`tj dt |t||jj|jjc|_ |_ t|tjrtj dt |t|tt!|jj#tjD]L}t%j&dt%j(|jzd|j|_Nt|tj*rl|j`tj dt |t||jj|jjc|_ |_ t|tj,r>|j2t/j0t25t5||_ ddd|js|j|_|jr |jryt|tj6tjtjtj8frBtj dt |t| t5||_ d |_ yy#1swYxYw#t2$rd|_ Yd |_ ywxYw) Nz7[i18n] PATCH: %r to have source, line and rawsource: %sz)[i18n] PATCH: %r to have source, line: %sz#[i18n] PATCH: %r to have source: %sz&[i18n] PATCH: %r to have rawsource: %sz \s*:\s*%sz,[i18n] PATCH: %r to have source and line: %sr)r r classifier rawsourceloggerdebugr7r?parentsourcelineastextimagetitletermreversedlistfindallresubescapetopic literal_block contextlibsuppress ValueErrorget_node_sourcerubric field_name)r$definition_list_itemrCs rapply_source_workaroundr]ws8 $(()$.. N)$/T1B D#{{*11 (--1  D%** +DKKkk(( $ $)< @)$/T1B D!%!3!3T[[5E5E TY$ $)< :)$/T1B D!%!3!3T[[5E5E TY$ # =)$/T1B D#4 (;(;E> {{t~~ 4 LL JJ KK       C)$/T1B D )$/DK   0 0* DK  s6Q;Q Q Q:9Q:clt|tjryt|tjr#|j ds|j dryt|tj rd|vryt|tjr|js*tjdt|t|yt|tr.d|vr*tjdt|t|y|j dds*tjdt|t|yt|tjr<|jdd k(r*tjd t|t|yyt|tj ryy) NT translatablealtFz)[i18n] SKIP %r because no node.source: %szO[i18n] SKIP %r because node is in IGNORED_NODES and no node['translatable']: %sz3[i18n] SKIP %r because not node['translatable']: %srorphanz&[i18n] SKIP %r because orphan node: %s)r rr_rrKr"Inline TextElementrHrErFr7r? IGNORED_NODESr[childrenmetar6s ris_translatablergsP$--.$ $$((>*Bdhhuo$ %.*D$))*{{ LLD-d3[5F H dM *~T/I LL;-d3[5F Hxx- LLN-d3[5F H dE,, -$--2Bh2N LLA-d3[5F H$ # rc#|K|jtD]}t|tjr|j D]}||f :t|t r|j}|s|j}nt|tjrI|jdr ||df|jdr|jd|d}d|}nMd}nJt|tjr|d}n*|jjdd j}|s||f"y w) z3Extract translatable messages from a document tree.r`r_ original_uriuriz .. image:: rBcontent  N)rPrgr rr_extract_original_messagesLITERAL_TYPE_NODESrDrJrrKr"rfreplacestrip)doctreer$msg image_uris rextract_messagesrus0 dH11 2557 Ci  d. /..Ckkm ekk *xxDK''xx' HH^T%[A #I;/ ejj )y/C..((s399;C )O1s D.D<2 D<cpt|D]}|js|jcSd}t|)Nznode source not found)traverse_parentrHrXr$pnoderss rrYrYs8 &  <<<<   "C S/rcpt|D]}|js|jcSd}t|)Nznode line not found)rwrIrXrxs r get_node_liner{s8 & ::::  C S/rc#TK|r"| t||r||j}|r!yywr)r rG)r$clss rrwrw#s*  ;*T3/J{{ s#((ch|jj|}|dkDr|j|dz Sy)NrrA)rGindex)r$poss r get_prev_noder*s3 ++  D !C Qw{{37##rc#Kttjd}|j|D]}d|vr|d}n|d}||fyw)z6Traverse translatable index node from a document tree.F)inline raw_entriesentriesN)rrrrP)rrmatcherr$rs rtraverse_translatable_indexr2sU(..7G( D =)G9oGGm sAA c\|jj}|jj}g|j_d|j_ |j|||d||j_||j_S#||j_||j_wxYw)zVersion of state.nested_parse() that allows titles and does not require titles to have the same decoration as the calling document. This is useful when the parsed content comes from a completely different context, such as docstrings. rrA) match_titles)memo title_styles section_level nested_parse)staterkr$content_offsetsurrounding_title_stylessurrounding_section_levels rnested_parse_with_titlesr?s %zz66 % 8 8 EJJ EJJ=!!'>4a!P": #<  #; #<  s B$B+c$|j}|jtjD]}d|d< t |jtj D]}|j j||jS)z&Like node.astext(), but ignore images.rBr`) deepcopyrPrrKrOrawrGremoverJ)r$imgrs r clean_astextrSsq ==?D||EKK(E DLL+, # ;;=rctj|}|r#d|jd|jdfSd||fS)z3Split role content into title and target, if given.TrAF)explicit_title_rer'group)r>r's rsplit_explicit_titler]s?  # #D )E U[[^U[[^33 $ r)singlepairdoubletripleseeseealsocddlm}g}|j}|}d}|jdrd}|ddj }|D]{}|j|ds|t |dzdj}||d|}t jtd |||d |jd |||df|StD]U}|j|ds|t |dzdj}|d k(rd }|j||||df|S|jdD]S}|j}d}|jdrd}|ddj }|s>|jd|||dfU|S)Nr)pairindextypesrB!mainrA:z; zK%r is deprecated for index entries (from entry %r). Use 'pair: %s' instead.r)typerr,r) sphinx.domains.pythonrrq startswithlstripr<rEwarningr append indextypessplit)entrytargetidr indexentriesoentryr index_typer&s rprocess_index_entryrjs4@BL KKME F D ab   "$M   zl!, -#j/A-./557E%j12"UGE?ch|jt}|jt}tjd|j ddj d}tjddj|j}tjd|}t|S)aConvert `string` into an identifier and return it. This function is a modified version of ``docutils.nodes.make_id()`` of docutils-0.16. Changes: * Allow to use capital alphabet characters * Allow to use dots (".") and underscores ("_") for an identifier without a leading character. # Author: David Goodger # Maintainer: docutils-develop@lists.sourceforge.net # Copyright: This module has been placed in the public domain. NFKDasciiignore-rmrB) translate_non_id_translate_digraphs_non_id_translate unicodedata normalizeencodedecode _non_id_charsrRjoinr_non_id_at_endsr;)stringids r_make_idrs   4 5B ' (B   vr * 1 1'8 D K KG TB   3 4 5B   R $B r7Nrz[^a-zA-Z0-9._]+z^[-0-9._]+|-+$oidi'hi1iiBligtibiiciifikiinipiiiyizigi%i4i5i6i7ji<i?si@iGeiIiKqiMriOszaeoedbqp)iSi8i9cd}|r|dz}n|jjxsddz}|r|rt||z}||k(rd}n|rt|}|dk(rd}|||jvr&||j |z}|||jvr&|S)z>Generate an appropriate node_id for given *prefix* and *term*.Nz-%srz%srB)settings id_prefixrids new_serialno)rdocumentprefixrMnode_ididformats rmake_idr sG E>%%//744?$8d?+ f G 4. b=G /W 4S--f55 /W 4 Nrcx|D]5}t|tjs|jd|k(s3|cSy)zBPick matched pending_xref_condition node up from the pending_xref. conditionN)r rpending_xref_conditionr")r$r subnodes rfind_pending_xref_conditionrs> w ? ? @ K(I5N rctjddd}||k(r|r||d<n3|r|j||dz|z|d<n|j|||d<|r||d<||z }|S)z$Shortcut to create a reference node.rBT)internalrefid#refurireftitle)r referenceget_relative_uri)r fromdocname todocnamerchildrLr$s r make_refnoder$s ??2rD 1DiH W %66{IN!"$,-DN%55k9MDN  ZEMD Krch|jj|j\|_|_yr) state_machineget_source_and_linelinenorHrI) directiver$s rset_source_infor 7s)33I4D4DEDKrcZ|jj}||\|_|_yr)reporterrrHrI)inlinerrr$gsals rset_role_source_infor%<s%    / /D!&\DKrctjt5t||_t ||_dddy#1swYyxYwr)rVrWrXrYrHr{rI)srcdsts rcopy_source_infor)As=   Z (&$S)  %&&&s !AA ct|jD]*}t|try|j dddus*yt |ddduryy)z0Check whether the node is smart-quotable or not.Fsupport_smartquotesNT)rwrGr NON_SMARTQUOTABLE_PARENT_NODESr"getattr)r$rys ris_smartquotabler.RsY - e; < 99*D 1U :  t*D1U: rc|jtjD]c}t||r2|j |j xst jA|j t jey)z0Filter ``only`` nodes which do not match *tags*.N)rPronly_only_node_keep_children replace_selfrercomment)rtagsr$s rprocess_only_nodesr5`s]  // #D$ /   dmm>u}} ?   emmo ./rc |j|dS#t$r+}tjt d||Yd}~yd}~wwxYw)z%Keep children if tags match or error.exprz8exception while evaluating only directive expression: %srNT)eval_conditionr#rErr )r$r4errs rr1r1msQ""4<00  I J    s A !AA c^tj|j}g|_|j|_|j |_|j jDcic]\}}||dvr|n|ddc}}|_|j|_|j|_ |Scc}}w)zMonkey-patch ```nodes.Element.copy``` to not copy the ``_document`` attribute. xref: https://github.com/sphinx-doc/sphinx/issues/11116#issuecomment-1376767086 >rnamesrbackrefsdupnamesN) object__new__r5rerDtagname attributesr!rIrH)elnewnodervs r_copy_except__documentrEys nnR\\*GG GjjGO ')mm&9&9&;=#a!"*]!] #$Q4(=G77GLYYGN N =s&B)c|j}|jDcgc]}|jc}|_|jD]v}||_|js|j|_|j |jj |_|j\|jj|_x|Scc}w)z4Monkey-patch ```nodes.Element.deepcopy``` for speed.) copyrerrGrrHcurrent_sourcerI current_line)rBrCrs r _deepcopyrJsggiG68kkBU(BG!!6 ;;[[EN||#!{{99 zz![[55 6 NCsC)r$r r*r;)P)r$r r=intr*r;)r$r r*r+r,)rrr r*zIterable[tuple[Element, str]])r$r r*r;)r$r r*rLr)r$r r}rr*zIterable[Element])r$r r*z Node | None)rrr r*zEIterable[tuple[Element, list[tuple[str, str, str, str, str | None]]]])r) rrrkrr$r rrLr*r;)r>r;r*ztuple[bool, str, str])rr;rr;r*z+list[tuple[str, str, str, str, str | None]])rrrzset[str]rr;rnodes.documentrrrz list[str]r*rM)rr;r*r;)rBN) rrrrMrr;rM str | Noner*r;)r$zaddnodes.pending_xrefr r;r*zElement | None)rrrr;rr;rrNrzNode | list[Node]rLrNr*znodes.reference)rrr$r r*r+)r#rrrLr$r r*r+)r'r r(r r*r+)rr r4rr*r+)r$z addnodes.onlyr4rr*r-)rBr r*r )]r1 __future__rrVrQrtypingrrrdocutilsrsphinxr sphinx.localer sphinx.utilr collections.abcr docutils.nodesr r docutils.parsers.rstrdocutils.parsers.rst.statesrdocutils.statemachinersphinx.buildersrsphinx.environmentrsphinx.util.tagsr getLoggerr.rEcompileDOTALLrcaption_ref_rerr7r?r] InvisiblerU doctest_blockversionmodifiedrdrg math_blockrrorKIMAGE_TYPE_NODESrurYr{rwrrrrrrrrrrrrrr rrr r%r)FixedTextElementliteralmath problematicnot_smartquotabler,r.r5r1rErGrJrr2rrrks89" //(,.30'3%   8 $BJJ?K"2 2 j:(?F OO     &T    II  KK :   J 45=-0=9<=( (H(V,9ANW+D6 ,- "**-." C" C" C" C "  C "  C " C" C" C" C" C" C" C" C" C"  C!"" C#"$ C%"& C'"( C)"* C+", C-". C/"0 C1"2 C3"4 C5"6 C7"8 C9": C;"< C="> C?"@ CA"B CC"H      26$.:=4%3@D)2<%&F * &  MM JJ KK II  "  / *,  # r