o Nia@sdZddlmZddlZddlZddlZddlmZmZm Z m Z m Z ddl m Z ddlmZddlmZddlmZdd lmZdd lmZer~dd lmZmZmZdd lmZdd lmZddlm Z m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)e*e+Z,e-dej.Z/e/Z0e dedZ1Gddde e1Z2dddZ3ddd!d"Z4dd%d&Z5e j6e j7e j8ej9fZ:dd(d)Z;e j7e j8e je j?fZ@dd,d-ZAdd.d/ZBdd0d1ZCddd5d6ZDdd8d9ZEdd;d<ZF dddBdCZGddDdEZHddHdIZIgdJZJddNdOZK Pddd]d^ZLdd`daZMe-dbZNe-dcZOidddedfdgdhdidjdkdldmdndodpdqdrdqdsdtdudgdvdwdxdydzdmd{d|d}d~ddoddoiddddddddddmdd|ddoddddtddddddddddddddZPddddddZQ P ddddZRdddZS ddddZTdddZUdddZVdddZWe jXe jYe jZe j?e j=e j[ej\fZ]ddd„Z^dddƄZ_dddɄZ`ddd̄Zaeae j_bddd΄Zcece j_ddS)z3Docutils node-related utility functions for Sphinx.) annotationsN) TYPE_CHECKINGAnyGenericTypeVarcast)nodes)Node)addnodes)__)logging)_fresh_title_style_context)CallableIterableIterator)Element) Directive)InlinerRSTState) StringList)Builder)BuildEnvironment)Tagsz^(.+?)\s*(?$N)boundc@s8eZdZdZddd Zdd dZdddZdddZdS) NodeMatcheraA 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') matcher.findall(doctree) # => [, , ...] A special value ``typing.Any`` matches any kind of node-attributes. For example, following example searches ``reference`` node having ``refdomain`` attributes:: matcher = NodeMatcher(nodes.reference, refdomain=Any) matcher.findall(doctree) # => [, , ...] node_classestype[N]attrsrreturnNonecOs||_||_dSN)classesr)selfrrr$E/home/ubuntu/.local/lib/python3.10/site-packages/sphinx/util/nodes.py__init__>s zNodeMatcher.__init__noder boolcCsz=|jr t||js WdS|jr;t|tjsWdS|jD]\}}||vr*WdS|tur/q|||kr:WdSqWdStyGYdSw)NFT) r" isinstancerrritemsrget Exception)r#r'keyvaluer$r$r%matchBs$  zNodeMatcher.matchcCs ||Sr!)r/)r#r'r$r$r%__call__Xs zNodeMatcher.__call__ Iterator[N]ccs"||D]}tt|VqdS)zAn alternative to `Node.findall` with improved type safety. While the `NodeMatcher` object can be used as an argument to `Node.findall`, doing so confounds type checkers' ability to determine the return type of the iterator. N)findallrr)r#r'foundr$r$r%r2[szNodeMatcher.findallN)rrrrrr r'r rr()r'r rr1)__name__ __module__ __qualname____doc__r&r/r0r2r$r$r$r%r)s    rr'r rstrcCs|jd|jjS)z Return full module dotted path like: 'docutils.nodes.paragraph' :param nodes.Node node: target node :return: full module dotted path .)r6 __class__r5r'r$r$r%get_full_module_nameesr=PlengthintcCsPz|}Wn tyt|}Ynw|r&t||kr&|d|d}|S)a return DOM XML representation of the specified node like: 'Added 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,r9len)r'r?textr$r$r% repr_domxmlos   rErr cCsft|tjr'|js'tdt|t||j}|j |_ |j d|_ | |_nt|tjr5|j s5|jj |_ t|tj rV|j durVtdt|t||jj |jj |_ |_ t|tj rw|j durwtdt|t||jj |jj |_ |_ t|tjrtdt|t|tt|jtjD]}tdt| d|j|_qt|tjr|j durtdt|t||jj |jj |_ |_ t|tjr|j durtt t||_ Wdn1swY|js| |_|j r|jrdSt|tjtj Btj BtjBr1tdt|t|zt||_ Wn ty+d|_ Ynwd |_ dSdS) 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 rawsourceloggerdebugr=rEparentsourcelineastextimagetitletermreversedlistr2resubescapetopic literal_block contextlibsuppress ValueErrorget_node_sourcerubric field_name)r'definition_list_itemrHr$r$r%apply_source_workarounds          rar(cCst|tjrdSt|tjr|ds|drdSt|tjr&d|vr&dSt|tjr|js  r]cCry)Nznode line not found)rzrNr\r{r$r$r% get_node_lineFr}r~clsrIterable[Element]ccs0|r|dus t||r|V|j}|sdSdSr!)r)rL)r'rr$r$r%rzNs  rz Node | NonecCs&|j|}|dkr|j|dSdS)NrrF)rLindex)r'posr$r$r% get_prev_nodeUs rEIterable[tuple[Element, list[tuple[str, str, str, str, str | None]]]]ccsHttjdd}||D]}d|vr|d}n|d}||fVq dS)z6Traverse translatable index node from a document tree.F)inline raw_entriesentriesN)rr rr2)rkmatcherr'rr$r$r%traverse_translatable_index]s  rstaterrorcontent_offsetcCs@t||j|||dd}Wd|S1swY|S)axVersion 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. This function is retained for compatibility and will be deprecated in Sphinx 8. Prefer ``nested_parse_to_nodes()``. T) match_titlesN)r nested_parse)rror'rretr$r$r%nested_parse_with_titlesjs  rcCsL|}|tjD]}d|d<q t|tjD]}|j|q|S)z&Like node.astext(), but ignore images.rGrc) deepcopyr2rrPrTrawrLremoverO)r'imgrr$r$r% clean_astext{s  rrDtuple[bool, str, str]cCs.t|}|rd|d|dfSd||fS)z3Split role content into title and target, if given.TrFF)explicit_title_rer/group)rDr/r$r$r%split_explicit_titles  r)singlepairdoubletripleseeseealsoentrytargetid+list[tuple[str, str, str, str, str | None]]cCsdddlm}g}|}|}d}|drd}|dd}|D]8}||drY|t|dd}||d|}tjtd |||d d | d |||df|Sq!t D])}||dr|t|dd}|d krxd }| ||||df|Sq\| dD]$}|}d}|drd}|dd}|sq| d|||dfq|S)Nr)pairindextypesrG!mainrF:z; zK%r is deprecated for index entries (from entry %r). Use 'pair: %s' instead.r)typerr,r) sphinx.domains.pythonrru startswithlstriprCrJwarningr append indextypessplit)rrr indexentriesoentryr index_typer.r$r$r%process_index_entrysX     rrGbuilderr docnamesetset[str]docnametreenodes.document colorfuncCallable[[str], str] traversed list[str]indentc Cs |}t|tjD]v}g}tt|d} |d7}| D]]} | |vrzz#|| t ||| t ||| |j | |||} | | WntyYtjtd| |dYqwtj| d} | j| _| tjD] } d| vrt| | d<qj|| q|j||q |S)zwInline all toctrees in the *tree*. Record all docnames in *docnameset*, and output docnames with *colorfunc*. includefilesrqz+toctree contains ref to nonexisting file %rlocation)rr)rrTr2r toctreemapr9rrJinfoinline_all_toctreesenv get_doctreeaddr,rr start_of_filerhrsectionrLrt)rrrrrrr toctreenodenewnodesr includefilesubtreesof sectionnoder$r$r%rsJ       rstringcCsX|t}|t}td|ddd}tdd | }t d|}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-rqrG) translate_non_id_translate_digraphs_non_id_translate unicodedata normalizeencodedecode _non_id_charsrVjoinr_non_id_at_endsr9)ridr$r$r%_make_ids   rz[^a-zA-Z0-9._]+z^[-0-9._]+|-+$oidi'hi1iiBligtibiiciifikiinipiiiyizigi%i4i5i6i7ji<i?si@iGeiIiKqiMriOszaeoedbqp)iSi8i9rrdocumentprefixrR str | NonecCsd}|r |d}n|jjpdd}|r"|r"t||}||kr!d}n |r.t|}|dkr.d}|dus7||jvrG|||}|dus7||jvs7|S)z>Generate an appropriate node_id for given *prefix* and *term*.Nz-%srz%srG)settings id_prefixrids new_serialno)rrrrRnode_ididformatr$r$r%make_id?s"  raddnodes.pending_xref conditionElement | NonecCs0|D]}t|tjr|d|kr|SqdS)zBPick matched pending_xref_condition node up from the pending_xref.r N)r)r pending_xref_conditionr+)r'r subnoder$r$r%find_pending_xref_condition]s r fromdocname todocnamechildNode | list[Node]rQnodes.referencecCsltjdddd}||kr|r||d<n|r"|||d||d<n||||d<|r0||d<||7}|S)z$Shortcut to create a reference node.rGT)internalrefid#refurireftitle)r referenceget_relative_uri)rrrrrrQr'r$r$r% make_refnodejs  r directivercCs|j|j\|_|_dSr!) state_machineget_source_and_linelinenorMrN)rr'r$r$r%set_source_infosr inlinerrrcCs|jj}||\|_|_dSr!)reporterrrMrN)r!rr'gsalr$r$r%set_role_source_infosr$srcdstcCsDttt||_t||_WddS1swYdSr!)rZr[r\r]rMr~rN)r%r&r$r$r%copy_source_infos   "r'cCsFt|jD]}t|trdS|dddurdSqt|ddduS)z0Check whether the node is smart-quotable or not.Fsupport_smartquotesN)rzrLr)NON_SMARTQUOTABLE_PARENT_NODESr+getattr)r'r|r$r$r%is_smartquotables r+tagsrcCsD|tjD]}t||r||jptq|tqdS)z0Filter ``only`` nodes which do not match *tags*.N)r2r only_only_node_keep_children replace_selfrhrcomment)rr,r'r$r$r%process_only_nodess  r1 addnodes.onlyc CsLz||dWSty%}ztjtd||dWYd}~dSd}~ww)z%Keep children if tags match or error.exprz8exception while evaluating only directive expression: %srNT)eval_conditionr,rJrr )r'r,errr$r$r%r.sr.elcCsLt|j}g|_|j|_|j|_dd|jD|_|j|_|j |_ |S)zMonkey-patch ```nodes.Element.copy``` to not copy the ``_document`` attribute. xref: https://github.com/sphinx-doc/sphinx/issues/11116#issuecomment-1376767086 cSs*i|]\}}||dvr |n|ddqS)>rnamesr"backrefsdupnamesNr$).0rvr$r$r% sz*_copy_except__document..) object__new__r;rhrItagname attributesr*rNrM)r6newnoder$r$r%_copy_except__documents rBcCsf|}dd|jD|_|jD] }||_|jr0|j|_|jdur&|jj|_|jdur0|jj|_q|S)z4Monkey-patch ```nodes.Element.deepcopy``` for speed.cSsg|]}|qSr$)r)r:rr$r$r% sz_deepcopy..N)copyrhrLrrMcurrent_sourcerN current_line)r6rArr$r$r% _deepcopys     rG)r'r rr9)r>)r'r r?r@rr9)r'rrr r4)rkrrrl)r'rrr9)r'rrr@r!)r'rrrrr)r'r rr)rkrrr)r) rrrorr'r rr@rr9)rDr9rr)rr9rr9rr)rG)rrrrrr9rrrrrrrr9rr)rr9rr9)rGN) rrrrrr9rRrrr9)r'r r r9rr )rrrr9rr9rrrrrQrrr)rrr'r rr )r!rrr@r'r rr )r%rr&rrr )rr r,rrr )r'r2r,rrr()r6rrr)er8 __future__rrZrUrtypingrrrrrdocutilsrdocutils.nodesr sphinxr sphinx.localer sphinx.utilr sphinx.util.parsingr collections.abcrrrrdocutils.parsers.rstrdocutils.parsers.rst.statesrrdocutils.statemachinersphinx.buildersrsphinx.environmentrsphinx.util.tagsr getLoggerr5rJcompileDOTALLrcaption_ref_rerrr=rEra InvisiblerY doctest_blockversionmodifiedrgrj math_blockrrsrPIMAGE_TYPE_NODESrxr]r~rzrrrrrrrrrrrrrrrrr r$r'FixedTextElementliteralmath problematicnot_smartquotabler)r+r1r.rBrDrGrr$r$r$r%s8                < Y 3         ; 2        !$