Your IP : 216.73.216.213
��]�- � B @ s� d Z d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z Gd d � d e � Z e j
d f k r� Gd d � d e � Z n e Z d d
� Z
Gd d � d e e � Z Gd
d � d e � Z Gd d � d e � Z Gd d � d e � Z Gd d � d � Z Gd d � d � Z Gd d � d � Z Gd d � d � Z Gd d � d � Z Gd d � d � Z Gd d � d e � Z Gd! d" � d" � Z Gd# d$ � d$ � Z Gd% d& � d& e � Z Gd' d( � d( e � Z Gd) d* � d* e � Z Gd+ d, � d, e � Z Gd- d. � d. e � Z Gd/ d0 � d0 � Z Gd1 d2 � d2 � Z! Gd3 d4 � d4 e � Z" Gd5 d6 � d6 e � Z# Gd7 d8 � d8 � Z$ Gd9 d: � d: e e e � Z% Gd; d< � d< e e e � Z& Gd= d> � d> e e e � Z' Gd? d@ � d@ e e � Z( GdA dB � dB e e � Z) GdC dD � dD e e � Z* GdE dF � dF e e � Z+ GdG dH � dH e e � Z, GdI dJ � dJ e e � Z- GdK dL � dL e e � Z. GdM dN � dN e e � Z/ GdO dP � dP e e � Z0 GdQ dR � dR e e � Z1 GdS dT � dT e e � Z2 GdU dV � dV e e � Z3 GdW dX � dX e e � Z4 GdY dZ � dZ e e � Z5 Gd[ d\ � d\ e e � Z6 Gd] d^ � d^ e e � Z7 Gd_ d` � d` e e � Z8 Gda db � db e e � Z9 Gdc dd � dd e e � Z: Gde df � df e e � Z; Gdg dh � dh e e � Z< Gdi dj � dj e e � Z= Gdk dl � dl e e � Z> Gdm dn � dn e e � Z? Gdo dp � dp e e � Z@ Gdq dr � dr e e � ZA Gds dt � dt e e � ZB Gdu dv � dv e e � ZC Gdw dx � dx e e � ZD Gdy dz � dz e e � ZE Gd{ d| � d| e e � ZF Gd} d~ � d~ e e � ZG Gd d� � d� e e � ZH Gd� d� � d� e e � ZI Gd� d� � d� e e � ZJ Gd� d� � d� e e � ZK Gd� d� � d� e e � ZL Gd� d� � d� e e � ZM Gd� d� � d� e e � ZN Gd� d� � d� e e � ZO Gd� d� � d� e e � ZP Gd� d� � d� e e � ZQ Gd� d� � d� e e � ZR Gd� d� � d� e e � ZS Gd� d� � d� e e � ZT Gd� d� � d� e e � ZU Gd� d� � d� e e � ZV Gd� d� � d� e e � ZW Gd� d� � d� e e � ZX Gd� d� � d� e e � ZY Gd� d� � d� e e � ZZ Gd� d� � d� e e � Z[ Gd� d� � d� e e � Z\ Gd� d� � d� e e � Z] Gd� d� � d� e e � Z^ Gd� d� � d� e e � Z_ Gd� d� � d� e e � Z` Gd� d� � d� e e � Za Gd� d� � d� e e e � Zb Gd� d� � d� e e e � Zc Gd� d� � d� e e e! e e# � Zd Gd� d� � d� e e e e$ e# � Ze Gd� d� � d� e e e e$ e# � Zf Gd� d� � d� e e � Zg Gd� d� � d� e e � Zh Gd� d� � d� e e � Zi Gd� d� � d� e e � Zj Gd� d� � d� e e � Zk Gd� d� � d� e e � Zl Gd� d� � d� e e � Zm Gd� d� � d� e e � Zn Gd� d� � d� e e � Zo Gd� d� � d� e e � Zp Gd� d� � d� e e � Zq Gd� d� � d� e e e e � Zr Gd� d� � d� e e e � Zs Gd� d� � d� e e! e e � Zt Gd� d� � d� e! e � Zu Gd� d� � d� e! e � Zv Gd� d� � d� e! e � Zw Gd� d� � d� e e! e" e � Zx Gd� d� � d� e! e" e � Zy Gd� d� � d� e! e" e � Zz Gd� d� � d� e! e � Z{ Gd� d� � d� e! e � Z| Gd� d� � d� e! e � Z} Gd� d� � d� e! e � Z~ Gd� d� � d� e! e � Z Gd� d� � d� e! e � Z� Gd� d� � d� e! e � Z� Gd� d� � d� e e! e � Z� Gd� d� � d� e! e � Z� Gd� d� � d� e! e � Z� Gd� d� � d� e! e � Z� d� j� � Z� Gd� d� � d� � Z� Gd� d� � d� e� � Z� Gd d� de� � Z� dd� Z� dd� Z� dd� Z� dd � Z� e� e� � Gd
d � d e� � Z� Gd d
� d
e� � Z� Gdd� de� � Z� Gdd� de� � Z� Gdd� de� � Z� Gdd� de� � Z� Gdd� de� � Z� Gdd� de� � Z� dd� Z� e j� d � Z� e j� d � Z� d d d d!d"d#d$d%d&d'd(d)d*d+d,d+d-d.d/d!d0d1d2d3d4d'd5d6d7d8d9d)d:d)d;d<d=d>d?d@dAd>dBd'dCd6dDd)dEdFdGd.dHdIdJd>dKdLdMdFdNdOdPdQdRd<i! Z� dSdTdUdVdWdXdYdZd[d\i Z� d]d^� Z� d_d`� Z� dadb� Z� dcdd� Z� dedf� Z� d S(g a�
Docutils document tree element class library.
Classes in CamelCase are abstract base classes or auxiliary classes. The one
exception is `Text`, for a text (PCDATA) node; uppercase is used to
differentiate from element classes. Classes in lower_case_with_underscores
are element classes, matching the XML element generic identifiers in the DTD_.
The position of each node (the level at which it can occur) is significant and
is represented by abstract base classes (`Root`, `Structural`, `Body`,
`Inline`, etc.). Certain transformations will be easier because we can use
``isinstance(node, base_class)`` to determine the position of the node in the
hierarchy.
.. _DTD: http://docutils.sourceforge.net/docs/ref/docutils.dtd
ZreStructuredText� Nc @ s e Z d Z d Z d Z d Z d Z d Z d d � Z e j
d" k rQ d d � Z d d d � Z d
d d d
� Z
d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z d d d d d d d � Z d d d d d d d! � Z d S)#�Nodez0Abstract base class of nodes in a document tree.Nc C s d S)a8
Node instances are always true, even if they're empty. A node is more
than a simple container. Its boolean "truth" does not depend on
having one or more subnodes in the doctree.
Use `len()` to check node length. Use `None` to represent a boolean
false value.
T� )�selfr r �?/opt/alt/python35/lib/python3.5/site-packages/docutils/nodes.py�__bool__4 s z
Node.__bool__� c C s t | � j d � S)NZraw_unicode_escape)�str�encode)r r r r �__str__B s z Node.__str__c C s7 | d k r d d l j j } | j � } | j | � S)z6Return a DOM **fragment** representation of this Node.Nr )�xml.dom.minidom�dom�minidom�Document� _dom_node)r r �domrootr r r �asdomE s z
Node.asdomz r c C s
t � d S)zs
Return an indented pseudo-XML representation, for test purposes.
Override in subclasses.
N)�NotImplementedError)r �indent�levelr r r �pformatL s z Node.pformatc C s
t � d S)zReturn a copy of self.N)r )r r r r �copyT s z Node.copyc C s
t � d S)z3Return a deep copy of self (also copying children).N)r )r r r r �deepcopyX s z
Node.deepcopyc C s^ | | _ | j rZ | j | _ | j d k r< | j j | _ | j d k rZ | j j | _ d S)N)�parent�document�source�current_source�line� current_line)r �childr r r � setup_child\ s zNode.setup_childc C s� d } | j j j d | j j � y� y | j | � Wn- t t f k
rU | SYn t k
rf Yn X| j } y5 x. | d d � D] } | j
| � r� d } Pq� WWn t k
r� Yn XWn t k
r� d } Yn X| S)a�
Traverse a tree of `Node` objects, calling the
`dispatch_visit()` method of `visitor` when entering each
node. (The `walkabout()` method is similar, except it also
calls the `dispatch_departure()` method before exiting each
node.)
This tree traversal supports limited in-place tree
modifications. Replacing one node with one or more nodes is
OK, as is removing an element. However, if the node removed
or replaced occurs after the current node, the old node will
still be traversed, and any new nodes will not.
Within ``visit`` methods (and ``depart`` methods for
`walkabout()`), `TreePruningException` subclasses may be raised
(`SkipChildren`, `SkipSiblings`, `SkipNode`, `SkipDeparture`).
Parameter `visitor`: A `NodeVisitor` object, containing a
``visit`` implementation for each `Node` subclass encountered.
Return true if we should stop the traversal.
Fz6docutils.nodes.Node.walk calling dispatch_visit for %sNT)
r �reporter�debug� __class__�__name__�dispatch_visit� SkipChildren�SkipNode�
SkipDeparture�children�walk� SkipSiblings�
StopTraversal)r �visitor�stopr( r r r r r) e s,
z Node.walkc C s! d } d } | j j j d | j j � y� y | j | � Wn- t k
rU | SYn t k
rl d } Yn X| j } y5 x. | d d � D] } | j | � r� d } Pq� WWn t
k
r� Yn XWn) t k
r� Yn t k
r� d } Yn X| r | j j j d | j j � | j
| � | S)a�
Perform a tree traversal similarly to `Node.walk()` (which
see), except also call the `dispatch_departure()` method
before exiting each node.
Parameter `visitor`: A `NodeVisitor` object, containing a
``visit`` and ``depart`` implementation for each `Node`
subclass encountered.
Return true if we should stop the traversal.
TFz;docutils.nodes.Node.walkabout calling dispatch_visit for %sNz?docutils.nodes.Node.walkabout calling dispatch_departure for %s)r r r! r" r# r$ r& r' r( � walkaboutr* r% r+ �dispatch_departure)r r, Z call_departr- r( r r r r r. � s<
zNode.walkaboutc C sP g } t | | � r" | j | � x' | j D] } | j | j | � � q, W| S)z:Specialized traverse() that only supports instance checks.)�
isinstance�appendr( �extend�_fast_traverse)r �cls�resultr r r r r3 � s
zNode._fast_traversec C s> g } | j | � x$ | j D] } | j | j � � q W| S)z:Specialized traverse() that doesn't check for a condition.)r1 r( r2 �
_all_traverse)r r5 r r r r r6 � s
zNode._all_traverseTFc
C s� | r d } | rQ | rQ | rQ | d k r5 | j � St | t � rQ | j | � St | t � ru | } | d d � } g } | r� | d k s� | | � r� | j | � | r� t | j � r� x? | D]7 } | j | j d d d d d d d d d
| � � q� W| s | r�| } x� | j r�| j j
| � }
xP | j |
d d � D]7 } | j | j d d d | d d d d d
| � � qEW| s�Pq| j } qW| S) a
Return an iterable containing
* self (if include_self is true)
* all descendants in tree traversal order (if descend is true)
* all siblings (if siblings is true) and their descendants (if
also descend is true)
* the siblings of the parent (if ascend is true) and their
descendants (if also descend is true), and so on
If `condition` is not None, the iterable contains only nodes
for which ``condition(node)`` is true. If `condition` is a
node class ``cls``, it is equivalent to a function consisting
of ``return isinstance(node, cls)``.
If ascend is true, assume siblings to be true as well.
For example, given the following tree::
<paragraph>
<emphasis> <--- emphasis.traverse() and
<strong> <--- strong.traverse() are called.
Foo
Bar
<reference name="Baz" refid="baz">
Baz
Then list(emphasis.traverse()) equals ::
[<emphasis>, <strong>, <#text: Foo>, <#text: Bar>]
and list(strong.traverse(ascend=True)) equals ::
[<strong>, <#text: Foo>, <#text: Bar>, <reference>, <#text: Baz>]
TNc S s
t | | � S)N)r0 )�node�
node_classr r r � condition s z Node.traverse.<locals>.condition� include_self�descend�siblingsF�ascendr9 � ) r6 r0 �typer3 r1 �lenr( r2 �traverser �index) r r9 r: r; r< r= r8 �rr r7 rB Zsiblingr r r rA � s> %
z
Node.traversec C sS | j d | d | d | d | d | � } y | d SWn t k
rN d SYn Xd S)z�
Return the first node in the iterable returned by traverse(),
or None if the iterable is empty.
Parameter list is the same as of traverse. Note that
include_self defaults to 0, though.
r9 r: r; r< r= r N)rA �
IndexError)r r9 r: r; r< r= �iterabler r r � next_node s
zNode.next_node)r )r# �
__module__� __qualname__�__doc__r r r r r �sys� version_infor
r r r r r r) r. r3 r6 rA rF r r r r r $ s* . + J r r c @ s" e Z d Z d Z d d � Z d S)� reprunicodezU
A unicode sub-class that removes the initial u from unicode's repr.
c C s t j | � d d � S)Nr> )r �__repr__)r r r r rM 1 s zreprunicode.__repr__N)r# rG rH rI rM r r r r rL , s rL c C s2 t j d k r. t | t � r. | j d d � S| S)z4
Failsave conversion of `unicode` to `str`.
r �ascii�backslashreplace)r )rJ rK r0 r r )�sr r r �
ensure_str9 s rQ c @ s� e Z d Z d Z d Z f Z e j d k r? d d d � Z n d d d � Z d d d
� Z d d d
� Z
d d � Z d d � Z d d � Z
d d � Z d d � Z d d d d � Z d d d � Z d d d � Z d S)!�Textz�
Instances are terminal nodes (leaves) containing text only; no child
nodes or attributes. Initialize by passing a string to the constructor.
Access the text itself with the `astext` method.
z#textr Nc C s+ t | t � r t d � � t j | | � S)z7Prevent the rawsource argument from propagating to str.z expecting str data, not bytes)r0 �bytes� TypeErrorrL �__new__)r4 �data� rawsourcer r r rU P s z Text.__new__c C s t j | | � S)z7Prevent the rawsource argument from propagating to str.)rL rU )r4 rV rW r r r rU V s � c C s
| | _ d S)N)rW )r rV rW r r r �__init__Z s z
Text.__init__� c C sG | } t | � | k r0 | d | d � d } d | j t | � f S)N� z ...z<%s: %r>)r@ �tagnamerL )r �maxlenrV r r r � shortrepr_ s zText.shortreprc C s | j d d � S)Nr] �D )r^ )r r r r rM e s z
Text.__repr__c C s | j t | � � S)N)ZcreateTextNoder )r r r r r r h s zText._dom_nodec C s
t | � S)N)rL )r r r r �astextk s z Text.astextc C s | j t | � d | j �S)NrW )r" rL rW )r r r r r w s z Text.copyc C s
| j � S)N)r )r r r r r z s z
Text.deepcopyz r c C sI g } | | } x) | j � D] } | j | | d � q Wd j | � S)N�
rX )�
splitlinesr1 �join)r r r r5 r r r r r } s
z Text.pformatc C s | j t j | | � � S)N)r" rL �rstrip)r �charsr r r rd � s z Text.rstripc C s | j t j | | � � S)N)r" rL �lstrip)r re r r r rf � s z Text.lstrip)r )r# rG rH rI r\ r( rJ rK rU rY r^ rM r r` r r r rd rf r r r r rR B s rR c @ sc e Z d Z d Z d� Z d� Z e e Z e d� Z d Z d Z d
d d � Z
d
d � Z d d � Z d d � Z
d d � Z e j d� k r� e Z d d d � Z d d � Z d d � Z d d � Z d d � Z d d! � Z d" d# � Z d$ d% � Z d& d' � Z d( d) � Z d* d+ � Z d, d- � Z d. d/ � Z d0 d1 � Z d d2 d3 � Z d4 d5 � Z! d6 d7 � Z" d d8 d9 � Z# e! Z$ e! Z d
d: d; � Z% d< d= � Z& d> d? � Z' d@ dA � Z( d� dC dD � Z) dE dF � Z* dG dH � Z+ dI dJ � Z, dK dL � Z- dM dN � Z. dO dP � Z/ dQ dR dS � Z0 dQ dT dU � Z1 dV dW � Z2 dX dY � Z3 dZ d[ � Z4 e4 dQ d\ d] d^ � Z5 dQ d\ d_ d` � Z6 dQ d\ da db � Z7 dQ d\ dc dd � Z8 d\ de df � Z9 dg dh � Z: di dj � Z; dk dl � Z< dm e j= dn do � Z> dm e j= dp dq � Z? dr dm ds dt � Z@ du dv � ZA dw dx � ZB dy dz � ZC d d d{ d| � ZD eE d} d~ � � ZF eE d d� � � ZG d S)��Elementa�
`Element` is the superclass to all specific elements.
Elements contain attributes and child nodes. Elements emulate
dictionaries for attributes, indexing by attribute name (a string). To
set the attribute 'att' to 'value', do::
element['att'] = 'value'
There are two special attributes: 'ids' and 'names'. Both are
lists of unique identifiers, and names serve as human interfaces
to IDs. Names are case- and whitespace-normalized (see the
fully_normalize_name() function), and IDs conform to the regular
expression ``[a-z](-?[a-z0-9]+)*`` (see the make_id() function).
Elements also emulate lists for child nodes (element nodes and/or text
nodes), indexing by integer. To get the first child node, use::
element[0]
Elements may be constructed using the ``+=`` operator. To add one new
child node to element, do::
element += node
This is equivalent to ``element.append(node)``.
To add a list of multiple child nodes at once, use the same ``+=``
operator::
element += [node1, node2]
This is equivalent to ``element.extend([node1, node2])``.
�ids�classes�names�dupnames�backrefsr Nz
rX c O s� | | _ g | _ | j | � i | _ x | j D] } g | j | <q2 Wxb t | j � � D]N \ } } | j � } | | j k r� | d d � | j | <q\ | | j | <q\ W| j d k r� | j j
| _ d S)N) rW r( r2 �
attributes�list_attributes�list�items�lowerr\ r" r# )r rW r( rm �att�valuer r r rY � s
zElement.__init__c C s� | j | j � } xY | j � D]K \ } } t | t � rV d j d d � | D� � } | j | d | � q Wx' | j D] } | j | j | � � qx W| S)N� c S s# g | ] } t d | f � � q S)z%s)�
serial_escape)�.0�vr r r �
<listcomp>� s z%Element._dom_node.<locals>.<listcomp>z%s)
Z
createElementr\ �attlistr0 ro rc Z setAttributer( � appendChildr )r r �elementZ attributers r r r r r � s zElement._dom_nodec C s� d } xH | j D]= } | | j � 7} t | � d k r | d d � d } Pq W| d r� d | j j d j d d � | d D� � | f Sd
| j j | f Sd S) NrX �< �8 z ...rj z
<%s "%s": %s>z; c S s g | ] } t | � � q Sr )rQ )rv �nr r r rx � s z$Element.__repr__.<locals>.<listcomp>z<%s: %s>)r( r^ r@ r" r# rc )r rV �cr r r rM � s
%zElement.__repr__c C sG | d r8 d | j j d j d d � | d D� � f Sd | j Sd S)Nrj z <%s "%s"...>z; c S s g | ] } t | � � q Sr )rQ )rv r~ r r r rx s z%Element.shortrepr.<locals>.<listcomp>z<%s...>)r" r# rc r\ )r r r r r^ � s
"zElement.shortreprc C sM | j r? d | j � d j d d � | j D� � | j � f S| j � Sd S)Nz%s%s%srX c S s g | ] } t | � � q Sr )r )rv r r r r rx s z'Element.__unicode__.<locals>.<listcomp>)r( �starttagrc �endtag�emptytag)r r r r � __unicode__ s
zElement.__unicode__r c C s� | d k r t } | j g } x� | j � D]� \ } } | d k rW | j d | � q+ t | t � r� d d � | D� } d j | � } n t | � } | | � } | j d | | f � q+ Wd d j | � S)Nz %s="True"c S s# g | ] } t d | f � � q S)z%s)ru )rv rw r r r rx s z$Element.starttag.<locals>.<listcomp>rt z%s=%sz<%s>)�pseudo_quoteattrr\ ry r1 r0 ro rc r )r Z quoteattr�parts�namers �valuesr r r r� s zElement.starttagc C s d | j S)Nz</%s>)r\ )r r r r r� # s zElement.endtagc C s. d d j | j g d d � | j � D� � S)Nz<%s/>rt c S s& g | ] \ } } d | | f � q S)z%s="%s"r )rv r~ rw r r r rx ( s z$Element.emptytag.<locals>.<listcomp>)rc r\ ry )r r r r r� & s zElement.emptytagc C s
t | j � S)N)r@ r( )r r r r �__len__+ s zElement.__len__c C s) t | t � r | | j k S| | j k S)N)r0 r rm r( )r �keyr r r � __contains__. s
zElement.__contains__c C s� t | t � r | j | St | t � r4 | j | St | t � ru | j d k s^ t d � � | j | j | j � St
d � � d S)Nr> z cannot handle slice with stridezFelement index must be an integer, a slice, or an attribute name string)Nr> ) r0 r rm �intr( �slice�step�AssertionError�startr- rT )r r� r r r � __getitem__5 s zElement.__getitem__c C s� t | t � r% | | j t | � <n� t | t � rQ | j | � | | j | <np t | t � r� | j d k s{ t d � � x | D] } | j | � q� W| | j | j | j
� <n t d � � d S)Nr> z cannot handle slice with stridezFelement index must be an integer, a slice, or an attribute name string)Nr> ) r0 r rm r� r r( r� r� r� r� r- rT )r r� �itemr7 r r r � __setitem__A s
zElement.__setitem__c C s� t | t � r | j | =nk t | t � r8 | j | =nO t | t � r{ | j d k sb t d � � | j | j | j � =n t
d � � d S)Nr> z cannot handle slice with stridezMelement index must be an integer, a simple slice, or an attribute name string)Nr> ) r0 r rm r� r( r� r� r� r� r- rT )r r� r r r � __delitem__P s
zElement.__delitem__c C s | j | S)N)r( )r �otherr r r �__add__\ s zElement.__add__c C s | | j S)N)r( )r r� r r r �__radd___ s zElement.__radd__c C s< t | t � r | j | � n | d k r8 | j | � | S)z4Append a node or a list of nodes to `self.children`.N)r0 r r1 r2 )r r� r r r �__iadd__b s
zElement.__iadd__c C s | j j d d � | j D� � S)Nc S s g | ] } | j � � q Sr )r` )rv r r r r rx l s z"Element.astext.<locals>.<listcomp>)�child_text_separatorrc r( )r r r r r` j s zElement.astextc C sI i } x< t | j j � � D]% \ } } | j | � r | | | <q W| S)N)ro rm rp �is_not_default)r Zattsr� rs r r r �non_default_attributesn s
"z Element.non_default_attributesc C s& t | j � j � � } | j � | S)N)ro r� rp �sort)r ry r r r ry u s
zElement.attlistc C s | j j | | � S)N)rm �get)r r� �failobjr r r r� z s z Element.getc C s
| | j k S)N)rm )r �attrr r r �hasattr} s zElement.hasattrc C s | | j k r | j | =d S)N)rm )r r� r r r �delattr� s zElement.delattrc C s | j j | | � S)N)rm �
setdefault)r r� r� r r r r� � s zElement.setdefaultc C sk x7 | j d g � D]# } | j d � r | d d � Sq Wy | j j | � SWn t k
rf | SYn Xd S)z�Return node's language tag.
Look iteratively in self and parents for a class argument
starting with ``language-`` and return the remainder of it
(which should be a `BCP49` language tag) or the `fallback`.
ri z language-� N)r� �
startswithr Z get_language�AttributeError)r �fallbackr4 r r r �get_language_code� s
zElement.get_language_codec C s! | j | � | j j | � d S)N)r r( r1 )r r� r r r r1 � s
zElement.appendc C s" x | D] } | j | � q Wd S)N)r1 )r r� r7 r r r r2 � s
zElement.extendc C sR t | t � r2 | j | � | j j | | � n | d k rN | | | | � <d S)N)r0 r r r( �insert)r rB r� r r r r� � s
zElement.insertr> c C s | j j | � S)N)r( �pop)r �ir r r r� � s z Element.popc C s | j j | � d S)N)r( �remove)r r� r r r r� � s zElement.removec C s | j j | � S)N)r( rB )r r� r r r rB � s z
Element.indexc C s+ | | g k r# | | j k r# d Sd Sd S)Nr r> )rn )r r� r r r r� � s zElement.is_not_defaultc C sL t | t � r | j } x- | j D]" } | j | | j | g � � q" Wd S)z�
Update basic attributes ('ids', 'names', 'classes',
'dupnames', but not 'source') from node or dictionary `dict_`.
N)r0 r rm �basic_attributes�append_attr_listr� )r �dict_rr r r r �update_basic_atts� s zElement.update_basic_attsc C s6 x/ | D]' } | | | k r | | j | � q Wd S)z�
For each element in values, if it does not exist in self[attr], append
it.
NOTE: Requires self[attr] and values to be sequence type and the
former should specifically be a list.
N)r1 )r r� r� rs r r r r� � s
zElement.append_attr_listc C sU t | j | � t � s) | | g | | <t | t � sA | g } | j | | � d S)a
First, convert both self[attr] and value to a non-string sequence
type; if either is not already a sequence, convert it to a list of one
element. Then call append_attr_list.
NOTE: self[attr] and value both must not be None.
N)r0 r� ro r� )r r� rs r r r �coerce_append_attr_list� s
z Element.coerce_append_attr_listTc C s) | s | j | � d k r% | | | <d S)z�
If self[attr] does not exist or force is True or omitted, set
self[attr] to value, otherwise do nothing.
N)r� )r r� rs �forcer r r � replace_attr� s zElement.replace_attrc C s) | j | � | k r% | j | | � d S)a
If attr is an attribute of self, set self[attr] to
[self[attr], value], otherwise set self[attr] to value.
NOTE: replace is not used by this function and is kept only for
compatibility with the other copy functions.
N)r� r� )r r� rs �replacer r r �copy_attr_convert� s zElement.copy_attr_convertc C sf | j | � | k rb t | j | � t � s< t | t � rO | j | | � n | j | | | � d S)a�
If attr is an attribute of self and either self[attr] or value is a
list, convert all non-sequence values to a sequence of 1 element and
then concatenate the two sequence, setting the result to self[attr].
If both self[attr] and value are non-sequences and replace is True or
self[attr] is None, replace self[attr] with value. Otherwise, do
nothing.
N)r� r0 ro r� r� )r r� rs r� r r r �copy_attr_coerce� s
zElement.copy_attr_coercec C sf | j | � | k rb t | j | � t � rO t | t � rO | j | | � n | j | | | � d S)aM
If attr is an attribute of self and both self[attr] and value are
lists, concatenate the two sequences, setting the result to
self[attr]. If either self[attr] or value are non-sequences and
replace is True or self[attr] is None, replace self[attr] with value.
Otherwise, do nothing.
N)r� r0 ro r� r� )r r� rs r� r r r �copy_attr_concatenate s
z Element.copy_attr_concatenatec C s, | j | � | k r( | j | | | � d S)zz
If replace is True or selfpattr] is None, replace self[attr] with
value. Otherwise, do nothing.
N)r� r� )r r� rs r� r r r �copy_attr_consistent s z Element.copy_attr_consistentFc C su t | t � r | j } | r* | j } n | j } | j | � x. t | | � D] } | | | | | | � qP Wd S)a.
Updates all attributes from node or dictionary `dict_`.
Appends the basic attributes ('ids', 'names', 'classes',
'dupnames', but not 'source') and then, for all other attributes in
dict_, updates the same attribute in self. When attributes with the
same identifier appear in both self and dict_, the two values are
merged based on the value of update_fun. Generally, when replace is
True, the values in self are replaced or merged with the values in
dict_; otherwise, the values in self may be preserved or merged. When
and_source is True, the 'source' attribute is included in the copy.
NOTE: When replace is False, and self contains a 'source' attribute,
'source' is not replaced even when dict_ has a 'source'
attribute, though it may still be merged into a list depending
on the value of update_fun.
NOTE: It is easier to call the update-specific methods then to pass
the update_fun method to this function.
N)r0 r rm �is_not_list_attribute�is_not_known_attributer� �filter)r r� Z
update_funr� �
and_sourceZ
filter_funrr r r r �update_all_atts s
zElement.update_all_attsc C s | j | t j | | � d S)aC
Updates all attributes from node or dictionary `dict_`.
Appends the basic attributes ('ids', 'names', 'classes',
'dupnames', but not 'source') and then, for all other attributes in
dict_, updates the same attribute in self. When attributes with the
same identifier appear in both self and dict_ and replace is True, the
values in self are replaced with the values in dict_; otherwise, the
values in self are preserved. When and_source is True, the 'source'
attribute is included in the copy.
NOTE: When replace is False, and self contains a 'source' attribute,
'source' is not replaced even when dict_ has a 'source'
attribute, though it may still be merged into a list depending
on the value of update_fun.
N)r� rg r� )r r� r� r� r r r � update_all_atts_consistantly@ s z$Element.update_all_atts_consistantlyc C s | j | t j | | � d S)a
Updates all attributes from node or dictionary `dict_`.
Appends the basic attributes ('ids', 'names', 'classes',
'dupnames', but not 'source') and then, for all other attributes in
dict_, updates the same attribute in self. When attributes with the
same identifier appear in both self and dict_ whose values aren't each
lists and replace is True, the values in self are replaced with the
values in dict_; if the values from self and dict_ for the given
identifier are both of list type, then the two lists are concatenated
and the result stored in self; otherwise, the values in self are
preserved. When and_source is True, the 'source' attribute is
included in the copy.
NOTE: When replace is False, and self contains a 'source' attribute,
'source' is not replaced even when dict_ has a 'source'
attribute, though it may still be merged into a list depending
on the value of update_fun.
N)r� rg r� )r r� r� r� r r r � update_all_atts_concatenatingU s z%Element.update_all_atts_concatenatingc C s | j | t j | | � d S)a[
Updates all attributes from node or dictionary `dict_`.
Appends the basic attributes ('ids', 'names', 'classes',
'dupnames', but not 'source') and then, for all other attributes in
dict_, updates the same attribute in self. When attributes with the
same identifier appear in both self and dict_ whose values are both
not lists and replace is True, the values in self are replaced with
the values in dict_; if either of the values from self and dict_ for
the given identifier are of list type, then first any non-lists are
converted to 1-element lists and then the two lists are concatenated
and the result stored in self; otherwise, the values in self are
preserved. When and_source is True, the 'source' attribute is
included in the copy.
NOTE: When replace is False, and self contains a 'source' attribute,
'source' is not replaced even when dict_ has a 'source'
attribute, though it may still be merged into a list depending
on the value of update_fun.
N)r� rg r� )r r� r� r� r r r �update_all_atts_coercionm s z Element.update_all_atts_coercionc C s | j | t j d | �d S)a}
Updates all attributes from node or dictionary `dict_`.
Appends the basic attributes ('ids', 'names', 'classes',
'dupnames', but not 'source') and then, for all other attributes in
dict_, updates the same attribute in self. When attributes with the
same identifier appear in both self and dict_ then first any non-lists
are converted to 1-element lists and then the two lists are
concatenated and the result stored in self; otherwise, the values in
self are preserved. When and_source is True, the 'source' attribute
is included in the copy.
NOTE: When replace is False, and self contains a 'source' attribute,
'source' is not replaced even when dict_ has a 'source'
attribute, though it may still be merged into a list depending
on the value of update_fun.
r� N)r� rg r� )r r� r� r r r �update_all_atts_convert� s z Element.update_all_atts_convertc C s
g | _ d S)N)r( )r r r r �clear� s z
Element.clearc C s\ | j | � } t | t � r8 | j | � | | | <n | d k rX | | | | d � <d S)z8Replace one child `Node` with another child or children.Nr> )rB r0 r r )r �old�newrB r r r r� � s
zElement.replacec C s� | } t | t � s> y | d } Wn t k
r= d } Yn Xt | t � r] | j | � n9 x6 | j D]+ } | | sg t d | | | f � � qg W| j j | | � d S)zc
Replace `self` node with `new`, where `new` is a node or a
list of nodes.
r NzLosing "%s" attribute: %s) r0 r rD rg r� r� r� r r� )r r� �updaterr r r r � replace_self� s
zElement.replace_selfr c C sm t | t � s | f } xN t | t t | � | � � D]. } x% | D] } t | | | � rD | SqD Wq7 Wd S)aM
Return the index of the first child whose class exactly matches.
Parameters:
- `childclass`: A `Node` subclass to search for, or a tuple of `Node`
classes. If a tuple, any of the classes may match.
- `start`: Initial index to check.
- `end`: Initial index to *not* check.
N)r0 �tuple�range�minr@ )r �
childclassr� �endrB r r r r �first_child_matching_class� s %
z"Element.first_child_matching_classc C sq t | t � s | f } xR t | t t | � | � � D]2 } x) | D] } t | j | | � rD PqD W| Sq7 Wd S)aI
Return the index of the first child whose class does *not* match.
Parameters:
- `childclass`: A `Node` subclass to skip, or a tuple of `Node`
classes. If a tuple, none of the classes may match.
- `start`: Initial index to check.
- `end`: Initial index to *not* check.
N)r0 r� r� r� r@ r( )r r� r� r� rB r r r r � first_child_not_matching_class� s %
z&Element.first_child_not_matching_classz c sA d j d � � | j � f g � � f d d � | j D� � S)NrX z%s%s
c s& g | ] } | j � � d � � q S)r> )r )rv r )r r r r rx � s z#Element.pformat.<locals>.<listcomp>)rc r� r( )r r r r )r r r r � s zElement.pformatc C s | j d | j | j � S)NrW )r" rW rm )r r r r r � s z Element.copyc C s- | j � } | j d d � | j D� � | S)Nc S s g | ] } | j � � q Sr )r )rv r r r r rx � s z$Element.deepcopy.<locals>.<listcomp>)r r2 r( )r r r r r r � s zElement.deepcopyc C sC t j d t d d �d | k s( t � | d j | j � � d S)z+Add a new class to the "classes" attribute.zadocutils.nodes.Element.set_class deprecated; append to Element['classes'] list attribute directly�
stacklevel� rt ri N)�warnings�warn�DeprecationWarningr� r1 rq )r r� r r r � set_class� s
zElement.set_classc C s� d | _ t | d i � j | � } t | d i � j | � } | r` | d k sW t � d | _ | r� | d k sx t � d | _ d S)zQNote that this Element has been referenced by its name
`name` or id `id`.r> Zexpect_referenced_by_nameZexpect_referenced_by_idN)�
referenced�getattrr� r� )r r� �idZby_nameZby_idr r r �note_referenced_by� s zElement.note_referenced_byc C s
| | j k S)z�
Returns True if and only if the given attribute is NOT one of the
basic list attributes defined for all Elements.
)rn )r4 r� r r r r� s z Element.is_not_list_attributec C s
| | j k S)zj
Returns True if and only if the given attribute is NOT recognized by
this class.
)�known_attributes)r4 r� r r r r� s z Element.is_not_known_attribute)rh ri rj rk )rl )r )r ���)Hr# rG rH rI r� Zlocal_attributesrn r� r\ r� rY r rM r^ r� rJ rK r
r� r� r� r� r� r� r� r� r� r� r� r` r� ry r� r� r� r� Zhas_keyr� r1 r2 r� r� r� rB r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� �maxsizer� r� r r r r� r� � classmethodr� r� r r r r rg � s� #
% rg c @ s. e Z d Z d Z d Z d d d d � Z d S)� TextElementa�
An element which directly contains text.
Its children are all `Text` or `Inline` subclass nodes. You can
check whether an element's context is inline simply by checking whether
its immediate parent is a `TextElement` instance (including subclasses).
This is handy for nodes like `image` that can appear both inline and as
standalone body elements.
If passing children to `__init__()`, make sure to set `text` to
``''`` or some other suitable value.
rX c O sN | d k r4 t | � } t j | | | | | � n t j | | | | � d S)NrX )rR rg rY )r rW �textr( rm Ztextnoder r r rY / s
zTextElement.__init__N)r# rG rH rI r� rY r r r r r� s
r� c @ s( e Z d Z d Z d d d d � Z d S)�FixedTextElementz5An element which directly contains preformatted text.rX c O s* t j | | | | | � d | j d <d S)NZpreservez xml:space)r� rY rm )r rW r� r( rm r r r rY < s zFixedTextElement.__init__N)r# rG rH rI rY r r r r r� 8 s r� c @ s e Z d Z d Z d S)�
Resolvabler N)r# rG rH Zresolvedr r r r r� E s r� c @ s e Z d Z d d � Z d S)� BackLinkablec C s | d j | � d S)Nrl )r1 )r �refidr r r � add_backrefL s zBackLinkable.add_backrefN)r# rG rH r� r r r r r� J s r� c @ s e Z d Z d S)�RootN)r# rG rH r r r r r� T s r� c @ s e Z d Z d S)�TitularN)r# rG rH r r r r r� V s r� c @ s e Z d Z d Z d S)�PreBibliographicz<Category of Node which may occur before Bibliographic Nodes.N)r# rG rH rI r r r r r� X s r� c @ s e Z d Z d S)�
BibliographicN)r# rG rH r r r r r� [ s r� c @ s e Z d Z d S)�
DecorativeN)r# rG rH r r r r r� ] s r� c @ s e Z d Z d S)�
StructuralN)r# rG rH r r r r r� _ s r� c @ s e Z d Z d S)�BodyN)r# rG rH r r r r r� a s r� c @ s e Z d Z d S)�GeneralN)r# rG rH r r r r r� c s r� c @ s e Z d Z d Z d S)�
SequentialzList-like elements.N)r# rG rH rI r r r r r� e s r� c @ s e Z d Z d S)�
AdmonitionN)r# rG rH r r r r r� h s r� c @ s e Z d Z d Z d S)�Specialz Special internal body elements.N)r# rG rH rI r r r r r� j s r� c @ s e Z d Z d Z d S)� Invisiblez.Internal elements that don't appear in output.N)r# rG rH rI r r r r r� m s r� c @ s e Z d Z d S)�PartN)r# rG rH r r r r r� p s r� c @ s e Z d Z d S)�InlineN)r# rG rH r r r r r� r s r� c @ s e Z d Z d S)� ReferentialN)r# rG rH r r r r r� t s r� c @ s e Z d Z d Z d Z d S)�
Targetabler N)r# rG rH r� Zindirect_reference_namer r r r r� w s r� c @ s e Z d Z d Z d S)�Labeledz(Contains a `label` as its first element.N)r# rG rH rI r r r r r� � s r� c @ s� e Z d Z d Z d d � Z d d � Z d d d � Z d d d
� Z d d d d � Z d
d � Z d d � Z
d d d � Z d d d � Z d d � Z
d d � Z d d � Z d d � Z d d � Z d d � Z d! d" � Z d# d$ � Z d% d& � Z d' d( � Z d) d* � Z d+ d, � Z d d- d. � Z d/ d0 � Z d d1 d2 � Z d3 d4 � Z d5 d6 � Z d7 d8 � Z d9 d: � Z d; d< � Z d S)=r z�
The document root element.
Do not instantiate this class directly; use
`docutils.utils.new_document()` instead.
c O s+ t j | | | � d | _ d | _ | | _ | | _ g | _ i | _ i | _ i | _ i | _
i | _ i | _ i | _
i | _ i | _ g | _ g | _ g | _ g | _ g | _ g | _ d | _ d | _ d | _ g | _ g | _ d d l } | j j | � | _ d | _ | | _ d S)Nr> r )!rg rY r r �settingsr �indirect_targets�substitution_defs�substitution_names�refnames�refids�nameids� nametypesrh �
footnote_refs�
citation_refs�
autofootnotes�autofootnote_refs�symbol_footnotes�symbol_footnote_refs� footnotes� citationsZautofootnote_startZsymbol_footnote_start�id_start�parse_messages�transform_messagesZdocutils.transformsZ
transformsZ Transformer� transformer�
decorationr )r r� r �args�kwargs�docutilsr r r rY � s< zdocument.__init__c C s' | j j � } d | d <d | d <| S)zB
Return dict with unpicklable references removed.
Nr r )�__dict__r )r �stater r r � __getstate__� s
zdocument.__getstate__Nc C sD | d k r d d l j j } | j � } | j | j | � � | S)z-Return a DOM representation of this document.Nr )r r r
r rz r )r r r r r r r � s
zdocument.asdomc C s% x` | d D]T } | | j k r | j | | k r | j j d | � } | d k r | | 7} q W| d sx� | d D]2 } | j j t | � } | rx | | j k rx Pqx Wd } xL | s� | | j k r| j j | j j t | j � } | j d 7_ q� W| d j | � | | j | <| S)Nrh zDuplicate ID: "%s".rj rX r> )
rh r Zseverer� Z id_prefix�make_idZauto_id_prefixr r r1 )r r7 �msgnoder� �msgr� r r r �set_id� s" "
#
zdocument.set_idc C s^ xW | d D]K } | | j k r< | j | | | | | � q | | j | <| | j | <q Wd S)a�
`self.nameids` maps names to IDs, while `self.nametypes` maps names to
booleans representing hyperlink type (True==explicit,
False==implicit). This method updates the mappings.
The following state transition table shows how `self.nameids` ("ids")
and `self.nametypes` ("types") change with new input (a call to this
method), and what actions are performed ("implicit"-type system
messages are INFO/1, and "explicit"-type system messages are ERROR/3):
==== ===== ======== ======== ======= ==== ===== =====
Old State Input Action New State Notes
----------- -------- ----------------- ----------- -----
ids types new type sys.msg. dupname ids types
==== ===== ======== ======== ======= ==== ===== =====
- - explicit - - new True
- - implicit - - new False
None False explicit - - new True
old False explicit implicit old new True
None True explicit explicit new None True
old True explicit explicit new,old None True [#]_
None False implicit implicit new None False
old False implicit implicit new,old None False
None True implicit implicit new None True
old True implicit implicit new old True
==== ===== ======== ======== ======= ==== ===== =====
.. [#] Do not clear the name-to-id map or invalidate the old target if
both old and new targets are external and refer to identical URIs.
The new target is invalidated regardless.
rj N)r� �set_duplicate_name_idr� )r r7 r� r �explicitr� r r r �set_name_id_map s
zdocument.set_name_id_mapc C s� | j | } | j | } | p# | | j | <| rD| rd } | d k r� | j | } d | k r� | d }
| d r� d | k r� | d |
k r� d } | d k r� t | | � d | j | <| j j | d | d | g d | �} | d k r� | | 7} t | | � q�| | j | <| d k r�| j | } t | | � nG | d k r~| r~d | j | <| j | } t | | � t | | � | s�| r�| d k r�| j j d | d | g d | �} | d k r�| | 7} d S) Nr� �refurirj r> z%Duplicate explicit target name: "%s".rl � base_nodez%Duplicate implicit target name: "%s".)r� r� rh �dupnamer �system_message�info) r r7 r� r� r r Zold_idZ old_explicitr Zold_noder r r r r r 7 sL
z document.set_duplicate_name_idc C s
| | j k S)N)r� )r r� r r r �has_namea s zdocument.has_namec C s/ | j | | � } | j | | | d d �d S)Nr )r r )r �targetr r� r r r �note_implicit_targete s z document.note_implicit_targetc C s/ | j | | � } | j | | | d d �d S)Nr T)r r )r r r r� r r r �note_explicit_targeti s z document.note_explicit_targetc C s$ | j j | d g � j | � d S)N�refname)r� r� r1 )r r7 r r r � note_refnamem s zdocument.note_refnamec C s$ | j j | d g � j | � d S)Nr� )r� r� r1 )r r7 r r r �
note_refidp s zdocument.note_refidc C s+ | j j | � | d r' | j | � d S)Nrj )r� r1 r )r r r r r �note_indirect_targets s
z document.note_indirect_targetc C s | j | � d S)N)r )r r r r r �note_anonymous_targetx s z document.note_anonymous_targetc C s! | j | � | j j | � d S)N)r r� r1 )r �footnoter r r �note_autofootnote{ s
zdocument.note_autofootnotec C s! | j | � | j j | � d S)N)r r� r1 )r �refr r r �note_autofootnote_ref s
z document.note_autofootnote_refc C s! | j | � | j j | � d S)N)r r� r1 )r r" r r r �note_symbol_footnote� s
z document.note_symbol_footnotec C s! | j | � | j j | � d S)N)r r� r1 )r r$ r r r �note_symbol_footnote_ref� s
z!document.note_symbol_footnote_refc C s! | j | � | j j | � d S)N)r r r1 )r r" r r r �
note_footnote� s
zdocument.note_footnotec C s> | j | � | j j | d g � j | � | j | � d S)Nr )r r� r� r1 r )r r$ r r r �note_footnote_ref� s
zdocument.note_footnote_refc C s | j j | � d S)N)r r1 )r �citationr r r �
note_citation� s zdocument.note_citationc C s> | j | � | j j | d g � j | � | j | � d S)Nr )r r� r� r1 r )r r$ r r r �note_citation_ref� s
zdocument.note_citation_refc C s� t | � } | | j k rg | j j d | d | �} | d k rM | | 7} | j | } t | | � | | j | <| | j t | � <d S)Nz-Duplicate substitution definition name: "%s".r )�whitespace_normalize_namer� r �errorr r� �fully_normalize_name)r ZsubdefZdef_namer r� r Zoldnoder r r �note_substitution_def� s
z document.note_substitution_defc C s t | � | d <d S)Nr )r- )r Zsubrefr r r r �note_substitution_ref� s z document.note_substitution_refc C s | j j | | � d S)N)r Z add_pending)r �pending�priorityr r r � note_pending� s zdocument.note_pendingc C s | j j | � d S)N)r r1 )r �messager r r �note_parse_message� s zdocument.note_parse_messagec C s | j j | � d S)N)r r1 )r r5 r r r �note_transform_message� s z document.note_transform_messagec C s2 | | _ | d k r! | | _ n
| d | _ d S)Nr> )r r )r r �offsetr r r � note_source� s zdocument.note_sourcec C s | j | j | j | j � S)N)r" r� r rm )r r r r r � s z
document.copyc C s] | j sV t � | _ | j t � } | d k rC | j | j � n | j | | j � | j S)N)r r� r� r1 r� )r rB r r r �get_decoration� s zdocument.get_decoration)!r# rG rH rI rY r r r r r r r r r r r r! r# r% r& r' r( r) r+ r, r0 r1 r4 r6 r7 r9 r r: r r r r r � s< Y ' * r c @ s e Z d Z d S)�titleN)r# rG rH r r r r r; � s r; c @ s e Z d Z d S)�subtitleN)r# rG rH r r r r r< � s r< c @ s e Z d Z d S)�rubricN)r# rG rH r r r r r= � s r= c @ s e Z d Z d S)�docinfoN)r# rG rH r r r r r> � s r> c @ s e Z d Z d S)�authorN)r# rG rH r r r r r? � s r? c @ s e Z d Z d S)�authorsN)r# rG rH r r r r r@ � s r@ c @ s e Z d Z d S)� organizationN)r# rG rH r r r r rA � s rA c @ s e Z d Z d S)�addressN)r# rG rH r r r r rB � s rB c @ s e Z d Z d S)�contactN)r# rG rH r r r r rC � s rC c @ s e Z d Z d S)�versionN)r# rG rH r r r r rD � s rD c @ s e Z d Z d S)�revisionN)r# rG rH r r r r rE � s rE c @ s e Z d Z d S)�statusN)r# rG rH r r r r rF � s rF c @ s e Z d Z d S)�dateN)r# rG rH r r r r rG � s rG c @ s e Z d Z d S)� copyrightN)r# rG rH r r r r rH � s rH c @ s( e Z d Z d d � Z d d � Z d S)r c C sE t | j � s' t | j d t � r: | j d t � � | j d S)Nr )r@ r( r0 �headerr� )r r r r �
get_header� s 'zdecoration.get_headerc C sB t | j � s' t | j d t � r7 | j t � � | j d S)Nr> r� r� )r@ r( r0 �footerr1 )r r r r �
get_footer� s 'zdecoration.get_footerN)r# rG rH rJ rL r r r r r � s r c @ s e Z d Z d S)rI N)r# rG rH r r r r rI � s rI c @ s e Z d Z d S)rK N)r# rG rH r r r r rK � s rK c @ s e Z d Z d S)�sectionN)r# rG rH r r r r rM s rM c @ s e Z d Z d Z d S)�topica�
Topics are terminal, "leaf" mini-sections, like block quotes with titles,
or textual figures. A topic is just like a section, except that it has no
subsections, and it doesn't have to conform to section placement rules.
Topics are allowed wherever body elements (list, table, etc.) are allowed,
but only at the top level of a section or document. Topics cannot nest
inside topics, sidebars, or body elements; you can't have a topic inside a
table, list, block quote, etc.
N)r# rG rH rI r r r r rN s rN c @ s e Z d Z d Z d S)�sidebara�
Sidebars are like miniature, parallel documents that occur inside other
documents, providing related or reference material. A sidebar is
typically offset by a border and "floats" to the side of the page; the
document's main text may flow around it. Sidebars can also be likened to
super-footnotes; their content is outside of the flow of the document's
main text.
Sidebars are allowed wherever body elements (list, table, etc.) are
allowed, but only at the top level of a section or document. Sidebars
cannot nest inside sidebars, topics, or body elements; you can't have a
sidebar inside a table, list, block quote, etc.
N)r# rG rH rI r r r r rO s rO c @ s e Z d Z d S)�
transitionN)r# rG rH r r r r rP " s rP c @ s e Z d Z d S)� paragraphN)r# rG rH r r r r rQ ) s rQ c @ s e Z d Z d S)�compoundN)r# rG rH r r r r rR * s rR c @ s e Z d Z d S)� containerN)r# rG rH r r r r rS + s rS c @ s e Z d Z d S)� bullet_listN)r# rG rH r r r r rT , s rT c @ s e Z d Z d S)�enumerated_listN)r# rG rH r r r r rU - s rU c @ s e Z d Z d S)� list_itemN)r# rG rH r r r r rV . s rV c @ s e Z d Z d S)�definition_listN)r# rG rH r r r r rW / s rW c @ s e Z d Z d S)�definition_list_itemN)r# rG rH r r r r rX 0 s rX c @ s e Z d Z d S)�termN)r# rG rH r r r r rY 1 s rY c @ s e Z d Z d S)�
classifierN)r# rG rH r r r r rZ 2 s rZ c @ s e Z d Z d S)�
definitionN)r# rG rH r r r r r[ 3 s r[ c @ s e Z d Z d S)�
field_listN)r# rG rH r r r r r\ 4 s r\ c @ s e Z d Z d S)�fieldN)r# rG rH r r r r r] 5 s r] c @ s e Z d Z d S)�
field_nameN)r# rG rH r r r r r^ 6 s r^ c @ s e Z d Z d S)�
field_bodyN)r# rG rH r r r r r_ 7 s r_ c @ s e Z d Z d Z d S)�optionrX N)r# rG rH r� r r r r r` : s r` c @ s e Z d Z d d � Z d S)�option_argumentc C s | j d d � t j | � S)N� delimiterrt )r� r� r` )r r r r r` A s zoption_argument.astextN)r# rG rH r` r r r r ra ? s ra c @ s e Z d Z d Z d S)� option_groupz, N)r# rG rH r� r r r r rc E s rc c @ s e Z d Z d S)� option_listN)r# rG rH r r r r rd J s rd c @ s e Z d Z d Z d S)�option_list_itemz N)r# rG rH r� r r r r re M s re c @ s e Z d Z d S)�
option_stringN)r# rG rH r r r r rf R s rf c @ s e Z d Z d S)� descriptionN)r# rG rH r r r r rg S s rg c @ s e Z d Z d S)�
literal_blockN)r# rG rH r r r r rh T s rh c @ s e Z d Z d S)�
doctest_blockN)r# rG rH r r r r ri U s ri c @ s e Z d Z d S)�
math_blockN)r# rG rH r r r r rj V s rj c @ s e Z d Z d S)�
line_blockN)r# rG rH r r r r rk W s rk c @ s e Z d Z d Z d S)r N)r# rG rH r r r r r r Z s r c @ s e Z d Z d S)� block_quoteN)r# rG rH r r r r rl _ s rl c @ s e Z d Z d S)� attributionN)r# rG rH r r r r rm ` s rm c @ s e Z d Z d S)� attentionN)r# rG rH r r r r rn a s rn c @ s e Z d Z d S)�cautionN)r# rG rH r r r r ro b s ro c @ s e Z d Z d S)�dangerN)r# rG rH r r r r rp c s rp c @ s e Z d Z d S)r. N)r# rG rH r r r r r. d s r. c @ s e Z d Z d S)� importantN)r# rG rH r r r r rq e s rq c @ s e Z d Z d S)�noteN)r# rG rH r r r r rr f s rr c @ s e Z d Z d S)�tipN)r# rG rH r r r r rs g s rs c @ s e Z d Z d S)�hintN)r# rG rH r r r r rt h s rt c @ s e Z d Z d S)�warningN)r# rG rH r r r r ru i s ru c @ s e Z d Z d S)�
admonitionN)r# rG rH r r r r rv j s rv c @ s e Z d Z d S)�commentN)r# rG rH r r r r rw k s rw c @ s e Z d Z d S)�substitution_definitionN)r# rG rH r r r r rx l s rx c @ s e Z d Z d S)r N)r# rG rH r r r r r m s r c @ s e Z d Z d S)r" N)r# rG rH r r r r r" n s r" c @ s e Z d Z d S)r* N)r# rG rH r r r r r* o s r* c @ s e Z d Z d S)�labelN)r# rG rH r r r r ry p s ry c @ s e Z d Z d S)�figureN)r# rG rH r r r r rz q s rz c @ s e Z d Z d S)�captionN)r# rG rH r r r r r{ r s r{ c @ s e Z d Z d S)�legendN)r# rG rH r r r r r| s s r| c @ s e Z d Z d S)�tableN)r# rG rH r r r r r} t s r} c @ s e Z d Z d S)�tgroupN)r# rG rH r r r r r~ u s r~ c @ s e Z d Z d S)�colspecN)r# rG rH r r r r r v s r c @ s e Z d Z d S)�theadN)r# rG rH r r r r r� w s r� c @ s e Z d Z d S)�tbodyN)r# rG rH r r r r r� x s r� c @ s e Z d Z d S)�rowN)r# rG rH r r r r r� y s r� c @ s e Z d Z d S)�entryN)r# rG rH r r r r r� z s r� c @ s1 e Z d Z d Z d d d � Z d d � Z d S)r z�
System message element.
Do not instantiate this class directly; use
``document.reporter.info/warning/error/severe()`` instead.
Nc O s_ | r" t d | � } | f | } y t j | d | | � Wn t d | f � � Yn Xd S)NrX zsystem_message: children=%r)rQ rg rY �print)r r5 r( rm �pr r r rY � s
zsystem_message.__init__c C s> | j d d � } d | d | | d | d t j | � f S)Nr rX z%s:%s: (%s/%s) %sr r? r )r� rg r` )r r r r r r` � s zsystem_message.astext)r# rG rH rI rY r` r r r r r } s
r c @ sF e Z d Z d Z d d d d � Z d d d d � Z d
d � Z d S) r2 aF
The "pending" element is used to encapsulate a pending operation: the
operation (transform), the point at which to apply it, and any data it
requires. Only the pending operation's location within the document is
stored in the public document tree (by the "pending" object itself); the
operation and its data are stored in the "pending" object's internal
instance attributes.
For example, say you want a table of contents in your reStructuredText
document. The easiest way to specify where to put it is from within the
document, with a directive::
.. contents::
But the "contents" directive can't do its work until the entire document
has been parsed and possibly transformed to some extent. So the directive
code leaves a placeholder behind that will trigger the second phase of its
processing, something like this::
<pending ...public attributes...> + internal attributes
Use `document.note_pending()` so that the
`docutils.transforms.Transformer` stage of processing can run all pending
transforms.
NrX c O s2 t j | | | | � | | _ | p( i | _ d S)N)rg rY � transform�details)r r� r� rW r( rm r r r rY � s zpending.__init__z r c ss d d | j j | j j f d g } t | j j � � } | j � x� | D]� \ } } t | t � r� | j d d | f � | j
d d � | j � j � D� � qK | r t | t � r t | d t � r | j d d | f � xQ | D], } | j
d d � | j � j � D� � q� WqK | j d
d | | f � qK Wt
j | � � � d j � � f d d � | D� � S) Nz.. internal attributes:z .transform: %s.%sz .details:z%7s%s:rX c S s g | ] } d d | f � q S)z%9s%srX r )rv r r r r rx � s z#pending.pformat.<locals>.<listcomp>r c S s g | ] } d d | f � q S)z%9s%srX r )rv r r r r rx � s z %7s%s: %rc s$ g | ] } d � � | f � q S)z %s%s
r )rv r )r r r r rx � s )r� rG r# ro r� rp r� r0 r r1 r2 r rb rg rc )r r r Z internalsr� r� rs rw r )r r r r � s*
zpending.pformatc C s" | j | j | j | j | j � S)N)r" r� r� rW rm )r r r r r � s z pending.copy)r# rG rH rI rY r r r r r r r2 � s
r2 c @ s e Z d Z d Z d S)�rawz@
Raw data that is to be passed untouched to the Writer.
N)r# rG rH rI r r r r r� � s r� c @ s e Z d Z d S)�emphasisN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�strongN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�literalN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)� referenceN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�footnote_referenceN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�citation_referenceN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�substitution_referenceN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�title_referenceN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)� abbreviationN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�acronymN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)� superscriptN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)� subscriptN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)�mathN)r# rG rH r r r r r� � s r� c @ s e Z d Z d d � Z d S)�imagec C s | j d d � S)NZaltrX )r� )r r r r r` � s z image.astextN)r# rG rH r` r r r r r� � s r� c @ s e Z d Z d S)�inlineN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)� problematicN)r# rG rH r r r r r� � s r� c @ s e Z d Z d S)� generatedN)r# rG rH r r r r r� � s r� a<
Text
abbreviation acronym address admonition attention attribution author
authors
block_quote bullet_list
caption caution citation citation_reference classifier colspec comment
compound contact container copyright
danger date decoration definition definition_list definition_list_item
description docinfo doctest_block document
emphasis entry enumerated_list error
field field_body field_list field_name figure footer
footnote footnote_reference
generated
header hint
image important inline
label legend line line_block list_item literal literal_block
math math_block
note
option option_argument option_group option_list option_list_item
option_string organization
paragraph pending problematic
raw reference revision row rubric
section sidebar status strong subscript substitution_definition
substitution_reference subtitle superscript system_message
table target tbody term tgroup thead tip title title_reference topic
transition
version
warningc @ sX e Z d Z d Z f Z d d � Z d d � Z d d � Z d d � Z d
d � Z d S)
� NodeVisitora�
"Visitor" pattern [GoF95]_ abstract superclass implementation for
document tree traversals.
Each node class has corresponding methods, doing nothing by
default; override individual methods for specific and useful
behaviour. The `dispatch_visit()` method is called by
`Node.walk()` upon entering a node. `Node.walkabout()` also calls
the `dispatch_departure()` method before exiting a node.
The dispatch methods call "``visit_`` + node class name" or
"``depart_`` + node class name", resp.
This is a base class for visitors whose ``visit_...`` & ``depart_...``
methods should be implemented for *all* node types encountered (such as
for `docutils.writers.Writer` subclasses). Unimplemented methods will
raise exceptions.
For sparse traversals, where only certain node types are of interest,
subclass `SparseNodeVisitor` instead. When (mostly or entirely) uniform
processing is desired, subclass `GenericNodeVisitor`.
.. [GoF95] Gamma, Helm, Johnson, Vlissides. *Design Patterns: Elements of
Reusable Object-Oriented Software*. Addison-Wesley, Reading, MA, USA,
1995.
c C s
| | _ d S)N)r )r r r r r rY L s zNodeVisitor.__init__c C sO | j j } t | d | | j � } | j j j d | j | f � | | � S)z�
Call self."``visit_`` + node class name" with `node` as
parameter. If the ``visit_...`` method does not exist, call
self.unknown_visit.
�visit_z;docutils.nodes.NodeVisitor.dispatch_visit calling %s for %s)r" r# r� �
unknown_visitr r r! )r r7 � node_name�methodr r r r$ O s zNodeVisitor.dispatch_visitc C sO | j j } t | d | | j � } | j j j d | j | f � | | � S)z�
Call self."``depart_`` + node class name" with `node` as
parameter. If the ``depart_...`` method does not exist, call
self.unknown_departure.
�depart_z?docutils.nodes.NodeVisitor.dispatch_departure calling %s for %s)r" r# r� �unknown_departurer r r! )r r7 r� r� r r r r/ \ s z NodeVisitor.dispatch_departurec C sG | j j j s$ | j j | j k rC t d | j | j j f � � d S)zk
Called when entering unknown `Node` types.
Raise an exception unless overridden.
z!%s visiting unknown node type: %sN)r r� �strict_visitorr" r# �optionalr )r r7 r r r r� i s
zNodeVisitor.unknown_visitc C sG | j j j s$ | j j | j k rC t d | j | j j f � � d S)zi
Called before exiting unknown `Node` types.
Raise exception unless overridden.
z"%s departing unknown node type: %sN)r r� r� r" r# r� r )r r7 r r r r� u s
z NodeVisitor.unknown_departureN)
r# rG rH rI r� rY r$ r/ r� r� r r r r r� % s
r� c @ s e Z d Z d Z d S)�SparseNodeVisitora
Base class for sparse traversals, where only certain node types are of
interest. When ``visit_...`` & ``depart_...`` methods should be
implemented for *all* node types (such as for `docutils.writers.Writer`
subclasses), subclass `NodeVisitor` instead.
N)r# rG rH rI r r r r r� � s r� c @ s. e Z d Z d Z d d � Z d d � Z d S)�GenericNodeVisitora�
Generic "Visitor" abstract superclass, for simple traversals.
Unless overridden, each ``visit_...`` method calls `default_visit()`, and
each ``depart_...`` method (when using `Node.walkabout()`) calls
`default_departure()`. `default_visit()` (and `default_departure()`) must
be overridden in subclasses.
Define fully generic visitors by overriding `default_visit()` (and
`default_departure()`) only. Define semi-generic visitors by overriding
individual ``visit_...()`` (and ``depart_...()``) methods also.
`NodeVisitor.unknown_visit()` (`NodeVisitor.unknown_departure()`) should
be overridden for default behavior.
c C s
t � d S)z)Override for generic, uniform traversals.N)r )r r7 r r r �
default_visit� s z GenericNodeVisitor.default_visitc C s
t � d S)z)Override for generic, uniform traversals.N)r )r r7 r r r �default_departure� s z$GenericNodeVisitor.default_departureN)r# rG rH rI r� r� r r r r r� � s r� c C s | j | � d S)N)r� )r r7 r r r �_call_default_visit� s r� c C s | j | � d S)N)r� )r r7 r r r �_call_default_departure� s r� c C s d S)Nr )r r7 r r r �_nop� s r� c C se x^ | D]V } t t d | t � t t d | t � t t d | t � t t d | t � q Wd S)z%Save typing with dynamic assignments:r� r� N)�setattrr� r� r� r� r� )rj �_namer r r �_add_node_class_names� s
r� c @ sF e Z d Z d Z d d � Z d d � Z d d � Z d d � Z d
S) �TreeCopyVisitorzQ
Make a complete copy of a tree or branch, including element attributes.
c C s& t j | | � g | _ g | _ d S)N)r� rY � parent_stackr )r r r r r rY � s zTreeCopyVisitor.__init__c C s | j d S)Nr )r )r r r r �
get_tree_copy� s z TreeCopyVisitor.get_tree_copyc C s< | j � } | j j | � | j j | j � | | _ d S)z9Copy the current node, and make it the new acting parent.N)r r r1 r� )r r7 Znewnoder r r r� � s z TreeCopyVisitor.default_visitc C s | j j � | _ d S)z#Restore the previous acting parent.N)r� r� r )r r7 r r r r� � s z!TreeCopyVisitor.default_departureN)r# rG rH rI rY r� r� r� r r r r r� � s
r� c @ s e Z d Z d Z d S)�TreePruningExceptionz�
Base class for `NodeVisitor`-related tree pruning exceptions.
Raise subclasses from within ``visit_...`` or ``depart_...`` methods
called from `Node.walk()` and `Node.walkabout()` tree traversals to prune
the tree traversed.
N)r# rG rH rI r r r r r� � s r� c @ s e Z d Z d Z d S)r% z�
Do not visit any children of the current node. The current node's
siblings and ``depart_...`` method are not affected.
N)r# rG rH rI r r r r r% � s r% c @ s e Z d Z d Z d S)r* z�
Do not visit any more siblings (to the right) of the current node. The
current node's children and its ``depart_...`` method are not affected.
N)r# rG rH rI r r r r r* � s r* c @ s e Z d Z d Z d S)r& zq
Do not visit the current node's children, and do not call the current
node's ``depart_...`` method.
N)r# rG rH rI r r r r r& � s r& c @ s e Z d Z d Z d S)r' z
Do not call the current node's ``depart_...`` method. The current node's
children and siblings are not affected.
N)r# rG rH rI r r r r r' � s r' c @ s e Z d Z d Z d S)� NodeFoundz�
Raise to indicate that the target of a search has been found. This
exception must be caught by the client; it is not caught by the traversal
code.
N)r# rG rH rI r r r r r� s r� c @ s e Z d Z d Z d S)r+ a=
Stop the traversal alltogether. The current node's ``depart_...`` method
is not affected. The parent nodes ``depart_...`` methods are also called
as usual. No other nodes are visited. This is an alternative to
NodeFound that does not cause exception handling to trickle up to the
caller.
N)r# rG rH rI r r r r r+ s r+ c C s� | j � } t | t � s' | j � } | j t � } | j t � } t j d | � j d d � j d � } t
j d d j | j
� � � } t j d | � } t | � S)a�
Convert `string` into an identifier and return it.
Docutils identifiers will conform to the regular expression
``[a-z](-?[a-z0-9]+)*``. For CSS compatibility, identifiers (the "class"
and "id" attributes) should have no underscores, colons, or periods.
Hyphens may be used.
- The `HTML 4.01 spec`_ defines identifiers based on SGML tokens:
ID and NAME tokens must begin with a letter ([A-Za-z]) and may be
followed by any number of letters, digits ([0-9]), hyphens ("-"),
underscores ("_"), colons (":"), and periods (".").
- However the `CSS1 spec`_ defines identifiers based on the "name" token,
a tighter interpretation ("flex" tokenizer notation; "latin1" and
"escape" 8-bit characters have been replaced with entities)::
unicode \[0-9a-f]{1,4}
latin1 [¡-ÿ]
escape {unicode}|\[ -~¡-ÿ]
nmchar [-a-z0-9]|{latin1}|{escape}
name {nmchar}+
The CSS1 "nmchar" rule does not include underscores ("_"), colons (":"),
or periods ("."), therefore "class" and "id" attributes should not contain
these characters. They should be replaced with hyphens ("-"). Combined
with HTML's requirements (the first character must be a letter; no
"unicode", "latin1", or "escape" characters), this results in the
``[a-z](-?[a-z0-9]+)*`` pattern.
.. _HTML 4.01 spec: http://www.w3.org/TR/html401
.. _CSS1 spec: http://www.w3.org/TR/REC-CSS1
ZNFKDrN �ignore�-rt rX )rq r0 r �decode� translate�_non_id_translate_digraphs�_non_id_translate� unicodedata� normalizer �
_non_id_chars�subrc �split�_non_id_at_ends)�stringr� r r r r
! s # !r
z
[^a-z0-9]+z ^[-0-9]+|-+$� �oi �di' �hi1 r� iB �lig �ti� �bi� i� r i� i� �fi� �ki� i� r~ i� r� i� i� i� �yi� �zi� �gi% i4 i5 i6 i7 �ji< i? rP i@ iG �eiI iK �qiM rC iO �� �sz�� ZaeiS Zoei8 Zdbi9 Zqpc C s/ | d j | � | d j | � d | _ d S)Nrk rj r> )r1 r� r� )r7 r� r r r r s r c C s d j | j � j � � S)z.Return a case- and whitespace-normalized name.rt )rc rq r� )r� r r r r/ � s r/ c C s d j | j � � S)z$Return a whitespace-normalized name.rt )rc r� )r� r r r r- � s r- c C s | j d d � j d d � S)zDEscape string values that are elements of a list, for serialization.�\z\\rt z\ )r� )rs r r r ru � s ru c C s d | S)z Quote attributes for pseudo-xmlz"%s"r )rs r r r r� � s r� )�rI Z
__docformat__rJ �os�rer� �typesr� �objectr rK r rL rQ rR rg r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r; r< r= r> r? r@ rA rB rC rD rE rF rG rH r rI rK rM rN rO rP rQ rR rS rT rU rV rW rX rY rZ r[ r\ r] r^ r_ r` ra rc rd re rf rg rh ri rj rk r rl rm rn ro rp r. rq rr rs rt ru rv rw rx r r" r* ry rz r{ r| r} r~ r r� r� r� r� r r2 r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� Znode_class_namesr� r� r� r� r� r� r� r� � Exceptionr� r% r* r& r' r� r+ r
�compiler� r� r� r� r r/ r- ru r� r r r r �<module> s� �
L� � �
� J
""" E
" ]
1