B ç<[àŽã@sîdZdZddlZddlZddlmZmZddlmZm Z Gdd„de ƒZ Gdd „d e ƒZGd d„de ƒZGdd „d e ƒZ Gdd„de ƒZGdd„de ƒZGdd„deƒZGdd„de ƒZGdd„de ƒZGdd„de ƒZGdd„dejƒZdS)z& Transforms for resolving references. ZreStructuredTextéN)ÚnodesÚutils)ÚTransformErrorÚ Transformc@seZdZdZdZdd„ZdS)ÚPropagateTargetsa} Propagate empty internal targets to the next element. Given the following nodes:: This is a test. PropagateTargets propagates the ids and names of the internal targets preceding the paragraph to the paragraph itself:: This is a test. icCsxxp|j tj¡D]\}t|jtjƒs| d¡s| d¡s| d¡rFqt|ƒdksZt dƒ‚|j dd}|dk rt|tjƒs†t|tjƒr’t|tjƒr|d |d¡|d |d ¡t|d ƒsÆi|_t|dƒsÖi|_x&|dD]}||jj|<||j|<qàWx|d D]}||j|<qW|j t|d iƒ¡|j t|diƒ¡|dd|d<g|d<g|d <|j |¡qWdS)NÚrefidÚrefuriÚrefnamerz&error: block-level target has childrenT)ZascendÚidsÚnamesÚexpect_referenced_by_nameÚexpect_referenced_by_id)ÚdocumentÚtraverserÚtargetÚ isinstanceÚparentZTextElementÚhasattrÚlenÚAssertionErrorÚ next_nodeZ InvisibleZ TargetableÚextendrr r ÚupdateÚgetattrÚ note_refid)ÚselfrrÚidÚname©rú=lib/python3.7/site-packages/docutils/transforms/references.pyÚapply*s< zPropagateTargets.applyN)Ú__name__Ú __module__Ú__qualname__Ú__doc__Údefault_priorityr rrrrrsrc@seZdZdZdZdd„ZdS)ÚAnonymousHyperlinksa¥ Link anonymous references to targets. Given:: internal external Corresponding references are linked via "refid" or resolved via "refuri":: text external i¸c Csdg}g}x*|j tj¡D]}| d¡r| |¡qWx*|j tj¡D]}| d¡rD| |¡qDWt|ƒt|ƒkrà|jj dt|ƒt|ƒf¡}|j |¡}x@|D]8}tj|j|j|d}|j |¡}| |¡| |¡q WdSx~t||ƒD]p\}} d| _x`| d¡r| d|d<d|_Pqü| ds:|jj| d} qü| dd|d<|j |¡PqüWqìWdS) NÚ anonymousz]Anonymous hyperlink mismatch: %s references but %s targets. See "backrefs" attribute for IDs.)rérr rr)rrrÚ referenceÚgetÚappendrrÚreporterÚerrorÚset_idÚproblematicÚ rawsourceÚadd_backrefÚreplace_selfÚzipÚ referencedrÚresolvedr r) rZanonymous_refsZanonymous_targetsÚnodeÚmsgÚmsgidÚrefÚprbÚprbidrrrrr rsD zAnonymousHyperlinks.applyN)r!r"r#r$r%r rrrrr&Xsr&c@sDeZdZdZdZdd„Zdd„Zdd„Zd d „Zdd„Z d d„Z dS)ÚIndirectHyperlinksaN a) Indirect external references:: indirect external The "refuri" attribute is migrated back to all indirect targets from the final direct target (i.e. a target not referring to another indirect target):: indirect external Once the attribute is migrated, the preexisting "refname" attribute is dropped. b) Indirect internal references:: indirect internal Targets which indirectly refer to an internal target become one-hop indirect (their "refid" attributes are directly set to the internal target's "id"). References which indirectly refer to an internal target become direct internal references:: indirect internal iÌcCs0x*|jjD]}|js| |¡| |¡q WdS)N)rZindirect_targetsr5Úresolve_indirect_targetÚresolve_indirect_references)rrrrrr Ðs zIndirectHyperlinks.applycCsN| d¡}|dkr|d}n>|jj |¡}|sZx&|jjjD]}||ƒr:Pq:W| |¡dS|jj|}|j|dt|t j ƒrº|jsº| d¡rºt|dƒr¦| |¡dSd|_| |¡|`| d¡rà|d|d<d|krÞ|d=nT| d¡r|d|d<|j |¡n.|dr&||d<|j |¡n| |¡dS|dk rD|d=d|_dS)Nr r)rÚmultiply_indirectr(rr )r*rÚnameidsÚtransformerÚunknown_reference_resolversÚnonexistent_indirect_targetr Únote_referenced_byrrrr5rÚcircular_indirect_referencer?r=r)rrr Zreftarget_idÚresolver_functionZ reftargetrrrr=ÖsH z*IndirectHyperlinks.resolve_indirect_targetcCs.|d|jjkr| |d¡n| |d¡dS)Nr z>which is a duplicate, and cannot be used as a unique referencezwhich does not exist)rr@Úindirect_target_error)rrrrrrCsz.IndirectHyperlinks.nonexistent_indirect_targetcCs| |d¡dS)Nzforming a circular reference)rG)rrrrrrE sz.IndirectHyperlinks.circular_indirect_referencecCs d}g}|dr d|dd}x&|dD]}| |jj |g¡¡q*Wx&|dD]}| |jj |g¡¡qRW|drŒ|d|dd7}|jjjd||d|f|d }|j |¡}xFt |¡D]8} t j| j| j|d } |j | ¡}| |¡| | ¡qÄWd|_dS)NÚrz"%s" rr z (id="%s")z7Indirect hyperlink target %s refers to target "%s", %s.r )Ú base_node)rr()rrÚrefnamesr*Úrefidsr,r-r.rZuniqrr/r0r1r2r5)rrZexplanationÚnamingÚreflistrrr7r8r9r:r;rrrrG s* z(IndirectHyperlinks.indirect_target_errorc Cs:| d¡rd}|jj}n| d¡r,d}d}ndS||}x||dD]p}|jj |g¡}|rf|j|dxJ|D]B}|jrxql|d=|||<|r’||ƒd|_t|tj ƒrl| |¡qlWqBWx~|dD]r}|jj |g¡}|rä|j|dxL|D]D}|jröqê|d=|||<|r||ƒd|_t|tj ƒrê| |¡qêWqÀWdS) Nrrr)rr r(r )r)rrrrJr*rDr5rrrr>rK) rrZattnameZcall_methodZattvalrrMr9rrrrr>$sH z.IndirectHyperlinks.resolve_indirect_referencesN)r!r"r#r$r%r r=rCrErGr>rrrrr<šs2-r<c@seZdZdZdZdd„ZdS)ÚExternalTargetsa¸ Given:: direct external The "refname" attribute is replaced by the direct "refuri" attribute:: direct external i€cCsŠx„|j tj¡D]r}| d¡r|d}xZ|dD]N}|jj |g¡}|rT|j|dx(|D] }|jrfqZ|d=||d<d|_qZWq0WqWdS)Nrr)rr r() rrrrrrJr*rDr5)rrrrrMr9rrrr `s zExternalTargets.applyN)r!r"r#r$r%r rrrrrNLsrNc@s eZdZdZdd„Zdd„ZdS)ÚInternalTargetsi”cCs:x4|j tj¡D]"}| d¡s| d¡s| |¡qWdS)Nrr)rrrrrÚresolve_reference_ids)rrrrrr tszInternalTargets.applycCsrxl|dD]`}|jj |¡}|jj |g¡}|r<|j|dx,|D]$}|jrNqB|r`|d=||d<d|_qBWq WdS)aº Given:: direct internal The "refname" attribute is replaced by "refid" linking to the target's "id":: direct internal r)rr rr(N)rr@r*rJrDr5)rrrrrMr9rrrrPys z%InternalTargets.resolve_reference_idsN)r!r"r#r%r rPrrrrrOpsrOc @s`eZdZdZdZdZdddddd d ddd g Zdd„Zdd„Zdd„Z dd„Z dd„Zdd„ZdS)Ú Footnotesaè Assign numbers to autonumbered footnotes, and resolve links to footnotes, citations, and their references. Given the following ``document`` as input:: A labeled autonumbered footnote referece: An unlabeled autonumbered footnote referece: Unlabeled autonumbered footnote. Labeled autonumbered footnote. Auto-numbered footnotes have attribute ``auto="1"`` and no label. Auto-numbered footnote_references have no reference text (they're empty elements). When resolving the numbering, a ``label`` element is added to the beginning of the ``footnote``, and reference text to the ``footnote_reference``. The transformed result will be:: A labeled autonumbered footnote referece: 2 An unlabeled autonumbered footnote referece: 1 1 Unlabeled autonumbered footnote. 2 Labeled autonumbered footnote. Note that the footnotes are not in the same order as the references. The labels and reference text are added to the auto-numbered ``footnote`` and ``footnote_reference`` elements. Footnote elements are backlinked to their references via "refids" attributes. References are assigned "id" and "refid" attributes. After adding labels and reference text, the "auto" attributes can be ignored. ilNÚ*uâ€ uâ€¡õÂ§õÂ¶ú#uâ™ uâ™¥uâ™¦uâ™£cCs:g|_|jj}| |¡|j_| |¡| ¡| ¡dS)N)Úautofootnote_labelsrZautofootnote_startÚnumber_footnotesÚnumber_footnote_referencesÚsymbolize_footnotesÚresolve_footnotes_and_citations)rÚstartnumrrrr ës zFootnotes.applycCs,x$|jjD]}x"t|ƒ}|d7}||jjkrPqW| dt d|¡¡x |dD]”}xŽ|jj |g¡D]z}|t |¡7}| d¡t|dƒt|dƒkrªdks°nt‚|dd|d<| |dd¡|j |¡d|_qjWqTW|ds|ds|d |¡|j ||¡|j |¡qW|S) z« Assign numbers to autonumbered footnotes. For labeled autonumbered footnotes, copy the number over to corresponding footnote references. r(rrHrr r rZdupnames)rZ autofootnotesÚstrr@ÚinsertrÚlabelÚ footnote_refsr*ÚTextÚdelattrrrr1rr5r+Únote_explicit_targetrV)rr[Úfootnoter^rr9rrrrWós* *zFootnotes.number_footnotesc CsNd}xB|jjD]4}|js| d¡r(qy|j|}Wnžtk rÔ|jjjdt|jƒ|d}|j |¡}x^|jj|d…D]J}|js€| d¡r–q€t j|j|j|d}|j |¡}| |¡| |¡q€WPYnX|t |¡7}|jj|} |jj| } | |d<|j |¡t|dƒd ks&t‚| |dd¡d |_|d 7}qWdS) z3Assign numbers to autonumbered footnote references.rrzUToo many autonumbered footnote references: only %s corresponding footnotes available.)rINr )rr r()rZautofootnote_refsr5rrVÚ IndexErrorr,r-rr.rr/r0r1r2r`r@r rr)rr[Úir9r^r7r8r:r;rrcrrrrXs: z$Footnotes.number_footnote_referencesc Cs¨g}xt|jjD]h}t|jjt|jƒƒ\}}|j||d}| |¡| dt d|¡¡|jjd7_|j |¡qWd}x"|jjD]}y|t ||¡7}Wn t k rF|jjjdt|ƒ|d}|j |¡} x`|jj|d…D]L}|jsð| d¡rqðtj|j|j| d} |j | ¡}| |¡| | ¡qðWPYnX|jj|}t|d ƒdksjt‚|d d|d<|j |¡| |d d¡|d7}qŠWdS) z The biohazard symbol is deservedly scary-looking.

The ``substitution_reference`` will simply be replaced by the contents of the corresponding ``substitution_definition``. The transformed result will be:: The biohazard

symbol is deservedly scary-looking. biohazard

éÜc Cs|jj}|jj}|j tj¡}i}xî|D]ä}|d}d}||krJ|}n| ¡}||krb||}|dkrÂ|jjjd||d} |j | ¡} tj |j|j| d}|j |¡}| |¡| |¡q*||} |j}| |¡}d| jksðd| jkr0|dkr0t||dtjƒr0| ||d||d ¡¡d | jksHd| jkrt|ƒ|dkrt||dtjƒr| ||d||d ¡¡| ¡}ydx^| tj¡D]N}||d ¡}|| |g¡krÔt‚n || |¡||d <| |¡q¨WWnÐtk rÌ|j}t|tjƒrR|jjjdt |j|j¡|j|d} | | ¡nv|}x| d ¡rp|d }qXW|jjjd ||d} |j | ¡} tj |j|j| d}|j |¡}| |¡| |¡Yq*X| |j¡x4|jD]*}t|tj ƒrâd|krâ|j !|¡qâWq*WdS)Nr z(Undefined substitution referenced: "%s".)rI)rZltrimZtrimrr(Zrtrimz ref-originz*Circular substitution definition detected:)ÚlinerIz2Circular substitution definition referenced: "%s".)"rZsubstitution_defsZsubstitution_namesrrZsubstitution_referenceÚlowerr,r-r.r/r0r1r2rriZ attributesrr`ÚreplaceÚrstriprÚlstripÚdeepcopyÚ setdefaultrkr+Zsubstitution_definitionZ literal_blockrnrZchildrenZReferentialZnote_refname)rZdefsZnormedZ subreflistÚnestedr9r ÚkeyZnormed_namer7r8r:r;ZsubdefrriZsubdef_copyZ nested_refZnested_nameZ ref_originr6rrrr —s’ zSubstitutions.applyN)r!r"r#r$r%r rrrrrlwsrlc@s,eZdZdZdZdd„Zdd„Zdd„Zd S) ÚTargetNotesz‚ Creates a footnote for each external target in the text, and corresponding footnote references after each reference. icCs$tj|||d|j dg¡|_dS)N)Ú startnodeÚclass)rÚ__init__Zdetailsr*Úclasses)rrrxrrrrzúszTargetNotes.__init__c Cs i}g}xŒ|j tj¡D]z}| d¡s(q|d}g}x"|D]}| |jj |g¡¡q:W|s^q| |d||¡}|d|kr|||d<| |¡qWxb|j tj ¡D]P}| d¡s¶q¦| d¡r¦| |d|g|¡}|d|kr¦|||d<| |¡q¦W|j |¡dS)Nrrr') rrrrrrrJr*Úmake_target_footnoter+r)rxr2) rÚnotesZnodelistrrÚrefsrrcr9rrrr ÿs4 zTargetNotes.applycCs^||kr2||}t|dƒdks$t‚|dd}nlt ¡}|j |¡}d|}d|d<|g|d<t ¡}|tjd||d7}||7}|j |¡|j ||¡xº|D]²}t |tjƒr¶q¤tj|dd} | d |j 7<|j | ¡|j | ¡|j |¡d} | g}t |jj¡sH|j r6| dtjd |j d¡n| dt d ¡¡|j | |¡q¤W|S)Nrr(rz TARGET_NOTE: ÚautorH)r)r rr{ú )ÚtextZClasses)rrrrcrr.Z paragraphr)Znote_autofootnoterbrrZfootnote_referencer{Znote_autofootnote_refZnote_footnote_refrrirZget_trim_footnote_ref_spaceZsettingsr]Zinliner`)rrr~r}rcZ footnote_nameZfootnote_idZfootnote_paragraphr9ZrefnoderirMrrrr|s: z TargetNotes.make_target_footnoteN)r!r"r#r$r%rzr r|rrrrrwîs rwc@seZdZdZdZdd„ZdS)ÚDanglingReferencesze Check for dangling references (incl. footnote & citation) and for unreferenced targets. iRcCs–t|j|jjjƒ}|j |¡xr|j tj¡D]`}|js.| d¡rDq.|drZ|dd}n|drp|dd}n|d}|jj jd||dq.WdS)Nr'rrr rz(Hyperlink target "%s" is not referenced.)rI)ÚDanglingReferencesVisitorrrArBÚwalkrrrr4r*r,Úinfo)rZvisitorrrLrrrr Js zDanglingReferences.applyN)r!r"r#r$r%r rrrrr‚Asr‚c@s,eZdZdd„Zdd„Zdd„ZeZZdS)rƒcCstj ||¡||_||_dS)N)rÚSparseNodeVisitorrzrrB)rrrBrrrrzhsz"DanglingReferencesVisitor.__init__cCsdS)Nr)rr6rrrÚ unknown_visitmsz'DanglingReferencesVisitor.unknown_visitc Cs"|js| d¡sdS|d}|jj |¡}|dkröxê|jD]}||ƒr:Pq:W||jjkrt|jjjd|d|d}n|jjjd|d|d}|j |¡}t j |j|j|d}y|dd}Wn tk rÞ|j |¡}YnX| |¡| |¡n(|d=||d<|jj|j|d d |_dS)Nr zBDuplicate target name, cannot be used as a unique reference: "%s".)rIzUnknown target name: "%s".)rr rr)rr()r5rrr@r*rBr,r-r.rr/r0rdr1r2r rD) rr6r rrFr7r8r:r;rrrÚvisit_referenceps8 z)DanglingReferencesVisitor.visit_referenceN)r!r"r#rzr‡rˆZvisit_footnote_referenceZvisit_citation_referencerrrrrƒfs!rƒ)r$Z __docformat__ÚsysÚreZdocutilsrrZdocutils.transformsrrrr&r<rNrOrQÚ Exceptionrkrlrwr‚r†rƒrrrrÚs$GB3$(]wS%