/usr/lib/python3/dist-packages/twisted/words/xish/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/words/xish/__pycache__/domish.cpython-310.pyc (25121B)
o
bs @ s d Z ddlmZ ddlmZmZmZ ddlmZ dd Z ddiZ
G d d
d
Z e Z d&d d Z
d
d Zdd Zdd Zdd ZG dd deZG dd dZG dd deZeeG dd d ZG d d d eZd d ZG d!d" d"ejZG d#d$ d$Z d%S )'z
DOM-like XML processing support.
This module provides support for parsing XML into DOM-like object structures
and serializing such structures to an XML string representation, optimized
for use in streaming XML applications.
)cast) Attribute Interface implementer)suxc C s( | dd}t|dkr|S d|d fS )zSInternal method for splitting a prefixed Element name into its
respective parts: Nr )splitlen)namentok r ;/usr/lib/python3/dist-packages/twisted/words/xish/domish.py _splitPrefix s r z$http://www.w3.org/XML/1998/namespacexmlc @ s< e Zd ZdZdddZdd Zdd Zd d
Zdd
dZdS )_ListSerializerz=Internal class which serializes an Element tree into a bufferNc C sF g | _ i | _|r| j| | jt t g|pg | _d| _d S Nr ) writelistprefixesupdate
G_PREFIXESvalues prefixStack
prefixCounter)selfr prefixesInScoper r r __init__' s
z_ListSerializer.__init__c C s d | jS )N )joinr r r r r getValue0 s z_ListSerializer.getValuec C s0 || j vrd| j | j |< | jd | _| j | S )Nzxn%dr )r r r urir r r getPrefix3 s
z_ListSerializer.getPrefixc C s< | j }tdt| j d d dD ] }||| v r dS qdS )Nr TFr ranger r prefixstackir r r
prefixInScope9 s z _ListSerializer.prefixInScoper r c
C s | j j}t|tr|| d S t|tr |t| d S |j}|j}|j|}}|j
D ] \}} || j | < q-| j t
|j |d u rH|}|d u rN|}d }
||ksY|| j v rc| |}
| |
} |
sl|d| n!|d|
d| | s|d|
d| d | j d |
d} ||kr||ks|
r| s|d | |j
D ]\}} |d| d| d q|j
D ]J\} }
t| tr| \}}| |}| |s|d| d| d | j d | |d
| d| dt|
d d q|d
| dt|
d d q|d kr|d
d S t|jd kr?|d
|jD ]
}| j||d q |
s3|d| n|d|
d| d
n|d | j d S )Nz<%s
)
defaultUrizz)r append
isinstance
SerializedXMLstr escapeToXmlr r# r1
localPrefixesitemsr r listkeysr$ r,
attributestupler children serializepop)r elem closeElementr1 writer r# currentDefaultUripur) inScopekvattr_uri attr_name attr_prefixcr r r r> @ sl
$
z_ListSerializer.serializeNN)r r ) __name__
__module__ __qualname____doc__r r! r$ r, r> r r r r r $ s
r c C sH | dd} | dd} | dd} |dkr"| dd } | d
d } | S ) a Escape text to proper XML form, per section 2.3 in the XML specification.
@type text: C{str}
@param text: Text to escape
@type isattrib: C{bool}
@param isattrib: Triggers escaping of characters necessary for use as
attribute values
&&r- <r0 >r r. '""replace)textisattribr r r r6 s
r6 c C s@ | dd} | dd} | dd} | dd} | d d
} | S ) NrT r- rU r0 rV r. rX rW rS rR rY r[ r r r unescapeFromXml s r^ c c s | D ]
}| |r
|V qdS )z Filters items in a list by classN)
providedBy)r9 intnr r r generateOnlyInterface s
rb c c s4 | D ]}t |r|j|kr|j|kr|V qdS )z;Filters Element items in a list with matching name and URI.N)IElementr_ r r# )r9 r r# ra r r r generateElementsQNamed s rd c c s* | D ]}t |r|j|kr|V qdS )zFFilters Element items in a list with matching name, regardless of URI.N)rc r_ r )r9 r ra r r r generateElementsNamed s re c @ e Zd ZdZdS )r4 z/Marker class for pre-serialized XML in the DOM.NrN rO rP rQ r r r r r4 r4 c @ s( e Zd ZdZdd Zdd Zdd ZdS ) Namespacez7Convenience object for tracking namespace declarations.c C s
|| _ d S N_urir" r r r r
zNamespace.__init__c C
| j |fS rj rk r ra r r r __getattr__ rm zNamespace.__getattr__c C rn rj rk ro r r r __getitem__ rm zNamespace.__getitem__N)rN rO rP rQ r rp rq r r r r ri s
ri c @ sl e Zd ZdZedZedZedZedZedZ edZ
edZ dd d
Z dddZ
dd Zdd Zd S )rc z
Interface to XML element nodes.
See L{Element} for a detailed example of its general use.
Warning: this Interface is not yet complete!
z Element's namespace URI z Element's local name z) Default namespace URI of child elements z" Dictionary of element attributes z List of child nodes z' Reference to element's parent element z Dictionary of local prefixes Nr r c C dS )a Serializes object to a (partial) XML document
@param prefixes: dictionary that maps namespace URIs to suggested
prefix names.
@type prefixes: L{dict}
@param closeElement: flag that determines whether to include the
closing tag of the element in the serialized string. A value of
C{0} only generates the element's start tag. A value of C{1} yields
a complete serialization.
@type closeElement: L{int}
@param defaultUri: Initial default namespace URI. This is most useful
for partial rendering, where the logical parent element (of which
the starttag was already serialized) declares a default namespace
that should be inherited.
@type defaultUri: L{str}
@param prefixesInScope: list of prefixes that are assumed to be
declared by ancestors.
@type prefixesInScope: L{list}
@return: (partial) serialized XML
@rtype: L{str}
Nr )r rA r1 r r r r toXml zIElement.toXmlc C rr )a<
Create an element and add as child.
The new element is added to this element as a child, and will have
this element as its parent.
@param name: element name. This can be either a L{str} object that
contains the local name, or a tuple of (uri, local_name) for a
fully qualified name. In the former case, the namespace URI is
inherited from this element.
@type name: L{str} or L{tuple} of (L{str}, L{str})
@param defaultUri: default namespace URI for child elements. If
L{None}, this is inherited from this element.
@type defaultUri: L{str}
@param content: text contained by the new element.
@type content: L{str}
@return: the created element
@rtype: object providing L{IElement}
Nr )r r1 contentr r r
addElement rt zIElement.addElementc C rr )a
Adds a node as child of this element.
The C{node} will be added to the list of childs of this element, and
will have this element set as its parent when C{node} provides
L{IElement}. If C{node} is a L{str} and the current last child is
character data (L{str}), the text from C{node} is appended to the
existing last child.
@param node: the child node.
@type node: L{str} or object implementing L{IElement}
Nr )noder r r addChild' rt zIElement.addChildc C rr )aC
Adds character data to this element.
If the current last child of this element is a string, the text will
be appended to that string. Otherwise, the text will be added as a new
child.
@param text: The character data to be added to this element.
@type text: L{str}
Nr r] r r r
addContent5 rt zIElement.addContentNr r NrM )rN rO rP rQ r r# r r1 r; r= parentr7 rs rv rx ry r r r r rc s
rc c @ s e Zd ZdZdZd0ddZdd Zdd Zd
d Zd d
Z dd Z
dd Z e
Z dd Z
d1ddZdd Zdd Zdd Zd d Zd ed efd d!Zd2d"d#Zd$d% Zd&d' Zd2d(d)Zd3d,d-Zd.d/ ZdS )4ElementaP Represents an XML element node.
An Element contains a series of attributes (name/value pairs), content
(character data), and other child Element objects. When building a document
with markup (such as HTML or XML), use this object as the starting point.
Element objects fully support XML Namespaces. The fully qualified name of
the XML Element it represents is stored in the C{uri} and C{name}
attributes, where C{uri} holds the namespace URI. There is also a default
namespace, for child elements. This is stored in the C{defaultUri}
attribute. Note that C{''} means the empty namespace.
Serialization of Elements through C{toXml()} will use these attributes
for generating proper serialized XML. When both C{uri} and C{defaultUri}
are not None in the Element and all of its descendents, serialization
proceeds as expected:
>>> from twisted.words.xish import domish
>>> root = domish.Element(('myns', 'root'))
>>> root.addElement('child', content='test')
>>> root.toXml()
u"test"
For partial serialization, needed for streaming XML, a special value for
namespace URIs can be used: L{None}.
Using L{None} as the value for C{uri} means: this element is in whatever
namespace inherited by the closest logical ancestor when the complete XML
document has been serialized. The serialized start tag will have a
non-prefixed name, and no xmlns declaration will be generated.
Similarly, L{None} for C{defaultUri} means: the default namespace for my
child elements is inherited from the logical ancestors of this element,
when the complete XML document has been serialized.
To illustrate, an example from a Jabber stream. Assume the start tag of the
root element of the stream has already been serialized, along with several
complete child elements, and sent off, looking like this::
...
Now suppose we want to send a complete element represented by an
object C{message} created like:
>>> message = domish.Element((None, 'message'))
>>> message['to'] = 'user@example.com'
>>> message.addElement('body', content='Hi!')
>>> message.toXml()
u"Hi!"
As, you can see, this XML snippet has no xmlns declaration. When sent
off, it inherits the C{jabber:client} namespace from the root element.
Note that this renders the same as using C{''} instead of L{None}:
>>> presence = domish.Element(('', 'presence'))
>>> presence.toXml()
u""
However, if this object has a parent defined, the difference becomes
clear:
>>> child = message.addElement(('http://example.com/', 'envelope'))
>>> child.addChild(presence)
>>> message.toXml()
u"Hi!"
As, you can see, the element is now in the empty namespace, not
in the default namespace of the parent or the streams'.
@type uri: L{str} or None
@ivar uri: URI of this Element's name
@type name: L{str}
@ivar name: Name of this Element
@type defaultUri: L{str} or None
@ivar defaultUri: URI this Element exists within
@type children: L{list}
@ivar children: List of child Elements and content
@type parent: L{Element}
@ivar parent: Reference to the parent Element, if any.
@type attributes: L{dict}
@ivar attributes: Dictionary of attributes associated with this Element.
@type localPrefixes: L{dict}
@ivar localPrefixes: Dictionary of namespace declarations on this
element. The key is the prefix to bind the
namespace uri to.
r Nc C sX |pi | _ |\| _| _|du r | j| j vr | j| _n|| _|p"i | _g | _d| _dS )a
@param qname: Tuple of (uri, name)
@param defaultUri: The default URI of the element; defaults to the URI
specified in C{qname}
@param attribs: Dictionary of attributes
@param localPrefixes: Dictionary of namespace declarations on this
element. The key is the prefix to bind the
namespace uri to.
N)r7 r# r r r1 r; r= r{ )r qnamer1 attribsr7 r r r r s
zElement.__init__c C s> | j D ]}t|r|j|kr| S q|dr t|d S )N_)r= rc r_ r
startswithAttributeError)r keyra r r r rp s
zElement.__getattr__c C s | j | | S rj r; _dqar r r r r rq s zElement.__getitem__c C s | j | |= d S rj r r r r r __delitem__ s zElement.__delitem__c C s || j | |< d S rj r )r r valuer r r __setitem__ s zElement.__setitem__c C s" | j D ] }t|tr| S qdS )z9
Retrieve the first CData (content) node
r )r= r3 r5 ro r r r __unicode__ s
zElement.__unicode__c C s t | dS )zH
Retrieve the first character data node as UTF-8 bytes.
zutf-8)r5 encoder r r r __bytes__ s zElement.__bytes__c C s t |tr
|d s
|d S |S )z$Dequalify an attribute key as neededr r )r3 r< )r attrr r r r s z Element._dqac C s | j ||S )z.Retrieve the value of attribname, if it exists)r; get)r
attribnamedefaultr r r getAttribute s zElement.getAttributec C s | || jv S )z+Determine if the specified attribute exists)r r; )r attribr r r hasAttribute s zElement.hasAttributec C s | j | |d|kS )zbSafely compare the value of an attribute against a provided value.
L{None}-safe.
N)r; r r )r r r r r r compareAttribute s zElement.compareAttributec C s& | j }|| }|| ||< |||< dS )z!Swap the values of two attribute.N)r; )r leftrightdlr r r swapAttributeValues s zElement.swapAttributeValuesc C s t |r| |_| j| |S )z Add a child to this Element.)rc r_ r{ r= r2 )r rw r r r rx s
zElement.addChildr[ returnc C sp t |tstd|dt|j d| j}t|dkr,t |d tr,|d | |d< n|| tt|d S )z#Add some text data to this Element.zExpected str not z ()r r% ) r3 r5 TypeErrortyperN r= r r2 r )r r[ rL r r r ry s
zElement.addContentc C s^ t |tr|d u r
|d }t||}n|d u r| j}t||f|}| | |r-|| |S r )r3 r< r| r1 rx ry )r r r1 ru childr r r rv s
zElement.addElementc C s | j t| dS )z=Add a pre-serialized chunk o' XML as a child of this Element.N)r= r2 r4 )r rawxmlstringr r r addRawXml# s zElement.addRawXmlc C s dt j | jd< t jd t _dS )z[Add a unique (across a given Python session) id attribute to this
Element.
zH_%didr N)r|
_idCounterr; r r r r addUniqueId' s zElement.addUniqueIdc C s" |du r
t | jtS t| j||S )a
Iterate across all children of this Element that are Elements.
Returns a generator over the child elements. If both the C{uri} and
C{name} parameters are set, the returned generator will only yield
on elements matching the qualified name.
@param uri: Optional element URI.
@type uri: L{str}
@param name: Optional element name.
@type name: L{str}
@return: Iterator that yields objects implementing L{IElement}.
N)rb r= rc rd )r r# r r r r elements. s zElement.elementsr r c C s$ t ||d}|j| ||d | S )z4Serialize this Element and all children to a string.)r r )rA r1 )SerializerClassr> r! )r r rA r1 r sr r r rs A s z
Element.toXmlc C s" | j D ] }t|r| S qd S rj )r= rc r_ )r rL r r r firstChildElementG s
zElement.firstChildElement)NNNrj rM rz )rN rO rP rQ r r rp rq r r r r __str__r r r r r rx r5 ry rv r r r rs r r r r r r| B s0 b
r| c @ rf ) ParserErrorz,Exception thrown when a parsing error occursNrg r r r r r N rh r c C s: zt } | W S ty tdu rtdt } | Y S w )zPreferred method to construct an ElementStream
Uses Expat-based stream if available, and falls back to Sux if necessary.
NzNo parsers available :()ExpatElementStream ImportErrorSuxElementStream Exception)esr r r
elementStreamT s r c @ sd e Zd Zdd Zdd Zdd Zdd Zd d
Zd d Zd
d Z ddddddZ
dd Z dd Z dS )r c C s< | d | _d | _d | _d | _d | _d| _g | _g | _d S )NF) connectionMadeDocumentStartEvent ElementEventDocumentEndEventcurrElemrootElemdocumentStarteddefaultNsStackr r r r r r d s
zSuxElementStream.__init__c
C s8 z| | W d S tjy } ztt|d }~ww rj ) dataReceivedr
ParseErrorr r5 r bufferer r r parseo s zSuxElementStream.parsec C sF | j }tdt| j d d dD ]}||| v r || | S qd S )Nr% r r& r( r r r findUriu s zSuxElementStream.findUric C sX d }i }i }d }t | D ] \}}|dr+t|\} }
| d u r$|}n|||
< ||= q| j| |d u rEt| jdkrC| jd }nd}t|\} }| d u rR|}n| | }| D ] \}}t|\}
} |
d u rn||| < q[t ||| |
| f< q[t
||f|||}
| j| | j r| j d u r|
| _ d S | j
|
| _ d S |
| _d| _ | |
d S )Nxmlnsr r% r T)r9 r8 r r r r2 r r r r^ r| r r rx r r )r r r; r1 r7 r~ r# rG rH xrD r) ra r r r r gotTagStart~ sF
z SuxElementStream.gotTagStartc C 2 | j d urt|tr|d}| j | d S d S Nasciir r3 bytesdecodery r datar r r gotText
zSuxElementStream.gotTextc C r r r r r r r gotCData r zSuxElementStream.gotCDatac C s d S rj r r r r r
gotComment s zSuxElementStream.gotCommentrR r- r0 r. rW )ampltgtaposquotc C s< |t jv r t j| }t|tr|d}| j| d S d S r )r entitiesr3 r r r ry )r entityRefr r r r gotEntityReference s
z#SuxElementStream.gotEntityReferencec C s | j d u r tdt|\}}|d u r| jd }n| |}| jd u r<| j j|ks/| j j|kr3td| d | _ d S | jj|ksH| jj|krLtd| j
| j
| jj d u rl| j | j_ | | j d | _d S | jj | _d S )Nz%Element closed after end of document.r% zMismatched root elementszMalformed element close)
r r r r r r r r# r r r? r{ r )r r r) r# r r r gotTagEnd s(
zSuxElementStream.gotTagEndN)
rN rO rP r r r r r r r r r r r r r r r c s ? r c @ sD e Zd Zdd Zdd Zdd Zdd Zd d
Zd d Zd
d Z dS )r c C s dd l }d | _d | _d | _|j| _|dd| _| j| j_| j | j_
| j | j_ | j
| j_| j| j_d | _dg| _d| _i | _d S )Nr zUTF-8r/ r )pyexpatr r r error ParserCreateparser_onStartElementStartElementHandler
_onEndElementEndElementHandler_onCdataCharacterDataHandler_onStartNamespaceStartNamespaceDeclHandler_onEndNamespaceEndNamespaceDeclHandlerr r r r7 )r r r r r r s
zExpatElementStream.__init__c
C s: z | j | W d S | jy } ztt|d }~ww rj )r Parser r r5 r r r r r s zExpatElementStream.parsec
C s | dd}t|dkrd|f}i }g }| D ] \}}d|v r5| dd}|||d |d f< || q|| |D ]}||= q=t|| jd || j} i | _| jdkrk| j d krf| j j
| | j | _ | | _ d S d| _| | d S )Nr/ r r r r% )
rsplitr r8 r2 r r| r r7 r r r= r{ r )
r r attrsr} newAttrstoDeleterG rH aqnamer r r r r $ s.
z"ExpatElementStream._onStartElementc C sF | j d u r | d S | j jd u r | | j d | _ d S | j j| _ d S rj )r r r{ r )r r r r r r J s
z ExpatElementStream._onEndElementc C s | j d kr
| j | d S d S rj )r ry r r r r r Z s
zExpatElementStream._onCdatac C s& |d u r | j | d S || j|< d S rj )r r2 r7 )r r) r# r r r r ^ s z$ExpatElementStream._onStartNamespacec C s |d u r | j d S d S rj )r r? )r r) r r r r f s z"ExpatElementStream._onEndNamespaceN)
rN rO rP r r r r r r r r r r r r s & r N)r ) rQ typingr zope.interfacer r r twisted.webr r r r r r6 r^ rb rd re r5 r4 ri rc r| r r r XMLParserr r r r r r s2
x
_
)