U \ShZ"@sdZddlmZddlZddlZddlZddlmZmZm Z m Z ddl m Z ddl mZmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZerdd lmZddlmZddl m!Z!e"e#Z$e%dej&Z'e'Z(GdddZ)dddddZ*dddddddZ+ddddd Z,e j-e j.e j/ej0fZ1dd!dd"d#Z2e j.e j/e j3e j4fZ5e j6fZ7dd$d%d&d'Z8dddd(d)Z9dddd*d+Z:ddd,d-d.d/d0Z;dd1dd2d3Zdddd;d<Z?dd=d>d?d@Z@dAdBdCdDdEdFgZAdddGdHdIdJZBdKdLddMdNdOdMdPdQdRZCdddSdTdUZDe%dVZEe%dWZFdXdYdZd[d\d]d^d^d_dYd`dad\dbdcd]d]dddedfded\dbd]dgd_dhdedidgdjdkdddl!ZGdmdndodpdqdrZHddtdMdduddvdwdxZIdyddzd{d|d}ZJddKdddud~duddddZKddddddZLdddddddZMddddddZNe jOe jPe jQe j6e j4e jRejSfZTdd!dddZUddddddZVdddddZWeWe j_XdS)z3Docutils node-related utility functions for Sphinx.) annotationsN) TYPE_CHECKINGAnyCallableIterable)nodes)ElementNode) Directive)Inliner) StringList)addnodes)__)logging)Builder)BuildEnvironment)Tagsz^(.+?)\s*(?$c@sBeZdZdZddddddZdd d d d Zdd d d dZdS) NodeMatcheraEA 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 Any matcher = NodeMatcher(nodes.reference, refdomain=Any) doctree.findall(matcher) # => [, , ...] z type[Node]rNone) node_classesattrsreturncOs||_||_dSN)classesr)selfrrrD/root/rtd-docs/venv/lib/python3.8/site-packages/sphinx/util/nodes.py__init__8szNodeMatcher.__init__r boolnodercCsz||jrt||jsWdS|jrxt|tjs2WdS|jD]:\}}||krTWdS|tkr`qNew 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...)ZasdomZtoxmlr$r-len)r r4textrrr repr_domxml`s r7rrc Csbt|tjrN|jsNtdt|t||j}|j |_ |j d|_ | |_nt|tjrj|j sj|jj |_ t|tj r|j dkrtdt|t||jj |jj |_ |_ t|tj r|j dkrtdt|t||jj |jj |_ |_ t|tjrPtdt|t|tt|jtjD]&}tdt| d|j|_q(t|tjr|j dkrtdt|t||jj |jj |_ |_ t|tjr|j dkrttt||_ W5QRX|js| |_|j r|jrdSt|tjtj tj tjfr^tdt|t|zt||_ Wntk rRd|_ YnXd |_ 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 rawsourceloggerdebugr1r7parentsourcelineastextimagetitletermreversedlistfindallresubescapeZtopic literal_block contextlibsuppress ValueErrorget_node_sourceZrubric field_name)r Zdefinition_list_itemr:rrrapply_source_workaroundts|       rQrcCst|tjrdSt|tjr4|ds0|dr4dSt|tjrLd|krLdSt|tjr|jszt dt |t |dSt|t rd|krt dt |t |dS|ddst dt |t |dSt|tjr|jdd krt d t |t |dSdSt|tjrdSdS) 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']: %srZorphanz&[i18n] SKIP %r because orphan node: %s)r!r rRrrBr#ZInlineZ TextElementr?r<r=r1r7 IGNORED_NODESrPchildrenmetar0rrris_translatablesF   rWzIterable[tuple[Element, str]])doctreerccs|tD]}t|tjr4|D]}||fVq"q t|trR|j}|s|}njt|t j r| drv||dfV| drd|d}qd}n(t|t j r|d}n|j dd}|r ||fVq d S) z3Extract translatable messages from a document tree.rSrRz .. image:: %surir9content  N)rGrWr!r rRZextract_original_messagesLITERAL_TYPE_NODESr;rArrBr#rVreplacestrip)rXr msgrrrextract_messagess(          racCs*t|D]}|jr|jSqtddS)Nznode source not found)traverse_parentr?rNr ZpnoderrrrOs  rOcCs*t|D]}|jr|jSqtddS)Nznode line not found)rbr@rNrcrrr get_node_lines  rdrzIterable[Element])r clsrccs(|r$|dkst||r|V|j}qdSr)r!r>)r rerrrrbsrbz Node | NonecCs*|j|}|dkr"|j|dSdSdS)Nrr8)r>index)r posrrr get_prev_node$s rhzEIterable[tuple[Element, list[tuple[str, str, str, str, str | None]]]]ccsFttjdd}||D](}d|kr.|d}n|d}||fVqdS)z6Traverse translatable index node from a document tree.F)inlineZ raw_entriesentriesN)rr rfrG)rXZmatcherr rjrrrtraverse_translatable_index,s  rkr )staterZr content_offsetrcCsN|jj}|jj}g|j_d|j_z|j|||ddWS||j_||j_XdS)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. rr8)Z match_titlesN)memoZ title_stylesZ section_levelZ nested_parse)rlrZr rmZsurrounding_title_stylesZsurrounding_section_levelrrrnested_parse_with_titles9s rocCsL|}|tjD] }d|d<qt|tjD]}|j|q2|S)z&Like node.astext(), but ignore images.r9rS) deepcopyrGrrBrFrawr>removerA)r Zimgrqrrr clean_astextMs  rsztuple[bool, str, str])r6rcCs.t|}|r$d|d|dfSd||fS)z3Split role content into title and target, if given.Tr8F)explicit_title_rer'group)r6r'rrrsplit_explicit_titleWs rwsinglepairdoubleZtripleZseeZseealsoz+list[tuple[str, str, str, str, str | None]])entrytargetidrcCslddlm}g}|}|}d}|dr>d}|dd}|D]p}||drB|t|dd}||d|}tjtd |||d d | d |||dfqhqBt D]R}||dr|t|dd}|d krd }| ||||dfqhq| dD]P}|}d}|drFd}|dd}|sPq| d|||dfq|S)Nr)pairindextypesr9!mainr8:z; zK%r is deprecated for index entries (from entry %r). Use 'pair: %s' instead.rf)typeryrz,rx) Zsphinx.domains.pythonr}r_ startswithlstripr5r<warningrappend indextypessplit)r{r|r}Z indexentriesZoentryrZ index_typer&rrrprocess_index_entrydsJ    rrzset[str]znodes.documentrz list[str])builder docnamesetdocnametree colorfunc traversedrc Cs|}t|tjD]}g}tt|d}|D]} | |kr2zH|| tj || dddt ||| |j | ||} | | Wn(tk rtjtd| |dYq2Xtj| d} | j| _| tjD]} d| kr| | d<q|| q2|j||q|S) zwInline all toctrees in the *tree*. Record all docnames in *docnameset*, and output docnames with *colorfunc*. includefilesr\T)Znonlz+toctree contains ref to nonexisting file %rlocation)rr)rprFrGr Ztoctreemapr-rr<infoinline_all_toctreesenvZ get_doctreeaddr$rrZ start_of_filerUrsectionr>r^) rrrrrrZ toctreenodeZnewnodesrZ includefileZsubtreeZsofZ sectionnoderrrrs8       r)stringrcCsX|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. ZNFKDasciiignore-r\r9) translate_non_id_translate_digraphs_non_id_translate unicodedata normalizeencodedecode _non_id_charsrIjoinr_non_id_at_endsr-)ridrrr_make_ids    rz[^a-zA-Z0-9._]+z^[-0-9._]+|-+$odhiltbcfknpyzgjseqr)!ii'i1iBigiiiiiiiiiiiiiii%i4i5i6i7i<i?i@iGiIiKiMiOszZaeZoedbZqp)iSi8i9r9rz str | None)rdocumentprefixrDrcCsd}|r|d}n|jjpdd}|rD|rDt||}||kr\d}n|r\t|}|dkr\d}|dksn||jkr~|||}q\|S)z>Generate an appropriate node_id for given *prefix* and *term*.Nz-%srz%sr9)settingsZ id_prefixrZidsZ new_serialno)rrrrDZnode_idZidformatrrrmake_ids  rzaddnodes.pending_xrefzElement | None)r conditionrcCs0|D]&}t|tjr|d|kr|SqdS)zBPick matched pending_xref_condition node up from the pending_xref.rN)r!r Zpending_xref_conditionr#)r rZsubnoderrrfind_pending_xref_conditions    rzNode | list[Node]znodes.reference)r fromdocname todocnamer|childrCrcCsltjdddd}||kr&|r&||d<n.|rD|||d||d<n||||d<|r`||d<||7}|S)z$Shortcut to create a reference node.r9T)ZinternalZrefid#ZrefuriZreftitle)r referenceZget_relative_uri)rrrr|rrCr rrr make_refnodes    rr ) directiver rcCs|j|j\|_|_dSr)Z state_machineget_source_and_linelinenor?r@)rr rrrset_source_info1s rr )inlinerrr rcCs|j|\|_|_dSr)reporterrr?r@)rrr rrrset_role_source_info6sr)srcdstrc Cs.ttt||_t||_W5QRXdSr)rLrMrNrOr?rdr@)rrrrrcopy_source_info:s  rcCsNt|jD]*}t|trdS|dddkr dSq t|dddkrJdSdS)z0Check whether the node is smart-quotable or not.FZsupport_smartquotesNT)rbr>r!NON_SMARTQUOTABLE_PARENT_NODESr#getattrrcrrris_smartquotableKs rr)rtagsrc Cs|tjD]}z||d}WnJtk rl}z,tjtd||d||j pXt W5d}~XYq X|r||j pt q |t q dS)z0Filter ``only`` nodes which do not match *tags*.exprz8exception while evaluating only directive expression: %srN) rGr onlyZeval_conditionr$r<rrZ replace_selfrUrcomment)rrr reterrrrrprocess_only_nodesYs &r)rrcCs,|jfd|ji|j}|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 r;)r/r; attributesr?r@)rZnewnoderrr_copy_except__documentmsr)r2)N)r)r9N)N)Yr, __future__rrLrHrtypingrrrrZdocutilsrZdocutils.nodesrr Zdocutils.parsers.rstr Zdocutils.parsers.rst.statesr Zdocutils.statemachiner Zsphinxr Z sphinx.localerZ sphinx.utilrZsphinx.buildersrZsphinx.environmentrZsphinx.util.tagsr getLoggerr)r<compileDOTALLruZcaption_ref_rerr1r7rQZ InvisiblerKZ doctest_blockZversionmodifiedrTrWZ math_blockrqr]rBZIMAGE_TYPE_NODESrarOrdrbrhrkrorsrwrrrrrrrrrrrrrrZFixedTextElementliteralmathZ problematicZnot_smartquotablerrrrcopyrrrrs            5 C *  +"  $