I dZdZddlmZddlZddlZddlZddlZGddZGdde Z d Z d[d Z Gd d ee Z Gd deZGddeZGddeZGddZGddZGddZGddZGddZGddZGdd eZGd!d"ZGd#d$ZGd%d&eZGd'd(eZGd)d*eZGd+d,eZGd-d.eZGd/d0ZGd1d2Z Gd3d4eZ!Gd5d6eZ"Gd7d8Z#Gd9d:eeeZ$Gd;deeeZ&Gd?d@eeZ'GdAdBeeZ(GdCdDeeZ)GdEdFeeZ*GdGdHeeZ+GdIdJeeZ,GdKdLeeZ-GdMdNeeZ.GdOdPeeZ/GdQdReeZ0GdSdTeeZ1GdUdVeeZ2GdWdXeeZ3GdYdZeeZ4Gd[d\eeZ5Gd]d^eeZ6Gd_d`eeZ7GdadbeeZ8GdcddeeZ9GdedfeeZ:GdgdheeZ;GdidjeeZ<GdkdleeZ=GdmdneeZ>GdodpeeZ?GdqdreeZ@GdsdteeZAGdudveeZBGdwdxeeZCGdydzeeZDGd{d|eeZEGd}d~eeZFGddeeZGGddeeZHGddeeZIGddeeZJGddeeZKGddeeZLGddeeZMGddeeZNGddeeZOGddeeZPGddeeZQGddeeZRGddeeZSGddeeZTGddeeZUGddeeZVGddeeZWGddeeZXGddeeZYGddeeZZGddeeZ[GddeeZ\GddeeZ]GddeeZ^GddeeZ_GddeeZ`GddeeZaGddeeeZbGddeeeZcGddeee ee"ZdGddeeee#e"ZeGddeeee#e"ZfGddeeZgGddeeZhGdÄdeeZiGdńdeeZjGdDŽdeeZkGdɄdeeZlGd˄deeZmGd̈́deeZnGdτdeeZoGdфdeeZpGdӄdeeZqGdՄdeeeeZrGdׄdeeeZsGdلdee eeZtGdۄde eZuGd݄de eZvGd߄de eZwGddee e!eZxGdde e!eZyGdde e!eZzGdde eZ{Gdde eZ|Gdde eZ}Gdde eZ~Gdde eZGdde eZGdde eZGddee eZGdde eZGdde eZGdde eZdj Z GddZGddeZGddeZdZdZdZdZeeGdd eZGd d eZGd d eZGddeZGddeZGddeZGddeZGddeZdZej2dZej2dZidddddd d!d"d#d$d%d&d'd(d)d(d*d+d,dd-d.d/d0d1d$d2d3d4d5d6d&d7d&id8d9d:d;d<d=d>d;d?d$d@d3dAd&dBdCdDd+dEdFdGd;dHdIdJdCdKdLdMdNdOd9ZdPdQdRdSdTdUZdVZdWZdXZdYZdZZy(\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: https://docutils.sourceforge.io/docs/ref/docutils.dtd reStructuredText)CounterNceZdZdZdZ dZ dZ dZedZ e jdZ dZ ddZ ddZ dZd Zd Zd Zd Zd ZdZdZ ddZ ddZ ddZy)Nodez0Abstract base class of nodes in a document tree.Ncj |jxs|jjS#t$rYywxYw)zJReturn the `document` root node of the tree containing this Node. N) _documentparentdocumentAttributeErrorselfs 3/usr/lib/python3.12/site-packages/docutils/nodes.pyr z Node.document6s2 >>9T[[%9%9 9  s #& 22c||_yN)r)r values rr z Node.document?s cy)a 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. Tr s r__bool__z Node.__bool__CsrcZ| ddlmcm}|j}|j |S)z6Return a DOM **fragment** representation of this Node.Nr)xml.dom.minidomdomminidomDocument _dom_noder rdomroots rasdomz Node.asdomMs' ; ) ),,.~~g&&rct)zs Return an indented pseudo-XML representation, for test purposes. Override in subclasses. NotImplementedError)r indentlevels rpformatz Node.pformatTs "!rct)zReturn a copy of self.r r s rcopyz Node.copy\!!rct)z3Return a deep copy of self (also copying children).r r s rdeepcopyz Node.deepcopy`r'rct)z,Return a string representation of this Node.r r s rastextz Node.astextdr'rc||_|jra|j|_|j|jj|_|j|jj |_yyyr)r r sourcecurrent_sourceline current_liner childs r setup_childzNode.setup_childhs[ ==!]]EN||##}};; zz!!]]77 " rcd}|jjjd|jjz |j ||j} |ddD]}|j|sd}n|S#t tf$r|cYSt$rYKwxYw#t$rY|SwxYw#t$rd}Y|SwxYw)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 reporterdebug __class____name__dispatch_visit SkipChildrenSkipNode SkipDeparturechildrenwalk SkipSiblings StopTraversal)r visitorstopr=r2s rr>z Node.walkqs.!!'' Dnn%% & '  &&t, }}H %a[Ezz'*#) !(+          D  s`B B1B!9B!BB1BB1BB1! B.*B1-B..B11 C?Cc0d}d}|jjjd|jjz |j ||j} |ddD]}|j|sd}n|rM|jjjd|jjz|j||S#t $r|cYSt$rd}YwxYw#t$rYywxYw#t$rYt$rd}YwxYw)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 r5r6r7r8r9r;r<r= walkaboutr?r:r@dispatch_departure)r rA call_departrBr=r2s rrDzNode.walkabouts& !!'' Inn%% & '  $&&t, }}H %a[Ew/#)     % % + +>>223 4  & &t , +    $#  $      D sfC C=!C.;C. C+C= C+(C=*C++C=. C:7C=9C::C== D DDc#Kt||r||jD]}|j|Ed{y7w)z3Return iterator that only supports instance checks.N) isinstancer= _fast_findall)r clsr2s rrIzNode._fast_findalls: dC J]]E**3/ / /# /s4A>Ac#jK||jD]}|jEd{y7w)z3Return iterator that doesn't check for a condition.N)r=_superfast_findallr1s rrLzNode._superfast_findalls0  ]]E//1 1 1# 1s '313c vtjdtdt|j |||||S)zyReturn list of nodes following `self`. For looping, Node.findall() is faster and more memory efficient. z5nodes.Node.traverse() is obsoleted by Node.findall(). stacklevel)warningswarnPendingDeprecationWarninglistfindallr condition include_selfdescendsiblingsascends rtraversez Node.traverses;  M/A ?DLLL'!)634 4rc#K|rd}|rI|rG|sE||jEd{yt|tr|j|Ed{yt|tr|}|fd}|r|||r||r:t |j r%|D] }|j |ddddEd{"|s|r|}|jr|jj|} |j| |ur1|jj|| dz} |j| |ur1|j| dzdD] } | j |d|ddEd{"|sy|j}|jryyy7V7/77-w)a Return an iterator yielding nodes following `self`: * self (if `include_self` is true) * all descendants in tree traversal order (if `descend` is true) * the following siblings (if `siblings` is true) and their descendants (if also `descend` is true) * the following 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 iterator yields 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. If the tree structure is modified during iteration, the result is undefined. For example, given the following tree:: <--- emphasis.traverse() and <--- strong.traverse() are called. Foo Bar Baz Then tuple(emphasis.traverse()) equals :: (, , <#text: Foo>, <#text: Bar>) and list(strong.traverse(ascend=True) equals :: [, <#text: Foo>, <#text: Bar>, , <#text: Baz>] TNct||Sr)rH)node node_classs rrWzNode.findall..conditions!$ 33rF)rWrXrYrZr[) rLrHtyperIlenr=rUr index) r rWrXrYrZr[r`r2r_rdsiblings rrUz Node.findallsP H GH 22444It,--i888 i &"J+5 4 Y.)D/J s4==) ==96:D27)GGG vD++ ))$/kk%(4 KK--dEAI>Ekk%(4#{{5784G&"+%)7!&u / 666 5 ;;D++)59G6sS FE8)F E; A!F.E>/A4F$.FF!F5F;F>FFc ^ t|j|||||S#t$rYywxYw)z Return the first node in the iterator returned by findall(), or None if the iterable is empty. Parameter list is the same as of traverse. Note that `include_self` defaults to False, though. N)nextrU StopIterationrVs r next_nodezNode.next_node9s?  Y %,h@A A  s  ,,r r)NTTFF)NFTFF)r8 __module__ __qualname____doc__r r-r/rpropertyr setterrrr$r&r)r+r3r>rDrIrLr\rUrirrrrr(s: FF FL DNI __'""""8,\)V02CG(- 4BF',Q'fEI). rrc"eZdZdZfdZxZS) reprunicodezR Deprecated backwards compatibility stub. Use the standard `str` instead. cZtjdtdt|y)Nz`nodes.reprunicode() is not required with Python 3 and will be removed in Docutils 0.21 or later.rNrO)rQrRDeprecationWarningsuper__init__)r sr7s rrvzreprunicode.__init__Ms' H(Q 8 r)r8rlrmrnrv __classcell__)r7s@rrrrrIsrrrc>tjdtd|S)z@ Deprecated backwards compatibility stub returning `s`. z_nodes.ensure_str() is not required with Python 3 and will be removed in Docutils 0.21 or later.rNrO)rQrRrt)rws r ensure_strrzTs" MMD$4 Hrc||r|jddSdD]"}dj|j|}$|S)zw Return a string with nulls removed or restored to backslashes. Backslash-escaped spaces are also removed. \)z z r|)replacejoinsplit)textrestore_backslashesrespect_whitespaceseps runescaper_s= ||FD)).C774::c?+D/ rc`eZdZdZdZdZ ddZddZdZdZ d Z d Z d Z dd Z dd ZddZy)Texta Instances are terminal nodes (leaves) containing text only; no child nodes or attributes. Initialize by passing a string to the constructor. Access the raw (null-escaped) text with ``str()`` and unescaped text with ``.astext()``. z#textrNct|tr td|tjdt dt j||S)zuAssert that `data` is not an array of bytes and warn if the deprecated `rawsource` argument is used. zexpecting str data, not bytesz_nodes.Text: initialization argument "rawsource" is ignored and will be removed in Docutils 2.0.rNrO)rHbytes TypeErrorrQrRrtstr__new__)rJdata rawsources rrz Text.__new__|sJ dE ";< <  MML, <{{3%%rcp|}t||kDr |d|dz dz}d|jdt|dS)N ...<: >)rctagnamer)r maxlenrs r shortreprzText.shortreprs; t9v  ?V+D!\\3t955rc&|jdS)ND)r)rr s r__repr__z Text.__repr__s~~R~((rc6|jt|Sr)createTextNoder)r rs rrzText._dom_nodes%%c$i00rc*tt|Sr)rrr s rr+z Text.astexts8D>""rc6|jt|Sr)r7rr s rr&z Text.copys~~c$i((rc"|jSr)r&r s rr)z Text.deepcopysyy{rc~ |jjjr<zd}fd|jdD}dj |g|dzS z|j jDcgc]}|z }}|sydj |dzS#t $rYUwxYwcc}w)Nz<#text>c3FK|]}dzzt|zywraN)repr.0r/r"r#s r zText.pformat..s+<%:T q)DJ6%:s!T r~)r settingsdetailed splitlinesrr r+)r r"r#taglinesr/s `` rr$z Text.pformats }}%%.. &u i8<%)__T%:<yy#/$66 /%)-)A)A)CD)C)CDyy$&&    EsAB+ B:+ B76B7cL|jtj||Sr)r7rrstripr charss rrz Text.rstrip~~cjju566rcL|jtj||Sr)r7rlstriprs rrz Text.lstriprrr)rj)r8rlrmrnrr=rrrrr+r&r)r$rrrrrrrmsHGH@ &6 )1#) '&77rrc,eZdZdZdZ dZ eezZ edzZ dZ dZ dCdZ dZ d Z d Z d ZdDd Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdDdZdZdZdDdZ eZ!dCdZ"dZ#d Z$d!Z%dEd"Z&d#Z'd$e(jRfd%Z*d&Z+d'Z,d(Z-d)Z.d*Z/dFd,Z0dFd-Z1d.Z2d/Z3d0Z4e4d+d1fd2Z5 dGd3Z6 dGd4Z7 dGd5Z8dHd6Z9d7Z:d8Z;d9ZdId<Z?d=Z@d>ZAd?ZBdJd@ZCeDdAZEeDdBZFy)KElementaV `Element` is the superclass to all specific elements. Elements contain attributes and child nodes. They can be described as a cross between a list and a dictionary. Elements emulate dictionaries for external [#]_ attributes, indexing by attribute name (a string). To set the attribute 'att' to 'value', do:: element['att'] = 'value' .. [#] External attributes correspond to the XML element attributes. From its `Node` superclass, Element also inherits "internal" class attributes that are accessed using the standard syntax, e.g. ``element.parent``. There are two special attributes: 'ids' and 'names'. Both are lists of unique identifiers: 'ids' conform to the regular expression ``[a-z](-?[a-z0-9]+)*`` (see the make_id() function for rationale and details). 'names' serve as user-friendly interfaces to IDs; they are case- and whitespace-normalized (see the fully_normalize_name() function). Elements emulate lists for child nodes (element nodes and/or text nodes), indexing by integer. To get the first child node, use:: element[0] to iterate over the child nodes (without descending), use:: for child in element: ... 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])``. )idsclassesnamesdupnames)backrefs)r-Nz c||_ g|_ |j|i|_ |jD]}g|j|<|j D]E\}}|j }||jvr|dd|j|<7||j|<G|j|jj|_yyr) rr=extend attributeslist_attributesitemslowerrr7r8)r rr=rattrs rrvzElement.__init__s"  ; H4''C#%DOOC (%**,JC))+Cd***',Qx$',$ - << >>22DL rcH|j|j}|jD]B\}}t|trdj d|D}|j |d|zD|jD]"}|j|j|$|S)N c34K|]}t|ywr) serial_escape)rvs rrz$Element._dom_node..#s KUq!;Usz%s) createElementrattlistrHrTr setAttributer= appendChildr)r relement attributerr2s rrzElement._dom_nodes'' 5 $  Iu%& KU KK  D5L 9!/]]E    8 9#rc&d}|jD]-}||jz }t|dkDs%|dddz}n|dr2d|jjddj |dd |d Sd|jjd |d S) Nr~<8rrr "; z": rr)r=rrcr7r8r)r rcs rrzElement.__repr__)sA AKKM !D4y2~CRy6)  =&*nn&=&=&*iiW &>F F "&!8!8$? ?rc|dr/d|jjddj|ddSd|jzS)Nrrrrz"...>z<%s...>)r7r8rrr s rrzElement.shortrepr6sA =%)^^%<%<%)YYtG}%=? ?t||+ +rc|jrD|jdjd|jD|jS|j S)Nr~c32K|]}t|ywr)r)rrs rrz"Element.__str__..@s&E}!s1v})r=starttagrendtagemptytagr s r__str__zElement.__str__=sI ==#}}!ww&Et}}&EE#{{}. .==? "rc|t}|jg}|jD]\}}||jd|zt |t r+|Dcgc]}t |}}dj|}n t|}||}|j|d|ddj|zScc}w)Nz %s="True"r=z<%s>) pseudo_quoteattrrrappendrHrTrrr)r quoteattrpartsnamerrvaluess rrzElement.starttagEs  (I<<>KD%} [4/0%&>CDe-4eD(E e$E LLD%0 1*'' EsB=c d|jzS)Nz)rr s rrzElement.endtagWs%%rctd|jD}ddj|jg|zS)Nc32K|]\}}|d|dyw)z=""Nr)rnrs rrz#Element.emptytag..[sD^TQ1a(^rz<%s/>r)rrr)r rs rrzElement.emptytagZs2DT\\^D 4<<"=*"=>>>rc,t|jSr)rcr=r s r__len__zElement.__len__^s4==!!rcZt|tr||jvS||jvSr)rHrrr=r keys r __contains__zElement.__contains__as* c3 $//) )dmm##rc$t|tr|j|St|tr|j|St|t r8|j dvsJd|j|j|jStdNNracannot handle slice with stridezFelement index must be an integer, a slice, or an attribute name string rHrrintr=slicestepstartrBrrs r __getitem__zElement.__getitem__gs c3 ??3' ' S !==% % U #88y( K*K K(==3884 478 8rct|tr||jt|<yt|tr!|j |||j |<yt|t rQ|jdvsJd|D]}|j |||j |j|jytdr) rHrrrr3r=rrrrBr)r ritemr_s r __setitem__zElement.__setitem__ss c3 (,DOOCH % S !   T "!%DMM#  U #88y( K*K K(  &04DMM#))CHH -78 8rc"t|tr|j|=yt|tr|j|=yt|t r9|j dvsJd|j|j|j=ytd)NrrzMelement index must be an integer, a simple slice, or an attribute name stringrrs r __delitem__zElement.__delitem__s~ c3 $ S ! c" U #88y( K*K K( cii01AB Brc |j|zSrr=r others r__add__zElement.__add__s}}u$$rc ||jzSrrrs r__radd__zElement.__radd__st}}$$rcrt|tr|j||S||j||S)z4Append a node or a list of nodes to `self.children`.)rHrrrrs r__iadd__zElement.__iadd__s8 eT " KK    KK  rc|jj|jDcgc]}|jc}Scc}wr)child_text_separatorrr=r+r1s rr+zElement.astexts<((--04 > uELLN >@ @>sAc|i}|jjD]\}}|j|s|||<|Sr)rris_not_default)r attsrrs rnon_default_attributeszElement.non_default_attributess@////1JC""3'!S 2 rcPt|jjSr)sortedr rr s rrzElement.attlistsd11399;< &  ( (u 5 'rc|j||urVt|j|tst|tr|j||y|j |||yy)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)rrHrTr;r?rAs rcopy_attr_coercezElement.copy_attr_coerce(sW 88D> &$((4.$/%&,,T59!!$w7 'rc|j||urVt|j|tr#t|tr|j||y|j |||yy)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)rrHrTr6r?rAs rcopy_attr_concatenatezElement.copy_attr_concatenate8sW 88D> &$((4.$/%&%%dE2!!$w7 'rcR|j||ur|j|||yy)zz If replace is True or self[attr] is None, replace self[attr] with value. Otherwise, do nothing. N)rr?rAs rcopy_attr_consistentzElement.copy_attr_consistentGs+ 88D> &   dE7 3 'rFct|tr |j}|r |j}n |j}|j |t ||D]}||||||y)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)rHrris_not_list_attributeis_not_known_attributer8filter)r r7 update_funr and_source filter_funrs rupdate_all_attszElement.update_all_attsOsi* eT "$$E 33J44J u%*e,C tS%*g 6-rcH|j|tj||y)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)rPrrHr r7rrNs rupdate_all_atts_consistantlyz$Element.update_all_atts_consistantlyus!$ UG$@$@'' )rcH|j|tj||y)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)rPrrFrRs rupdate_all_atts_concatenatingz%Element.update_all_atts_concatenatings!* UG$A$A7' )rcH|j|tj||y)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)rPrrDrRs rupdate_all_atts_coercionz Element.update_all_atts_coercions!, UG$<$> B  B ct|ts|f}t|tt ||D]}|D]}t|||s|ccS y)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)rHtuplerangeminrcr childclassrendrdrs rfirst_child_matching_classz"Element.first_child_matching_classsS*e,$J5#c$i"56Ed5k1- L 7rct|ts|f}t|tt ||D]'}|D]}t|j ||s$|cSy)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)rHrdrerfrcr=rgs rfirst_child_not_matching_classz&Element.first_child_not_matching_classs]*e,$J5#c$i"56EdmmE2A6  7 rcz|jd}fd|jD}dj|g|S)Nrc3HK|]}|jdzywr)r$)rrr"r#s rrz"Element.pformat..s!GAQYYvuQw/s"r~)rr=r)r r"r#tagline childrepss `` rr$zElement.pformats<$UlDMMO<GG ww,),--rc|jdd|ji|j}|j|_|j|_|j |_|S)Nrr)r7rrrr-r/r objs rr&z Element.copy sHdnnIt~~II [[ 99 rc|j}|j|jDcgc]}|jc}|Scc}wr)r&rr=r))r r&r2s rr)zElement.deepcopy's>yy{ 4==A=%U^^%=AB BsA ctjdtdd|vsJ|dj|j y)z+Add a new class to the "classes" attribute.zdocutils.nodes.Element.set_class() is deprecated; and will be removed in Docutils 0.21 or later.Append to Element['classes'] list attribute directlyrNrOrrN)rQrRrtrrr rs r set_classzElement.set_class,sA M)Q 8$ Ytzz|,rcd|_t|dij|}t|dij|}|r |Jd|_|r |Jd|_yy)zQNote that this Element has been referenced by its name `name` or id `id`.raexpect_referenced_by_nameexpect_referenced_by_idN) referencedgetattrr)r ridby_nameby_ids rnote_referenced_byzElement.note_referenced_by5sr $ ;R@DDTJ7<@@D # ##!"G  > !> E  rc||jvS)z Returns True if and only if the given attribute is NOT one of the basic list attributes defined for all Elements. r3rJrs rrJzElement.is_not_list_attributeFs 3....rc||jvS)zj Returns True if and only if the given attribute is NOT recognized by this class. )known_attributesrs rrKzElement.is_not_known_attributeNs 3////r)r~r))T)TF)FrjNN)Gr8rlrmrnr5local_attributesrrrr rvrrrrrrrrrrrrrrrr+r rrrrrhas_keyr"rrr(r*r.sysmaxsizerdr1r r8r6r;r?rBrDrFrHrPrSrUrWrYr[rrbrjrlr$r&r)rwr classmethodrJrKrrrrrs-^?C%K ')99O'4GG+"?3< @,#($&?"$ 8 8 B%%@=1'&8G #%$#!" 63 ; ) + 68 841E $$7L;?05)*<@16)07;,1)24*&',<=#++&@A+.;;,.  -!"//00rrceZdZdZdZ ddZy) 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. r~c|dk7r't|}tj|||g|i|ytj||g|i|yNr~)rrrv)r rrr=rtextnodes rrvzTextElement.__init__isQ 2:DzH   T9h + +) +   T9 Fx F: FrNr~r~)r8rlrmrnr rvrrrrrWs ?GrrceZdZdZddZy)FixedTextElementz5An element which directly contains preformatted text.cXtj|||g|i|d|jd<y)Npreservez xml:space)rrvr)r rrr=rs rrvzFixedTextElement.__init__vs,T9dLXLL'1 $rNr)r8rlrmrnrvrrrrrrs ?2rrceZdZdZy) ResolvablerN)r8rlrmresolvedrrrrrsHrrceZdZdZy) BackLinkablec,|dj|y)Nrr&)r refids r add_backrefzBackLinkable.add_backrefs Z&rN)r8rlrmrrrrrrs'rrc eZdZy)RootNr8rlrmrrrrrrrc eZdZy)TitularNrrrrrrrrrceZdZdZy)PreBibliographicz2237c"^3??3'(.s (8)A+24<<+@)ABF'1,'vtv'>??TXX%  U 2  rct|dD]D}||jvr|j|||||'||j|<||j|<Fy)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` items ("id") and `self.nametypes` items ("type") 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 ----------- -------- ----------------- ----------- ----- id type new type sys.msg. dupname id type ==== ===== ======== ======== ======= ==== ===== ===== - - explicit - - new True - - implicit - - new False - False explicit - - new True old False explicit implicit old new True - True explicit explicit new - True old True explicit explicit new,old - True [#]_ - False implicit implicit new - False old False implicit implicit new,old - False - True implicit implicit new - 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. rN)rdrset_duplicate_name_idr)r r_r}rexplicitrs rset_name_id_mapzdocument.set_name_id_map}sXB$w-(Dt||#**4T7HM&( T"'/t$ )rc|j|}|j|}|xs||j|<|r|rd}|K|j|} d|vr|d} | drd| vr | d| k(rd}|dkDrt| |d|j|<|jj |d|z|g|} ||| z }t||ng||j|<|V|j|} t| |n:|,|s*d|j|<|j|} t| |t|||r|s.|+|jj d|z|g|} ||| z }yyyy)NrNrefurirraz%Duplicate explicit target name: "%s".)r base_nodez%Duplicate implicit target name: "%s".)rrrdupnamer5system_messageinfo) r r_r}rrrold_id old_explicitr#old_noderrs rrzdocument.set_duplicate_name_idsd#~~d+ +7xt %#xx/H4'!%h$W- (H 4 ( 2f <$%Eqy$/-1 T*mm22BTI TT33&sNGd#%' T"%#xx/HHd+!,%) T"88F+$' D$  1C--$$7$>%/C"3# 2D rc||jvSr)rrvs rhas_namezdocument.has_namest||##rcR|j||}|j|||dy)NFrrrr targetrr}s rnote_implicit_targetzdocument.note_implicit_targets) [[ ) VR5ArcR|j||}|j|||dy)NTrr r s rnote_explicit_targetzdocument.note_explicit_targets) [[ ) VR4@rc`|jj|dgj|yNrefname)rrrr r_s r note_refnamezdocument.note_refnames%   i"5<rch|jj||dr|j|yy)Nr)rrrr r s rnote_indirect_targetzdocument.note_indirect_targets0 $$V, '?   f % rc&|j|yr)rrs rnote_anonymous_targetzdocument.note_anonymous_targets Frc\|j||jj|yr)rrrr footnotes rnote_autofootnotezdocument.note_autofootnotes" H !!(+rc\|j||jj|yr)rrrr refs rnote_autofootnote_refzdocument.note_autofootnote_refs" C %%c*rc\|j||jj|yr)rrrrs rnote_symbol_footnotezdocument.note_symbol_footnotes" H $$X.rc\|j||jj|yr)rrrr s rnote_symbol_footnote_refz!document.note_symbol_footnote_refs" C !!((-rc\|j||jj|yr)rrrrs r note_footnotezdocument.note_footnotes  H h'rc|j||jj|dgj||j |yr)rrrrrr s rnote_footnote_refzdocument.note_footnote_refA C %%c)nb9@@E #rc:|jj|yr)rr)r citations r note_citationzdocument.note_citations h'rc|j||jj|dgj||j |yr)rrrrrr s rnote_citation_refzdocument.note_citation_refr+rct|}||jvrB|jjd|z|}|||z }|j|}t ||||j|<||j t |<y)Nz-Duplicate substitution definition name: "%s".)r)whitespace_normalize_namerr5errorrrfully_normalize_name)r subdefdef_namerrroldnodes rnote_substitution_defzdocument.note_substitution_def s(2 4)) )--%%EL &&(C"3,,T2G GT "'-t$>B 4T :;rc t||d<yr)r2)r subrefrs rnote_substitution_refzdocument.note_substitution_refs5g>yrc<|jj||yr)r add_pending)r pendingprioritys r note_pendingzdocument.note_pendings $$Wh7rc:|jj|yr)rrr messages rnote_parse_messagezdocument.note_parse_message s ""7+rc:|jj|yr)rrrBs rnote_transform_messagezdocument.note_transform_message#s &&w/rc:||_|||_y|dz|_yr)r.r0)r r-offsets r note_sourcezdocument.note_source&s#$ > &D  & D rc|j|j|jfi|j}|j|_|j |_|Sr)r7rr5rr-r/rrs rr&z document.copy-sEdnnT]]DMM0#0[[ 99 rc|jsot|_|jttf}|'|j |j|jS|j ||j|jSr)rrlrmetarr()r rds rget_decorationzdocument.get_decoration4se(lDO77$HE} DOO, E4??3rrrr)!r8rlrmrnrvrrrrrrr rrrrrrr"r$r&r(r*r.r0r8r;r@rDrFrIr&rMrrrr r sZx+Z'0R(T$BAC?& ,+/.( ( C?8,0+rr c eZdZy)titleNrrrrrOrOCrrrOc eZdZy)subtitleNrrrrrQrQDrrrQc eZdZy)rubricNrrrrrSrSErrrSceZdZdZy)rLz;Container for "invisible" bibliographic data, or meta-data.NrrrrrLrLLsErrLc eZdZy)docinfoNrrrrrVrVTrrrVc eZdZy)authorNrrrrrXrXUrrrXc eZdZy)authorsNrrrrrZrZVrrrZc eZdZy) organizationNrrrrr\r\Wrrr\c eZdZy)addressNrrrrr^r^Xrrr^c eZdZy)contactNrrrrr`r`Yrrr`c eZdZy)versionNrrrrrbrbZrrrbc eZdZy)revisionNrrrrrdrd[rrrdc eZdZy)statusNrrrrrfrf\rrrfc eZdZy)dateNrrrrrhrh]rrrhc eZdZy) copyrightNrrrrrjrj^rrrjceZdZdZdZy)rct|jrt|jdts|j dt|jdSNr)rcr=rHheaderr(r s r get_headerzdecoration.get_headergs?4==!DMM!4Df)M KK68 $}}Qrct|jrt|jdts|j t|jdS)Nr)rcr=rHfooterrr s r get_footerzdecoration.get_footerls=4==!DMM"4Ev)N KK !}}R  rN)r8rlrmrorrrrrrres  !rrc eZdZy)rnNrrrrrnrnrrrrnc eZdZy)rqNrrrrrqrqsrrrqc eZdZy)sectionNrrrrrvrvzrrrvceZdZdZy)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. Nrrrrrxrx}s rrxceZdZdZy)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. Nrrrrrzrzs rrzc eZdZy) transitionNrrrrr|r|rrr|c eZdZy) paragraphNrrrrr~r~rrr~c eZdZy)compoundNrrrrrrrrrc eZdZy) containerNrrrrrrrrrc eZdZy) bullet_listNrrrrrrrrrc eZdZy)enumerated_listNrrrrrrrrrc eZdZy) list_itemNrrrrrrrrrc eZdZy)definition_listNrrrrrrrrrc eZdZy)definition_list_itemNrrrrrrrrrc eZdZy)termNrrrrrrrrrc eZdZy) classifierNrrrrrrrrrc eZdZy) definitionNrrrrrrrrrc eZdZy) field_listNrrrrrrrrrc eZdZy)fieldNrrrrrrrrrc eZdZy) field_nameNrrrrrrrrrc eZdZy) field_bodyNrrrrrrrrrceZdZdZy)optionr~Nr8rlrmr rrrrrsrrceZdZdZy)option_argumentcR|jddtj|zS)N delimiterr)rrr+r s rr+zoption_argument.astexts#xx S)K,>,>t,DDDrNr8rlrmr+rrrrrsErrceZdZdZy) option_groupz, Nrrrrrrrrc eZdZy) option_listNrrrrrrrrrceZdZdZy)option_list_itemz Nrrrrrrrrrc eZdZy) option_stringNrrrrrrrrrc eZdZy) descriptionNrrrrrrrrrc eZdZy) literal_blockNrrrrrrrrrc eZdZy) doctest_blockNrrrrrrrrrc eZdZy) math_blockNrrrrrrrrrc eZdZy) line_blockNrrrrrrrrrceZdZdZy)r/N)r8rlrmr"rrrr/r/s Frr/c eZdZy) block_quoteNrrrrrrrrrc eZdZy) attributionNrrrrrrrrrc eZdZy) attentionNrrrrrrrrrc eZdZy)cautionNrrrrrrrrrc eZdZy)dangerNrrrrrrrrrc eZdZy)r3Nrrrrr3r3rrr3c eZdZy) importantNrrrrrrrrrc eZdZy)noteNrrrrrrrrrc eZdZy)tipNrrrrrrrrrc eZdZy)hintNrrrrrrrrrc eZdZy)warningNrrrrrrrrrc eZdZy) admonitionNrrrrrrrrrc eZdZy)commentNrrrrrrrrrc eZdZy)substitution_definitionNrrrrrrrrrc eZdZy)r Nrrrrr r rrr c eZdZy)rNrrrrrrrrrc eZdZy)r-Nrrrrr-r-rrr-c eZdZy)labelNrrrrrrrrrc eZdZy)figureNrrrrrrrrrc eZdZy)captionNrrrrrrrrrc eZdZy)legendNrrrrrrrrrc eZdZy)tableNrrrrrrrrrc eZdZy)tgroupNrrrrrrrrrc eZdZy)colspecNrrrrrrrrrc eZdZy)theadNrrrrrrrrrc eZdZy)tbodyNrrrrrrrrrc eZdZy)rowNrrrrrrrrrc eZdZy)entryNrrrrrrrrrceZdZdZddZdZy)rz System message element. Do not instantiate this class directly; use ``document.reporter.info/warning/error/severe()`` instead. Nc|jdd}|rtd|}|f|z} tj||g|i|y#t d|xYw)Nrr~zsystem_message: children=)r*r~rrvprint)r rCr=rrps rrvzsystem_message.__init__s`NN;3 "g&AthH    T9 Fx F: F  8= > s AAc ~|jdd}|dd|d|dd|dd tj| S) Nr/r~r-:z: (rb/r#z) )rrr+)r r/s rr+zsystem_message.astext s?xx#&*8ndDL&*7mW^^D5IK Krr)r8rlrmrnrvr+rrrrrs Krrc*eZdZdZ ddZddZdZy)r>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:: + internal attributes Use `document.note_pending()` so that the `docutils.transforms.Transformer` stage of processing can run all pending transforms. Nc^tj||g|i|||_ |xsi|_yr)rrv transformdetails)r rrrr=rs rrvzpending.__init__-s8yB8BzB" }" Irc Ndd|jjd|jjdg}t|jj }|D] \}}t |trX|jdd|d|j|jjDcgc] }dd| c}o|rt |trrt |d tr_|jdd|d|D]B}|j|jjDcgc] }dd| c}D|jdd|d |tj|djfd |DzScc}wcc}w) Nz.. internal attributes:z .transform: .z .details:r~z>7rz>9rrc34K|]}dz|dyw)rkrNrrs rrz"pending.pformat..Ms"1&/d,2E>4@&/s)rrlr8rrrrHrrrr$rrTrr) r r"r# internalsrrrr/rs `` rr$zpending.pformat8s.151J1J151H1HJ%' ++-.!JC%&  R!56  .3mmo.H.H.J"L.Jd.0"6.J"LM - q40  R!56A$$23))+2H2H2J&L2J$24T&:2J&LM  C!?@"fe4''1&/111 2"L&Ls 4F 6F" c|j|j|j|jfi|j}|j |_|j |_|j|_|Sr)r7rrrrrr-r/rrs rr&z pending.copyPsVdnnT^^T\\4>>0#0 [[ 99 rrrj)r8rlrmrnrvr$r&rrrr>r>s4+/ J20rr>ceZdZdZy)rawz@ Raw data that is to be passed untouched to the Writer. NrrrrrrYsrrc eZdZy)emphasisNrrrrrrdrrrc eZdZy)strongNrrrrrrerrrc eZdZy)literalNrrrrrrfrrrc eZdZy) referenceNrrrrrrgrrrc eZdZy)footnote_referenceNrrrrrrhrrrc eZdZy)citation_referenceNrrrrrrirrrc eZdZy)substitution_referenceNrrrrr r jrrr c eZdZy)title_referenceNrrrrr r krrr c eZdZy) abbreviationNrrrrrrlrrrc eZdZy)acronymNrrrrrrmrrrc eZdZy) superscriptNrrrrrrnrrrc eZdZy) subscriptNrrrrrrorrrc eZdZy)mathNrrrrrrprrrceZdZdZy)imagec&|jddS)Naltr~r=r s rr+z image.astextusxxr""rNrrrrrrss#rrc eZdZy)inlineNrrrrrryrrrc eZdZy) problematicNrrrrrrzrrrc eZdZy) generatedNrrrrr r {rrr aA 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 meta 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 warningc4eZdZdZdZ dZdZdZdZdZ y) 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 must be implemented for *all* compulsory node types encountered (such as for `docutils.writers.Writer` subclasses). Unimplemented methods will raise exceptions (except for optional nodes). For sparse traversals, where only certain node types are of interest, use 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. )rLc||_yr)r r r s rrvzNodeVisitor.__init__s   rc|jj}t|d|z|j}|jj j d|jd|||S)z Call self."``visit_`` + node class name" with `node` as parameter. If the ``visit_...`` method does not exist, call self.unknown_visit. visit_z2docutils.nodes.NodeVisitor.dispatch_visit calling  for )r7r8r| unknown_visitr r5r6r r_ node_namemethods rr9zNodeVisitor.dispatch_visits^ NN++ x)3T5G5GH $$  + ,d|rc|jj}t|d|z|j}|jj j d|jd|||S)z Call self."``depart_`` + node class name" with `node` as parameter. If the ``depart_...`` method does not exist, call self.unknown_departure. depart_z6docutils.nodes.NodeVisitor.dispatch_departure calling r')r7r8r|unknown_departurer r5r6r)s rrEzNodeVisitor.dispatch_departures^ NN++ y94d6L6LM $$  + ,d|rc|jjjs"|jj|j vr.t |jd|jjy)zk Called when entering unknown `Node` types. Raise an exception unless overridden. z visiting unknown node type: Nr rstrict_visitorr7r8optionalr!rs rr(zNodeVisitor.unknown_visitW MM " " 1 1~~&&dmm;%>>4>>#:#:<= =))+ 7#   - rcB|jj|_y)z#Restore the previous acting parent.N)rKr*r rs rr=z!TreeCopyVisitor.default_departurePs''++- rN)r8rlrmrnrvrMr;r=rrrrIrI;s .rrIceZdZdZy)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. NrrrrrRrRUrrRceZdZdZy)r:z Do not visit any children of the current node. The current node's siblings and ``depart_...`` method are not affected. Nrrrrr:r:`rr:ceZdZdZy)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. Nrrrrr?r?hrUrr?ceZdZdZy)r;zq Do not visit the current node's children, and do not call the current node's ``depart_...`` method. Nrrrrr;r;prUrr;ceZdZdZy)r<z Do not call the current node's ``depart_...`` method. The current node's children and siblings are not affected. Nrrrrr<r<xrUrr<ceZdZdZy) 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. NrrrrrZrZsrrZceZdZdZy)r@a< Stop the traversal altogether. 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. Nrrrrr@r@rSrr@c|j}|jt}|jt}t j d|j ddjd}tjddj|j}tjd|}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: https://www.w3.org/TR/html401 .. _CSS1 spec: https://www.w3.org/TR/REC-CSS1 NFKDasciiignorerrr~)r translate_non_id_translate_digraphs_non_id_translate unicodedata normalizeencodedecode _non_id_charssubrr_non_id_at_endsr)stringr}s rrrsF B 0 1B ' (B    B w1&&/   3 4 5B   R $B r7Nrz [^a-z0-9]+z ^[-0-9]+|-+$oidi'hi1r,iBligtibiiriifikiiririiiyizigi%i4i5i6i7ji<i?rwi@iGeiIiKqiMriOszaeoedbqp)iSi8i9cb|dj||dj|d|_y)Nrrra)rr.r{)r_rs rrrs0D!MDOrc\dj|jjS)z.Return a case- and whitespace-normalized name.r)rrrrs rr4r4s 88DJJL&&( ))rc@dj|jS)z$Return a whitespace-normalized name.r)rrrs rr2r2s 88DJJL !!rcF|jddjddS)zDEscape string values that are elements of a list, for serialization.r}z\\rz\ )rrs rrr s ==u % - -c5 99rc d|zS)zQuote attributes for pseudo-xmlz"%s"rrs rrr s E>r)FF)rn __docformat__ collectionsrrerrQrcrrrrrzrrrrrrrrrrrrrrrrrrrrrrrrr rOrQrSrLrVrXrZr\r^r`rbrdrfrhrjrrnrqrvrxrzr|r~rrrrrrrrrrrrrrrrrrrrrrrrrr/rrrrrr3rrrrrrrrr rr-rrrrrrrrrrrrr>rrrrrrrr r rrrrrrrrr rnode_class_namesr"r6r8r?rArCrGrI ExceptionrRr:r?r;r<rZr@rcompilergrirbrarr4r2rrrrrrsh "#  ^^B #  G74G7T] 0d] 0@G'G62{2 ''    GG   !      d *d*9 9     * 1133btZbR :G%{9