File: //usr/lib/python3/dist-packages/twisted/web/test/__pycache__/test_flatten.cpython-310.pyc
o
�brV � @ sR d Z ddlZddlZddlZddlmZ ddlmZ ddlm Z ddl
m Z m Z m
Z
mZmZmZ ddlmZ ddlmZ dd lmZmZmZmZmZ dd
lm Z dd l m Z dd l m Z dd
l!m"Z"m#Z#m$Z$ ddl%m&Z&m'Z'm(Z( ddl)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4 ddl5m6Z6 G dd� de6e �Z7dd� j8j9Z:G dd� de �Z;dS )zf
Tests for the flattening portion of L{twisted.web.template}, implemented in
L{twisted.web._flatten}.
� N)� OrderedDict��dedent)� FunctionType)�Callable�Dict�List�NoReturn�Optional�cast)�XML)� implementer)�CancelledError�Deferred�
gatherResults�passthru�succeed)�Failure)�XMLAssertionMixin)�SynchronousTestCase)�FlattenerError� UnfilledSlot�UnsupportedType)� IRenderable�IRequest�ITemplateLoader) �CDATA�CharRef�Comment�Element� Flattenable�Tag� TagLoader�
flattenString�renderer�slot�tags)�FlattenTestCasec @ sz e Zd ZdZdBdd�ZdBdd�ZdBdd �ZdBd
d �ZdBd d
�Zde e
ge f de e ge f ddfdd�Z
dBdd�ZdBdd�ZdBdd�ZdBdd�ZdBdd�ZdBd d �Zde e ge f ddfd d �ZdBd d!�ZdBd"d#�ZdBd$d%�ZdBd&d'�Zdeee fd(d)�Z dBd*d+�Z dBd,d-�Z dBd.d/�Z dBd0d1�Z dBd2d3�Z!dBd4d5�Z"dBd6d7�Z#dBd8d9�Z$dBd:d;�Z%dBd<d=�Z&dBd>d?�Z'dBd@dA�Z(dS )C�SerializationTestsz.
Tests for flattening various things.
�returnNc C s | � tjt�d�dd�d� dS )z:
Test that nested tags flatten correctly.
�42�there)�his' <html hi="there"><body>42</body></html>N)�assertFlattensImmediatelyr& �html�body��self� r2 �?/usr/lib/python3/dist-packages/twisted/web/test/test_flatten.py�test_nestedTags5 s �z"SerializationTests.test_nestedTagsc C s | � dd�f | � dd�f dS )zL
Test that strings will be flattened and escaped correctly.
�ones onez
<abc&&>123s <abc&&>123N)r- r0 r2 r2 r3 �test_serializeString> s z'SerializationTests.test_serializeStringc C s | � t�� d� dS )zP
The serialized form of a self-closing tag is C{'<tagName />'}.
s <img />N�r- r& �imgr0 r2 r2 r3 � test_serializeSelfClosingTagsE � z0SerializationTests.test_serializeSelfClosingTagsc C s | � tjdd�d� dS )zV
The serialized form of attribute I{a} with value I{b} is C{'a="b"'}.
�foo��srcs <img src="foo" />Nr7 r0 r2 r2 r3 �test_serializeAttributeK s z*SerializationTests.test_serializeAttributec C s& t �� }tddg�|_| �|d� dS )zg
Multiple attributes are separated by a single space in their serialized
form.
)r= r; )�name�bars <img src="foo" name="bar" />N)r& r8 r �
attributesr- �r1 �tagr2 r2 r3 �!test_serializedMultipleAttributesQ s z4SerializationTests.test_serializedMultipleAttributes�wrapData�wrapTagc C s | � |tj|d�d��d� dS )a�
Common implementation of L{test_serializedAttributeWithSanitization}
and L{test_serializedDeferredAttributeWithSanitization},
L{test_serializedAttributeWithTransparentTag}.
@param wrapData: A 1-argument callable that wraps around the
attribute's value so other tests can customize it.
@param wrapTag: A 1-argument callable that wraps around the outer tag
so other tests can customize it.
�<>&"r< s! <img src="<>&"" />Nr7 )r1 rE rF r2 r2 r3 �checkAttributeSanitizationZ s �z-SerializationTests.checkAttributeSanitizationc C s | � tt� dS )z�
Attribute values containing C{"<"}, C{">"}, C{"&"}, or C{'"'} have
C{"<"}, C{">"}, C{"&"}, or C{"""} substituted for those
bytes in the serialized output.
N)rH r r0 r2 r2 r3 �(test_serializedAttributeWithSanitizationo � z;SerializationTests.test_serializedAttributeWithSanitizationc C s | � tt� dS )z�
Like L{test_serializedAttributeWithSanitization}, but when the contents
of the attribute are in a L{Deferred
<twisted.internet.defer.Deferred>}.
N)rH r r r0 r2 r2 r3 �0test_serializedDeferredAttributeWithSanitizationw rJ zCSerializationTests.test_serializedDeferredAttributeWithSanitizationc s@ g � dt dtf� fdd� }dtdtf� fdd� }| �||� dS ) zS
Like L{test_serializedAttributeWithSanitization} but with a slot.
�valuer) c s � � | � td�S )N�stuff)�appendr% �rL ��tossr2 r3 �
insertSlot� s
zWSerializationTests.test_serializedAttributeWithSlotWithSanitization.<locals>.insertSlotrC c s | j � �� d�S )N)rM )� fillSlots�pop�rC rP r2 r3 �fillSlot� s zUSerializationTests.test_serializedAttributeWithSlotWithSanitization.<locals>.fillSlotN)�strr r! rH )r1 rR rV r2 rP r3 �0test_serializedAttributeWithSlotWithSanitization s zCSerializationTests.test_serializedAttributeWithSlotWithSanitizationc C s | � tjt� dS )z�
Attribute values which are supplied via the value of a C{t:transparent}
tag have the same substitution rules to them as values supplied
directly.
N)rH r& � transparentr r0 r2 r2 r3 �*test_serializedAttributeWithTransparentTag� s z=SerializationTests.test_serializedAttributeWithTransparentTagc sR G dd� dt �� g �dtdtf�fdd� }dtdtf� �fdd � }| �||� d
S ) z�
Like L{test_serializedAttributeWithTransparentTag}, but when the
attribute is rendered by a renderer on an element.
c sH e Zd Zdedee f� fdd� Zedee de de
fdd ��Z � Z S )
z_SerializationTests.test_serializedAttributeWithTransparentTagWithRenderer.<locals>.WithRendererrL �loaderc s || _ t� �|� d S �N)rL �super�__init__)r1 rL r[ �� __class__r2 r3 r^ � s zhSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer.<locals>.WithRenderer.__init__�requestrC r) c S � | j S r\ rO )r1 ra rC r2 r2 r3 rM � s zeSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer.<locals>.WithRenderer.stuff)
�__name__�
__module__� __qualname__rW r
r r^ r$ r r! r rM �
__classcell__r2 r2 r_ r3 � WithRenderer� s $rg rL r) c s � � | � tjdd�S )NrM ��render)rN r& rY rO rP r2 r3 �insertRenderer� s
zaSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer.<locals>.insertRendererrC c s � �� � t| ��S r\ )rT r" rU �rg rQ r2 r3 ri � s zYSerializationTests.test_serializedAttributeWithTransparentTagWithRenderer.<locals>.renderN)r rW r r! rH )r1 rj ri r2 rk r3 �6test_serializedAttributeWithTransparentTagWithRenderer� s
zISerializationTests.test_serializedAttributeWithTransparentTagWithRendererc C s& t t�G dd� d��}| �|t� dS )z�
Like L{test_serializedAttributeWithTransparentTag}, but when the
attribute is a provider of L{IRenderable} rather than a transparent
tag.
c @ sR e Zd Zdefdd�Zdee defdd�Zdede ee e
gef fd d
�Z d S ) zLSerializationTests.test_serializedAttributeWithRenderable.<locals>.ArbitraryrL c S s
|| _ d S r\ rO )r1 rL r2 r2 r3 r^ � �
zUSerializationTests.test_serializedAttributeWithRenderable.<locals>.Arbitrary.__init__ra r) c S rb r\ rO �r1 ra r2 r2 r3 ri � s zSSerializationTests.test_serializedAttributeWithRenderable.<locals>.Arbitrary.renderr? c S � t d��)NzUnexpected call)�NotImplementedError�r1 r? r2 r2 r3 �lookupRenderMethod� s z_SerializationTests.test_serializedAttributeWithRenderable.<locals>.Arbitrary.lookupRenderMethodN) rc rd re r r^ r
r ri rW r r! rr r2 r2 r2 r3 � Arbitrary� s ��rs N)r
r rH r )r1 rs r2 r2 r3 �&test_serializedAttributeWithRenderable� s z9SerializationTests.test_serializedAttributeWithRenderablec C sL t �d�}t j||�d�}| �|d�}| �|d�}| �t|�jd |� dS )ag
Common implementation of L{test_serializedAttributeWithTag} and
L{test_serializedAttributeWithDeferredTag}.
@param wrapTag: A 1-argument callable that wraps around the attribute's
value so other tests can customize it.
@type wrapTag: callable taking L{Tag} and returning something
flattenable
rG r< s@ <img src="<a>&lt;&gt;&amp;"</a>" />s <a><>&"</a>r= N)r& �ar8 r- �assertXMLEqualr �attrib)r1 rF �innerTag�outerTag�outer�innerr2 r2 r3 � checkTagAttributeSerialization� s
� z1SerializationTests.checkTagAttributeSerializationc C � | � t� dS )z�
L{Tag} objects which are serialized within the context of an attribute
are serialized such that the text content of the attribute may be
parsed to retrieve the tag.
N)r| r r0 r2 r2 r3 � test_serializedAttributeWithTag� s z2SerializationTests.test_serializedAttributeWithTagc C r} )z�
Like L{test_serializedAttributeWithTag}, but when the L{Tag} is in a
L{Deferred <twisted.internet.defer.Deferred>}.
N)r| r r0 r2 r2 r3 �'test_serializedAttributeWithDeferredTag� s z:SerializationTests.test_serializedAttributeWithDeferredTagc C s6 | � tjtjdd�d�d�}| �t|�jd d� dS )z�
Similar to L{test_serializedAttributeWithTag}, but for the additional
complexity where the tag which is the attribute value itself has an
attribute value which contains bytes which require substitution.
rG )�hrefr< sV <img src="<a href="&lt;&gt;&amp;&quot;"></a>" />r= s" <a href="<>&""></a>N)r- r& r8 ru rv r rw )r1 � flattenedr2 r2 r3 �,test_serializedAttributeWithTagWithAttribute� s ��z?SerializationTests.test_serializedAttributeWithTagWithAttributec C � | � td�d� dS )zI
Test that comments are correctly flattened and escaped.
�foo bars <!--foo bar-->N)r- r r0 r2 r2 r3 �test_serializeComment r: z(SerializationTests.test_serializeCommentc sN dt ddf� fdd� }g }dD ]}tdt|��}|�|� |�|� qt|�S )a�
The data in a L{Comment} is escaped and mangled in the flattened output
so that the result is a legal SGML and XML comment.
SGML comment syntax is complicated and hard to use. This rule is more
restrictive, and more compatible:
Comments start with <!-- and end with --> and never contain -- or >.
Also by XML syntax, a comment may not end with '-'.
@see: U{http://www.w3.org/TR/REC-xml/#sec-comments}
�cr) Nc s� � � | �d�| �d�� � � | �d�| �d�� � � t| �dk| �d�� | dd� }� �d |� � �d
|� |rC� �|d d � d S d S )
Ns <!--z' does not start with the comment prefixs -->z% does not end with the comment suffix� z# is too short to be a legal comment� ���s --� >���� -)�
assertTrue�
startswith�endswith�len� assertNotIn�assertNotEqual)r� �contentr0 r2 r3 �
verifyComment s �� �z>SerializationTests.test_commentEscaping.<locals>.verifyComment)� z foo---barz
foo---bar-zfoo>barz foo-->barz----------------)�bytesr# r � addCallbackrN r )r1 r� �resultsr� �dr2 r0 r3 �test_commentEscaping s
z'SerializationTests.test_commentEscapingc C s& | � td�d�f | � td�d� dS )zE
Test that CDATA is correctly flattened and escaped.
r� s <![CDATA[foo bar]]>z foo ]]> bars# <![CDATA[foo ]]]]><![CDATA[> bar]]>N)r- r r0 r2 r2 r3 �test_serializeCDATA6 s �z&SerializationTests.test_serializeCDATAc C sn d}| � |d� | � t�|�d� | � t|�d� | � t|�d� | �t|�t� | �td|did�t� d S )
z�
Test that unicode is encoded correctly in the appropriate places, and
raises an error when it occurs in inappropriate place.
� ☃s ☃s
<p>☃</p>s
<!--☃-->s <![CDATA[☃]]>�pr� )rA N)r- r& r� r r �assertFlatteningRaisesr! �UnicodeEncodeError)r1 �snowmanr2 r2 r3 �test_serializeUnicode? s �z(SerializationTests.test_serializeUnicodec C s t td��}| �|d� dS )ze
A character reference is flattened to a string using the I{&#NNNN;}
syntax.
r� s ☃N)r �ordr- )r1 �refr2 r2 r3 �test_serializeCharRefN s z(SerializationTests.test_serializeCharRefc C r� )zz
Test that a deferred is substituted with the current value in the
callback chain when flattened.
�twos twoN)r- r r0 r2 r2 r3 �test_serializeDeferredV s z)SerializationTests.test_serializeDeferredc C s$ t d�}| �|d� | �|d� dS )zE
Test that the same deferred can be flattened twice.
�threes threeN)r r- )r1 r� r2 r2 r3 � test_serializeSameDeferredTwice] s z2SerializationTests.test_serializeSameDeferredTwicec C s: ddl m} i }t|d�|� |d }| �|d�d� dS )zt
Test that a coroutine returning a value is substituted with the that
value when flattened.
r r zE
async def coro(x):
return x
�coro�four� fourN)�textwrapr �execr- �r1 r � namespacer� r2 r2 r3 �test_serializeCoroutinee s �� z*SerializationTests.test_serializeCoroutinec C s@ ddl m} ttd�}t|d�|� |d }| �|d�d� dS ) z�
Test that a coroutine returning an awaited deferred value is
substituted with that value when flattened.
r r )r zT
async def coro(x):
return await succeed(x)
r� r� r� N)r� r �dictr r� r- r� r2 r2 r3 � test_serializeCoroutineWithAwaitz s
�� z3SerializationTests.test_serializeCoroutineWithAwaitc s, t t�G � fdd�d��}� �|� d� dS )zQ
Test that flattening respects all of the IRenderable interface.
c sD e Zd Zdedefdd�Zdedeee ege
f f� fdd� Z dS ) zASerializationTests.test_serializeIRenderable.<locals>.FakeElement�oredr) c S s t �dt jdd�dt jdd��S )Nzhello, �testrh z - )r& r� rY )�ignr� r2 r2 r3 ri � s
�zHSerializationTests.test_serializeIRenderable.<locals>.FakeElement.renderr? c s � � |d� dd� S )Nr� c S s |d�S )N�worldr2 )r� �noder2 r2 r3 �<lambda>� s zfSerializationTests.test_serializeIRenderable.<locals>.FakeElement.lookupRenderMethod.<locals>.<lambda>)� assertEqual)r� r? r0 r2 r3 rr � s zTSerializationTests.test_serializeIRenderable.<locals>.FakeElement.lookupRenderMethodN) rc rd re �objectr! ri rW r r
r r rr r2 r0 r2 r3 � FakeElement� s ��r� s <p>hello, world - world</p>N)r
r r- )r1 r� r2 r0 r3 �test_serializeIRenderable� s z,SerializationTests.test_serializeIRenderablec C s | � tjdd�t� dS )z�
Test that flattening a tag with a C{render} attribute when no render
factory is available in the context raises an exception.
r� rh N)r� r& rY �
ValueErrorr0 r2 r2 r3 �"test_serializeMissingRenderFactory� s z5SerializationTests.test_serializeMissingRenderFactoryc C s> t �td��}|�� }|jdd� | �|t� | �|d� dS )zS
Test that flattening a slot will use the slot value from the tag.
r� z hello, world�r� s <p>hello, world</p>N)r& r� r% �clonerS r� r r- )r1 �t1�t2r2 r2 r3 �test_serializeSlots� s
z&SerializationTests.test_serializeSlotsc C s4 t �td��}|jtt �d��d� | �|d� dS )z|
Test that a slot with a deferred as its value will be flattened using
the value from the deferred.
r� zfour>r� s <p><em>four></em></p>N)r& r� r% rS r �emr- )r1 �tr2 r2 r3 �test_serializeDeferredSlots� s z.SerializationTests.test_serializeDeferredSlotsc C s | � dt� dS )zT
Test that flattening an unknown type of thing raises an exception.
N)r� r r0 r2 r2 r3 �test_unknownTypeRaises� s z)SerializationTests.test_unknownTypeRaises�r) N))rc rd re �__doc__r4 r6 r9 r> rD r rW r r! rH rI rK rX rZ rl rt r| r~ r r� r� r r r� r� r� r� r� r� r� r� r� r� r� r� r� r� r2 r2 r2 r3 r( 0 sT
� �
�
�
�
/
r( c C � d S r\ r2 r2 r2 r2 r3 r� � s r� c @ sL e Zd ZdZddd�Zddd�Zddd �Zdd
d �Zdd d
�Zddd�Z dS )�FlattenerErrorTestsz&
Tests for L{FlattenerError}.
r) Nc C s: t t�G dd� d��}| �tttd�|� gg ��d� dS )z�
If a L{FlattenerError} is created with an L{IRenderable} provider root,
the repr of that object is included in the string representation of the
exception.
c @ s e Zd Zdefdd�ZdS )z7FlattenerErrorTests.test_renderable.<locals>.Renderabler) c S � dS )Nzrenderable reprr2 r0 r2 r2 r3 �__repr__� � z@FlattenerErrorTests.test_renderable.<locals>.Renderable.__repr__N)rc rd re rW r� r2 r2 r2 r3 �
Renderable� s r� �reasonzCException while flattening:
renderable repr
RuntimeError: reason
N)r
r r� rW r � RuntimeError)r1 r� r2 r2 r3 �test_renderable� s �z#FlattenerErrorTests.test_renderablec C s2 t ddddd�}| �tttd�|gg ��d� dS ) z�
If a L{FlattenerError} is created with a L{Tag} instance with source
location information, the source location is included in the string
representation of the exception.
�divz/foo/filename.xhtml� � )�filename�
lineNumber� columnNumberr� zlException while flattening:
File "/foo/filename.xhtml", line 17, column 12, in "div"
RuntimeError: reason
N)r! r� rW r r� rB r2 r2 r3 �test_tag� s
�z FlattenerErrorTests.test_tagc C s& | � tttd�td�gg ��d� dS )z�
If a L{FlattenerError} is created with a L{Tag} instance without source
location information, only the tagName is included in the string
representation of the exception.
r� �spanz>Exception while flattening:
Tag <span>
RuntimeError: reason
N)r� rW r r� r! r0 r2 r2 r3 �test_tagWithoutLocation� s �z+FlattenerErrorTests.test_tagWithoutLocationc
s� d � fdd� }dt fdd�� z|� W n! ty4 } zt�t�� d �dd� }|}W Y d}~n
d}~ww | �d � | �tt |g |��d
t
|j j d t
� j j d f � dS ) z�
If a L{FlattenerError} is created with traceback frames, they are
included in the string representation of the exception.
r) Nc s
� � d S r\ r2 r2 ��gr2 r3 �f rm z-FlattenerErrorTests.test_traceback.<locals>.fc S ro )Nr� )r� r2 r2 r2 r3 r� s z-FlattenerErrorTests.test_traceback.<locals>.g� � zf() must raise RuntimeErrorz�Exception while flattening:
File "%s", line %d, in f
g()
File "%s", line %d, in g
raise RuntimeError("reason")
RuntimeError: reason
r� )
r r� � traceback�
extract_tb�sys�exc_info�failr� rW r �HERE�__code__�co_firstlineno)r1 r� �e�tbinfo�excr2 r� r3 �test_traceback s(
��
���z"FlattenerErrorTests.test_tracebackc s� t � � tt�G � fdd�d��}td|� g�}| �|� td�}� �|� | �|t�}| � t
|j �t j
td�t jd�� | �� t� dS )z�
When flattening a renderer which raises an exception asynchronously,
the error is reported when it occurs.
c sZ e Zd ZdZdefdd�Zdedeee e ge
f fdd�Z dee de
f� fd d
� Z d S ) zPFlattenerErrorTests.test_asynchronousFlattenError.<locals>.NotActuallyRenderablez#No methods provided; this will failr) c S r� )Nz<unrenderable>r2 r0 r2 r2 r3 r� 6 r� zYFlattenerErrorTests.test_asynchronousFlattenError.<locals>.NotActuallyRenderable.__repr__r? c S r� r\ r2 rq r2 r2 r3 rr 9 s zcFlattenerErrorTests.test_asynchronousFlattenError.<locals>.NotActuallyRenderable.lookupRenderMethodra c s � S r\ r2 rn ��failingr2 r3 ri > r� zWFlattenerErrorTests.test_asynchronousFlattenError.<locals>.NotActuallyRenderable.renderN)
rc rd re r� rW r� r r
r r! r rr ri r2 r� r2 r3 �NotActuallyRenderable2 s �
� r� N�examplea@ Exception while flattening:
\[<unrenderable>\]
<unrenderable>
.*
File ".*", line \d*, in _flattenTree
element = await element
RuntimeError: example
)�flags)r r
r r# �assertNoResultr� �errback�failureResultOfr � assertRegexrW rL �re�compiler � MULTILINE)r1 r� �
flatteningr� �failurer2 r� r3 � test_asynchronousFlattenError+ s$
� ��z1FlattenerErrorTests.test_asynchronousFlattenErrorc s� d�d� dt t ddf� �fdd� }d�dtddf�fdd � }t |�}td|�}| �|� |�|� |�� | �|t�}| � �d
� | �
� |� | � �t� | � t t��j
t� |j
jd }| � |t� dS ) z@
The flattening of a Deferred can be cancelled.
r N� cancelledr) c s | � �d7 �d S )Nr� r2 )r� )� cancelArg� cancelCountr2 r3 � checkCancelb s z4FlattenerErrorTests.test_cancel.<locals>.checkCancelr� c s | � d S r\ r2 )r� )�errr2 r3 �saveErri s z0FlattenerErrorTests.test_cancel.<locals>.saveErrr� )r r� r r# r� �
addErrback�cancelr� r r� �assertIs�assertIsInstancer rL r �args)r1 r� r r� r� r� r� r2 )r� r� r r3 � test_cancel[ s"
z FlattenerErrorTests.test_cancelr� )
rc rd re r� r� r� r� r� r� r r2 r2 r2 r3 r� � s
&0r� )<r� r� r� r� � collectionsr r� r �typesr �typingr r r r r
r �xml.etree.ElementTreer �zope.interfacer
�twisted.internet.deferr r r r r �twisted.python.failurer �twisted.test.testutilsr �twisted.trial.unittestr �twisted.web.errorr r r �twisted.web.iwebr r r �twisted.web.templater r r r r r! r" r# r$ r% r& �twisted.web.test._utilr' r( r� � co_filenamer� r� r2 r2 r2 r3 �<module> s0 4
#