File: //lib/python3.6/site-packages/docutils/transforms/__pycache__/references.cpython-36.pyc
3
w2�e� � @ s� d Z dZddlZddlZddlmZmZ ddlmZm Z G dd� de �Z
G dd � d e �Z G d
d � d e �Z G d d
� d
e �Z
G dd� de �ZG dd� de �ZG dd� de�ZG dd� de �ZG dd� de �ZG dd� de �ZG dd� dej�ZdS ) z&
Transforms for resolving references.
ZreStructuredText� N)�nodes�utils)�TransformError� Transformc @ s e Zd ZdZdZdd� ZdS )�PropagateTargetsa}
Propagate empty internal targets to the next element.
Given the following nodes::
<target ids="internal1" names="internal1">
<target anonymous="1" ids="id1">
<target ids="internal2" names="internal2">
<paragraph>
This is a test.
PropagateTargets propagates the ids and names of the internal
targets preceding the paragraph to the paragraph itself::
<target refid="internal1">
<target anonymous="1" refid="id1">
<target refid="internal2">
<paragraph ids="internal2 id1 internal1" names="internal2 internal1">
This is a test.
i c C s| �xt| j jtj�D �]`}t|jtj�s|jd�s|jd�s|jd�rFqt|�dksZt d��|j
dd�}|d k o�t|tj � r�t|tj � s�t|tj�r|d j
|d � |d j
|d � t|d
�s�i |_t|d �s�i |_x&|d D ]}|| j j|< ||j|< q�W x |d D ]}||j|< �q W |jjt|d
i �� |jjt|d i �� |d d |d< g |d< g |d < | j j|� qW d S ) N�refid�refuri�refnamer z&error: block-level target has childrenT)Zascend�ids�names�expect_referenced_by_name�expect_referenced_by_id)�document�traverser �target�
isinstance�parentZ TextElement�hasattr�len�AssertionError� next_nodeZ InvisibleZ
Targetable�extendr r
r
�update�getattr�
note_refid)�selfr r �id�name� r � /usr/lib/python3.6/references.py�apply* s<
zPropagateTargets.applyN)�__name__�
__module__� __qualname__�__doc__�default_priorityr r r r r r s r c @ s e Zd ZdZdZdd� ZdS )�AnonymousHyperlinksa�
Link anonymous references to targets. Given::
<paragraph>
<reference anonymous="1">
internal
<reference anonymous="1">
external
<target anonymous="1" ids="id1">
<target anonymous="1" ids="id2" refuri="http://external">
Corresponding references are linked via "refid" or resolved via "refuri"::
<paragraph>
<reference anonymous="1" refid="id1">
text
<reference anonymous="1" refuri="http://external">
external
<target anonymous="1" ids="id1">
<target anonymous="1" ids="id2" refuri="http://external">
i� c
C sd g }g }x*| j jtj�D ]}|jd�r|j|� qW x*| j jtj�D ]}|jd�rD|j|� qDW t|�t|�kr�| j jj dt|�t|�f �}| j j
|�}x@|D ]8}tj |j |j |d�}| j j
|�}|j
|� |j|� q�W d S x~t||�D ]p\}} d| _x`| jd��r | d |d< d|_P q�| d �s:| j j| d } q�| d d |d< | j j|� P q�W q�W d S ) N� anonymousz]Anonymous hyperlink mismatch: %s references but %s targets.
See "backrefs" attribute for IDs.)r � r r
r r )r r r � reference�get�appendr r �reporter�error�set_id� problematic� rawsource� add_backref� replace_self�zip�
referencedr �resolvedr
r )
r Zanonymous_refsZanonymous_targets�node�msg�msgid�ref�prb�prbidr r r r r r sD
zAnonymousHyperlinks.applyN)r! r" r# r$ r% r r r r r r& X s r& c @ sD e Zd ZdZdZdd� Zdd� Zdd� Zd d
� Zd d � Z d
d� Z
dS )�IndirectHyperlinksaN
a) Indirect external references::
<paragraph>
<reference refname="indirect external">
indirect external
<target id="id1" name="direct external"
refuri="http://indirect">
<target id="id2" name="indirect external"
refname="direct 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)::
<paragraph>
<reference refname="indirect external">
indirect external
<target id="id1" name="direct external"
refuri="http://indirect">
<target id="id2" name="indirect external"
refuri="http://indirect">
Once the attribute is migrated, the preexisting "refname" attribute
is dropped.
b) Indirect internal references::
<target id="id1" name="final target">
<paragraph>
<reference refname="indirect internal">
indirect internal
<target id="id2" name="indirect internal 2"
refname="final target">
<target id="id3" name="indirect internal"
refname="indirect internal 2">
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::
<target id="id1" name="final target">
<paragraph>
<reference refid="id1">
indirect internal
<target id="id2" name="indirect internal 2" refid="id1">
<target id="id3" name="indirect internal" refid="id1">
i� c C s0 x*| j jD ] }|js | j|� | j|� q
W d S )N)r Zindirect_targetsr5 �resolve_indirect_target�resolve_indirect_references)r r r r r r � s
zIndirectHyperlinks.applyc C sP |j d�}|d kr |d }n>| jjj |�}|sZx&| jjjD ]}||�r:P q:W | j|� d S | jj| }|j|d� t|t j
�r�|j r�|j d�r�t |d�r�| j
|� d S d|_| j|� |`|j d�r�|d |d< d|kr�|d= nT|j d��r|d |d< | jj|� n.|d �r(||d< | jj|� n| j|� d S |d k �rF|d= d|_ d S )Nr r )r �multiply_indirectr( r r
)r* r �nameids� transformer�unknown_reference_resolvers�nonexistent_indirect_targetr
�note_referenced_byr r r r5 r �circular_indirect_referencer? r= r )r r r Z reftarget_id�resolver_functionZ reftargetr r r r= � sH
z*IndirectHyperlinks.resolve_indirect_targetc C s. |d | j jkr | j|d� n | j|d� d S )Nr z>which is a duplicate, and cannot be used as a unique referencezwhich does not exist)r r@ �indirect_target_error)r r r r r rC s z.IndirectHyperlinks.nonexistent_indirect_targetc C s | j |d� d S )Nz forming a circular reference)rG )r r r r r rE
s z.IndirectHyperlinks.circular_indirect_referencec C s
d}g }|d r d|d d }x&|d D ]}|j | jjj|g �� q*W x&|d D ]}|j | jjj|g �� qRW |d r�|d|d d 7 }| jjjd||d |f |d �}| jj|�}xFtj |�D ]8} t
j | j | j |d
�}
| jj|
�} |j
| � | j|
� q�W d |_d S ) N� r z"%s" r r
z (id="%s")z7Indirect hyperlink target %s refers to target "%s", %s.r )� base_node)r r( )r r �refnamesr* �refidsr, r- r. r Zuniqr r/ r0 r1 r2 r5 ) r r Z explanation�naming�reflistr r r7 r8 r9 r: r; r r r rG
s*
z(IndirectHyperlinks.indirect_target_errorc C s: |j d�rd}| jj}n|j d�r,d}d }nd S || }x||d D ]p}| jjj|g �}|rf|j|d� xJ|D ]B}|jrxql|d= |||< |r�||� d|_t|tj �rl| j
|� qlW qBW x~|d D ]r}| jj j|g �}|r�|j|d� xL|D ]D}|jr�q�|d= |||< |�r||� d|_t|tj �r�| j
|� q�W q�W d S ) Nr r r )r r r( r
)r ) r r r rJ r* rD r5 r r r r> rK ) r r ZattnameZ call_methodZattvalr rM r9 r r r r r> $ sH
z.IndirectHyperlinks.resolve_indirect_referencesN) r! r" r# r$ r% r r= rC rE rG r> r r r r r< � s 2-r< c @ s e Zd ZdZdZdd� ZdS )�ExternalTargetsa�
Given::
<paragraph>
<reference refname="direct external">
direct external
<target id="id1" name="direct external" refuri="http://direct">
The "refname" attribute is replaced by the direct "refuri" attribute::
<paragraph>
<reference refuri="http://direct">
direct external
<target id="id1" name="direct external" refuri="http://direct">
i� c C s� x�| j jtj�D ]r}|jd�r|d }xZ|d D ]N}| j jj|g �}|rT|j|d� x(|D ] }|jrfqZ|d= ||d< d|_qZW q0W qW d S )Nr r )r r r( ) r r r r r rJ r* rD r5 )r r r r rM r9 r r r r ` s
zExternalTargets.applyN)r! r" r# r$ r% r r r r r rN L s rN c @ s e Zd ZdZdd� Zdd� ZdS )�InternalTargetsi� c C s> x8| j jtj�D ]&}|jd� r|jd� r| j|� qW d S )Nr r )r r r r r �resolve_reference_ids)r r r r r r t s zInternalTargets.applyc C sr xl|d D ]`}| j jj|�}| j jj|g �}|r<|j|d� x,|D ]$}|jrNqB|r`|d= ||d< d|_qBW q
W dS )a�
Given::
<paragraph>
<reference refname="direct internal">
direct internal
<target id="id1" name="direct internal">
The "refname" attribute is replaced by "refid" linking to the target's
"id"::
<paragraph>
<reference refid="id1">
direct internal
<target id="id1" name="direct internal">
r )r r r r( N)r r@ r* rJ rD r5 )r r r r rM r9 r r r rP y s
z%InternalTargets.resolve_reference_idsN)r! r" r# r% r rP r r r r rO p s rO c
@ s` e Zd ZdZdZdZdddddd d
d d d
g
Zdd� Zdd� Zdd� Z dd� Z
dd� Z dd� Z dS )� Footnotesa�
Assign numbers to autonumbered footnotes, and resolve links to footnotes,
citations, and their references.
Given the following ``document`` as input::
<document>
<paragraph>
A labeled autonumbered footnote referece:
<footnote_reference auto="1" id="id1" refname="footnote">
<paragraph>
An unlabeled autonumbered footnote referece:
<footnote_reference auto="1" id="id2">
<footnote auto="1" id="id3">
<paragraph>
Unlabeled autonumbered footnote.
<footnote auto="1" id="footnote" name="footnote">
<paragraph>
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::
<document>
<paragraph>
A labeled autonumbered footnote referece:
<footnote_reference auto="1" id="id1" refid="footnote">
2
<paragraph>
An unlabeled autonumbered footnote referece:
<footnote_reference auto="1" id="id2" refid="id3">
1
<footnote auto="1" id="id3" backrefs="id2">
<label>
1
<paragraph>
Unlabeled autonumbered footnote.
<footnote auto="1" id="footnote" name="footnote" backrefs="id1">
<label>
2
<paragraph>
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.
il N�*u †u ‡� §� ¶�#u ♠u ♥u ♦u ♣c C s: g | _ | jj}| j|�| j_| j|� | j� | j� d S )N)�autofootnote_labelsr Zautofootnote_start�number_footnotes�number_footnote_references�symbolize_footnotes� resolve_footnotes_and_citations)r �startnumr r r r � s
zFootnotes.applyc C s2 �x*| j jD �] }x"t|�}|d7 }|| j jkrP qW |jdtjd|�� x�|d D ]�}x�| j jj|g �D ]|}|tj |�7 }|j
d� t |d �t |d � ko�dkn s�t �|d d |d< |j
|d d � | j j|� d|_qjW qTW |d r |d r |d j|� | j j||� | jj|� q W |S ) z�
Assign numbers to autonumbered footnotes.
For labeled autonumbered footnotes, copy the number over to
corresponding footnote references.
r( r rH r r r
r Zdupnames)r Z
autofootnotes�strr@ �insertr �label�
footnote_refsr* �Text�delattrr r r1 r r5 r+ �note_explicit_targetrV )r r[ �footnoter^ r r9 r r r rW � s*
, zFootnotes.number_footnotesc
C sN d}�xB| j jD �]4}|js|jd�r(qy| j| }W n� tk
r� | j jjdt| j� |d�}| j j |�}x^| j j|d� D ]J}|js�|jd�r�q�t
j |j |j |d�}| j j |�}|j
|� |j|� q�W P Y nX |t
j|�7 }| j j| } | j j| }
| |d< | j j|� t|d �d k�s&t�|
j
|d d � d |_|d 7 }qW dS )
z3Assign numbers to autonumbered footnote references.r r zUToo many autonumbered footnote references: only %s corresponding footnotes available.)rI Nr )r r
r( )r Zautofootnote_refsr5 r rV �
IndexErrorr, r- r r. r r/ r0 r1 r2 r` r@ r
r r ) r r[ �ir9 r^ r7 r8 r: r; r rc r r r rX s:
z$Footnotes.number_footnote_referencesc
C s� g }xt| j jD ]h}t| j jt| j��\}}| j| |d }|j|� |jdtj d|�� | j jd7 _| j j
|� qW d}�x"| j j D �]}y|tj || �7 }W n� t
k
�rF | j jjdt|� |d�}| j j
|�} x`| j j |d� D ]L}|js�|jd��rq�tj|j|j| d�}
| j j
|
�} |j| � |j|
� q�W P Y nX | j j| }t|d �dk�sjt�|d d |d< | j j|� |j|d d � |d7 }q�W dS )
z<Add symbols indexes to "[*]"-style footnotes and references.r( r rH zOToo many symbol footnote references: only %s corresponding footnotes available.)rI Nr )r r
)r Zsymbol_footnotes�divmodZsymbol_footnote_startr �symbolsr+ r] r r^ r. Zsymbol_footnote_refsr` rd r, r- r5 r r/ r0 r1 r2 r r ) r Zlabelsrc Zreps�indexZ labeltextre r9 r7 r8 r: r; r r r rY 1 sD
z Footnotes.symbolize_footnotesc C s� xF| j jD ]:}x4|d D ](}|| j jkr| j j| }| j||� qW q
W xF| j jD ]:}x4|d D ](}|| j jkr`| j j| }| j||� q`W qRW dS )za
Link manually-labeled footnotes and citations to/from their
references.
r N)r Z footnotesr_ �resolve_referencesZ citationsZ
citation_refs)r rc r^ rM Zcitationr r r rZ V s z)Footnotes.resolve_footnotes_and_citationsc C s~ t |d �dkst�|d d }xR|D ]J}|jr2q&|jd� ||d< t |d �dksXt�|j|d d � d|_q&W d|_d S )Nr
r( r r r )r r r5 ra r1 )r ZnoterM r r9 r r r ri f s
z Footnotes.resolve_references)
r! r" r# r$ r% rV rg r rW rX rY rZ ri r r r r rQ � s& ; !%rQ c @ s e Zd ZdS )�#CircularSubstitutionDefinitionErrorN)r! r" r# r r r r rj t s rj c @ s e Zd ZdZdZdd� ZdS )�
SubstitutionsaD
Given the following ``document`` as input::
<document>
<paragraph>
The
<substitution_reference refname="biohazard">
biohazard
symbol is deservedly scary-looking.
<substitution_definition name="biohazard">
<image alt="biohazard" uri="biohazard.png">
The ``substitution_reference`` will simply be replaced by the
contents of the corresponding ``substitution_definition``.
The transformed result will be::
<document>
<paragraph>
The
<image alt="biohazard" uri="biohazard.png">
symbol is deservedly scary-looking.
<substitution_definition name="biohazard">
<image alt="biohazard" uri="biohazard.png">
�� c
C s | j j}| j j}| j jtj�}i }�x�|D �]�}|d }d }||krJ|}n|j� }||krb|| }|d kr�| j jjd| |d�} | j j | �}
tj
|j |j |
d�} | j j | �} | j | � |j
| � q*|| }
|j}|j|�}d|
jks�d|
jk�r0|dk�r0t||d tj��r0|j||d ||d j� � d |
jk�sHd|
jk�r�t|�|d k�r�t||d tj��r�|j||d ||d j� � |
j� }ydx^|jtj�D ]N}||d j� }||j|g �k�r�t�n || j|� ||d
< |j|� �q�W W n� tk
�r� |j}t|tj��rR| j jjd tj |j |j �|j |d �} |j
| � nv|}x|j d
��rp|d
}�qXW | j jjd
| |d�} | j j | �}
tj
|j |j |
d�} | j j | �} | j | � |j
| � Y q*X |j
|j � x4|j D ]*}t|tj ��r�d|k�r�| j j!|� �q�W q*W d S )Nr z(Undefined substitution referenced: "%s".)rI )r ZltrimZtrimr r( Zrtrimz
ref-originz*Circular substitution definition detected:)�linerI z2Circular substitution definition referenced: "%s".)"r Zsubstitution_defsZsubstitution_namesr r Zsubstitution_reference�lowerr, r- r. r/ r0 r1 r2 r rh Z
attributesr r` �replace�rstripr �lstrip�deepcopy�
setdefaultrj r+ Zsubstitution_definitionZ
literal_blockrm r ZchildrenZ ReferentialZ note_refname)r ZdefsZnormedZ
subreflist�nestedr9 r �keyZ normed_namer7 r8 r: r; Zsubdefr rh Z subdef_copyZ
nested_refZ nested_nameZ
ref_originr6 r r r r � s�
zSubstitutions.applyN)r! r" r# r$ r% r r r r r rk w s rk c @ s, e Zd ZdZdZdd� Zdd� Zdd� Zd S )
� TargetNotesz�
Creates a footnote for each external target in the text, and corresponding
footnote references after each reference.
i c C s$ t j| ||d� |jjdg �| _d S )N)� startnode�class)r �__init__Zdetailsr* �classes)r r rw r r r ry � s zTargetNotes.__init__c C s
i }g }x�| j jtj�D ]z}|jd�s(q|d }g }x"|D ]}|j| j jj|g �� q:W |s^q| j|d ||�}|d |kr|||d < |j |� qW xb| j jtj
�D ]P}|jd�s�q�|jd�r�| j|d |g|�}|d |kr�|||d < |j |� q�W | j j |� d S )Nr r r' )
r r r r r r rJ r* �make_target_footnoter+ r) rw r2 ) r �notesZnodelistr r �refsr rc r9 r r r r � s4
zTargetNotes.applyc C s^ ||kr2|| }t |d �dks$t�|d d }nltj� }| jj|�}d| }d|d< |g|d< tj� }|tjd||d�7 }||7 }| jj|� | jj ||� x�|D ]�}t
|tj �r�q�tj |dd�} | d | j
7 < | jj| � | jj| � |jj|�d }
| g} tj| jj��sH| j
�r6| jdtjd
| j
d �� n| jdtjd
�� |jj|
| � q�W |S ) Nr r( r z
TARGET_NOTE: �autorH )r )r r~ rz � )�textZClasses)r r r rc r r. Z paragraphr) Znote_autofootnoterb r r Zfootnote_referencerz Znote_autofootnote_refZnote_footnote_refr rh r Zget_trim_footnote_ref_spaceZsettingsr] Zinliner` ) r r r} r| rc Z
footnote_nameZ footnote_idZfootnote_paragraphr9 Zrefnoderh rM r r r r{ s:
z TargetNotes.make_target_footnoteN)r! r" r# r$ r% ry r r{ r r r r rv � s
rv c @ s e Zd ZdZdZdd� ZdS )�DanglingReferencesze
Check for dangling references (incl. footnote & citation) and for
unreferenced targets.
iR c C s� t | j| jjj�}| jj|� xr| jjtj�D ]`}|js.|j d�rDq.|d rZ|d d }n |d rp|d d }n|d }| jj
j d| |d� q.W d S )Nr' r r r
r z(Hyperlink target "%s" is not referenced.)rI ) �DanglingReferencesVisitorr rA rB �walkr r r r4 r* r, �info)r Zvisitorr rL r r r r J s
zDanglingReferences.applyN)r! r" r# r$ r% r r r r r r� A s r� c @ s, e Zd Zdd� Zdd� Zdd� Ze ZZdS )r� c C s t jj| |� || _|| _d S )N)r �SparseNodeVisitorry r rB )r r rB r r r ry h s z"DanglingReferencesVisitor.__init__c C s d S )Nr )r r6 r r r �
unknown_visitm s z'DanglingReferencesVisitor.unknown_visitc C s$ |j s|jd� rd S |d }| jjj|�}|d kr�x�| jD ]}||�r<P q<W || jjkrv| jjjd|d |d�}n| jjjd|d |d�}| jj|�}t j
|j |j |d�}y|d d }W n t k
r� | jj|�}Y nX |j
|� |j|� n(|d= ||d< | jj| j|d � d
|_ d S ) Nr zBDuplicate target name, cannot be used as a unique reference: "%s".)rI zUnknown target name: "%s".)r r
r r )r r( )r5 r r r@ r* rB r, r- r. r r/ r0 rd r1 r2 r
rD ) r r6 r r rF r7 r8 r: r; r r r �visit_referencep s8
z)DanglingReferencesVisitor.visit_referenceN)r! r" r# ry r� r� Zvisit_footnote_referenceZvisit_citation_referencer r r r r� f s !r� )r$ Z
__docformat__�sys�reZdocutilsr r Zdocutils.transformsr r r r& r< rN rO rQ � Exceptionrj rk rv r� r� r� r r r r �<module> s$ GB 3$( ]wS%