File: //lib/python3/dist-packages/twisted/web/test/__pycache__/requesthelper.cpython-38.pyc
U
W[^4 � @ s6 d Z ddlmZmZ ddgZddlmZ ddlmZm Z ddl
m Z ddl m
Z
dd lmZ dd
lmZ dd lmZmZ dd lmZmZ dd
lmZ ddlmZ ddl m Z ddl m Z m Z m!Z! ddl"m#Z# ee�G dd� de$��Z%G dd� d�Z&G dd� de$�Z'e
edddd�dd�e'j(�e'_(G dd � d ej)�Z*d S ) z2
Helpers related to HTTP requests, used by tests.
� )�division�absolute_import� DummyChannel� DummyRequest)�BytesIO)� implementer�verify)�
intToBytes)�
deprecated)�Version)�Deferred)� IPv4Address� IPv6Address)�
ISSLTransport�IAddress)�unittest)�Headers)�Resource)� NOT_DONE_YET�Session�Site)�FOUNDc @ s e Zd ZdZdS )� NullAddressz/
A null implementation of L{IAddress}.
N)�__name__�
__module__� __qualname__�__doc__� r r �@/usr/lib/python3/dist-packages/twisted/web/test/requesthelper.pyr s r c @ s� e Zd ZG dd� d�Zee�G dd� de��Zee� �Z d dd�Z
dd � Z d
d � Z d d
� Z
dd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � ZdS ) r c @ sV e Zd ZdZdZddd�Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dS )zDummyChannel.TCP�P FNc C s, |d krt ddd�}|| _t� | _g | _d S )N�TCPz 192.168.1.1i80 )r
�_peerr �written� producers��selfZpeerr r r �__init__- s
zDummyChannel.TCP.__init__c C s | j S �N)r! �r% r r r �getPeer4 s zDummyChannel.TCP.getPeerc C s( t |t�std|f ��| j�|� d S )Nz+Can only write bytes to a transport, not %r)�
isinstance�bytes� TypeErrorr" �write�r% �datar r r r- 7 s
zDummyChannel.TCP.writec C s |D ]}| � |� qd S r' )r- )r% �iovecr/ r r r �
writeSequence< s z DummyChannel.TCP.writeSequencec C s t dd| j�S )Nr z10.0.0.1)r
�portr( r r r �getHost@ s zDummyChannel.TCP.getHostc C s | j �||f� d S r' )r# �append�r% ZproducerZ streamingr r r �registerProducerC s z!DummyChannel.TCP.registerProducerc C s d S r' r r( r r r �unregisterProducerF s z#DummyChannel.TCP.unregisterProducerc C s
d| _ d S )NT)� disconnectedr( r r r �loseConnectionI s z DummyChannel.TCP.loseConnection)N)
r r r r2 r8 r& r) r- r1 r3 r6 r7 r9 r r r r r ) s
r c @ s e Zd ZdS )zDummyChannel.SSLN)r r r r r r r �SSLM s r: Nc C s | � |�| _d S r' )r � transportr$ r r r r& S s zDummyChannel.__init__c C s d S r' r )r% �requestr r r � requestDoneW s zDummyChannel.requestDonec C sL |d | d | d }|g}|� dd� |D �� |�d� | j�|� d S )N� �
c s s" | ]\}}|d | d V qdS )s : r? Nr )�.0�name�valuer r r � <genexpr>^ s z,DummyChannel.writeHeaders.<locals>.<genexpr>)�extendr4 r; r1 )r% �version�code�reason�headersZ
response_lineZheaderSequencer r r � writeHeaders[ s
�
zDummyChannel.writeHeadersc C s
| j �� S r' )r; r) r( r r r r) e s zDummyChannel.getPeerc C s
| j �� S r' )r; r3 r( r r r r3 i s zDummyChannel.getHostc C s | j �||� d S r' )r; r6 r5 r r r r6 m s z DummyChannel.registerProducerc C s | j �� d S r' )r; r7 r( r r r r7 q s z DummyChannel.unregisterProducerc C s | j �|� d S r' )r; r- r. r r r r- u s zDummyChannel.writec C s | j �|� d S r' )r; r1 )r% r0 r r r r1 y s zDummyChannel.writeSequencec C s | j �� d S r' )r; r9 r( r r r r9 } s zDummyChannel.loseConnectionc C s d S r' r r( r r r �
endRequest� s zDummyChannel.endRequestc C s t | j| j�S r' )r* r; r: r( r r r �isSecure� s zDummyChannel.isSecure)N)r r r r r r r: r r Zsiter& r= rI r) r3 r6 r7 r- r1 r9 rJ rK r r r r r ( s $
c @ s� e Zd ZdZdZdZdZdd� Zdd� Zd2d d
�Z d d � Z
d
d� Z dd� Z dd� Z
dd� Zdd� Zdd� Zdd� Zdd � Zd d � Zd3d d �Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd4d.d/�Zd0d1� Z dS )5r a
Represents a dummy or fake request. See L{twisted.web.server.Request}.
@ivar _finishedDeferreds: L{None} or a C{list} of L{Deferreds} which will
be called back with L{None} when C{finish} is called or which will be
errbacked if C{processingFailed} is called.
@type requestheaders: C{Headers}
@ivar requestheaders: A Headers instance that stores values for all request
headers.
@type responseHeaders: C{Headers}
@ivar responseHeaders: A Headers instance that stores values for all
response headers.
@type responseCode: C{int}
@ivar responseCode: The response code which was passed to
C{setResponseCode}.
@type written: C{list} of C{bytes}
@ivar written: The bytes which have been written to the request.
s
http://dummy/s GETNc C s d| _ | j r|�� qdS )z�
Call an L{IPullProducer}'s C{resumeProducing} method in a
loop until it unregisters itself.
@param prod: The producer.
@type prod: L{IPullProducer}
@param s: Whether or not the producer is streaming.
� N)�goZresumeProducing)r% Zprod�sr r r r6 � s z DummyRequest.registerProducerc C s
d| _ d S )Nr )rM r( r r r r7 � s z DummyRequest.unregisterProducerc C sf g | _ g | _d| _|| _g | _d | _|p0td| �| _i | _t � | _
t � | _ d | _ g | _
d| _d| _d S )Nr s dummys HTTP/1.0)Zsitepathr" �finished�postpathZprepath�sessionr � protoSession�argsr �requestHeaders�responseHeaders� responseCode�_finishedDeferreds� _serverNameZ clientproto)r% rP rQ �clientr r r r& � s zDummyRequest.__init__c C s, i }| j �� D ]\}}|d ||�� < q|S )ah
Return dictionary mapping the names of all received headers to the last
value received for each.
Since this method does not return all header information,
C{self.requestHeaders.getAllRawHeaders()} may be preferred.
NOTE: This function is a direct copy of
C{twisted.web.http.Request.getAllRawHeaders}.
���)rT ZgetAllRawHeaders�lower)r% rH �k�vr r r �
getAllHeaders� s zDummyRequest.getAllHeadersc C s | j �|�� dg�d S )aH
Retrieve the value of a request header.
@type name: C{bytes}
@param name: The name of the request header for which to retrieve the
value. Header names are compared case-insensitively.
@rtype: C{bytes} or L{None}
@return: The value of the specified request header.
Nr )rT Z
getRawHeadersr[ )r% rA r r r � getHeader� s zDummyRequest.getHeaderc C s | j �||� dS )zJTODO: make this assert on write() if the header is content-length
N)rU � addRawHeader�r% rA rB r r r � setHeader� s zDummyRequest.setHeaderc C s( | j r | j S | jrtd��| j| _ | j S )Nz8Session cannot be requested after data has been written.)rQ r" �AssertionErrorrR r( r r r �
getSession� s
zDummyRequest.getSessionc C s, |� | �}|tkrdS | �|� | �� dS )a�
Render the given resource as a response to this request.
This implementation only handles a few of the most common behaviors of
resources. It can handle a render method that returns a string or
C{NOT_DONE_YET}. It doesn't know anything about the semantics of
request methods (eg HEAD) nor how to set any particular headers.
Basically, it's largely broken, but sufficient for some tests at least.
It should B{not} be expanded to do all the same stuff L{Request} does.
Instead, L{DummyRequest} should be phased out and L{Request} (or some
other real code factored in a different way) used.
N)�renderr r- �finish)r% �resource�resultr r r re � s
zDummyRequest.renderc C s" t |t�std��| j�|� d S )Nzwrite() only accepts bytes)r* r+ r, r" r4 r. r r r r- s
zDummyRequest.writec C s t � }| j�|� |S )z�
Return a L{Deferred} which is called back with L{None} when the request
is finished. This will probably only work if you haven't called
C{finish} yet.
)r rW r4 )r% rO r r r � notifyFinish s zDummyRequest.notifyFinishc C s: | j d | _ | jdk r6| j}d| _|D ]}|�d� q&dS )z}
Record that the request is finished and callback and L{Deferred}s
waiting for notification of this.
rL N)rO rW �callback)r% � observers�obsr r r rf s
zDummyRequest.finishc C s. | j dk r*| j }d| _ |D ]}|�|� qdS )zK
Errback and L{Deferreds} waiting for finish notification.
N)rW Zerrback)r% rG rk rl r r r �processingFailed* s
z DummyRequest.processingFailedc C s |g| j |< d S r' )rS ra r r r �addArg5 s zDummyRequest.addArgc C s* | j rtdd�| j � ��|| _|| _dS )z{
Set the HTTP status response code, but takes care that this is called
before any data is written.
z<Response code cannot be set after data has been written: %s.�@@@@N)r" rc �joinrV ZresponseMessage)r% rF �messager r r �setResponseCode9 s z DummyRequest.setResponseCodec C s | j rtdd�| j � ��d S )Nz<Last-Modified cannot be set after data has been written: %s.ro �r" rc rp )r% Zwhenr r r �setLastModifiedC s z DummyRequest.setLastModifiedc C s | j rtdd�| j � ��d S )Nz3ETag cannot be set after data has been written: %s.ro rs )r% �tagr r r �setETagG s zDummyRequest.setETagc C s t | jttf�r| jjS dS )z|
Return the IPv4 address of the client which made this request, if there
is one, otherwise L{None}.
N)r* rY r
r �hostr( r r r � getClientIPK s zDummyRequest.getClientIPc C s | j dkrt� S | j S )z�
Return the L{IAddress} of the client that made this request.
@return: an address.
@rtype: an L{IAddress} provider.
N)rY r r( r r r �getClientAddressU s
z DummyRequest.getClientAddressc C s | j S )z�
Get a dummy hostname associated to the HTTP request.
@rtype: C{bytes}
@returns: a dummy hostname
)rX r( r r r �getRequestHostnamea s z DummyRequest.getRequestHostnamec C s t ddd�S )zz
Get a dummy transport's host.
@rtype: C{IPv4Address}
@returns: a dummy transport's host
r � 127.0.0.1r )r
r( r r r r3 k s zDummyRequest.getHostr c C sH || _ | �� rd}nd}||kr&|}n|d t|� }| j�d|� dS )a_
Change the host and port the request thinks it's using.
@type host: C{bytes}
@param host: The value to which to change the host header.
@type ssl: C{bool}
@param ssl: A flag which, if C{True}, indicates that the request is
considered secure (if C{True}, L{isSecure} will return C{True}).
i� r � :s hostN)Z _forceSSLrK r rT r` )r% rw r2 Zssl�defaultZ
hostHeaderr r r �setHostu s zDummyRequest.setHostc C s | � t� | �d|� dS )zu
Utility function that does a redirect.
The request should have finish() called after this.
s locationN)rr r rb )r% Zurlr r r �redirect� s
zDummyRequest.redirect)NN)N)r ) r r r r Zuri�methodrY r6 r7 r& r^ r_ rb rd re r- ri rf rm rn rr rt rv rx ry rz r3 r~ r r r r r r � s4
ZTwisted� � ry )Z replacementc @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) �DummyRequestTestsz$
Tests for L{DummyRequest}.
c C s^ t g �}|�� | j| jgd�}| �dt|�� |\}| �|�d�t� | �|�d�d� dS )zp
L{DummyRequest.getClientIP} is deprecated in favor of
L{DummyRequest.getClientAddress}
)ZoffendingFunctionsrL �categoryrq z}twisted.web.test.requesthelper.DummyRequest.getClientIP was deprecated in Twisted 18.4.0; please use getClientAddress insteadN)r rx Z
flushWarnings�test_getClientIPDeprecated� assertEqual�len�get�DeprecationWarning)r% r< �warningsZwarningr r r r� � s ��z,DummyRequestTests.test_getClientIPDeprecatedc C s. t g �}tddd�}||_| �d|�� � dS )z�
L{DummyRequest.getClientIP} supports IPv6 addresses, just like
L{twisted.web.http.Request.getClientIP}.
r z::1�90 N)r r rY r� rx )r% r< rY r r r � test_getClientIPSupportsIPv6� s z.DummyRequestTests.test_getClientIPSupportsIPv6c C s t g �}|�� }t�t|� dS )zu
L{DummyRequest.getClientAddress} returns an L{IAddress}
provider no C{client} has been set.
N)r ry r Z verifyObjectr )r% r< Znullr r r �"test_getClientAddressWithoutClient� s z4DummyRequestTests.test_getClientAddressWithoutClientc C s2 t g �}tddd�}||_|�� }| �||� dS )zI
L{DummyRequest.getClientAddress} returns the C{client}.
r r{ r� N)r r
rY ry ZassertIs)r% r< rY Zaddressr r r �test_getClientAddress� s
z'DummyRequestTests.test_getClientAddressN)r r r r r� r� r� r� r r r r r� � s
r� N)+r Z
__future__r r �__all__�ior Zzope.interfacer r Ztwisted.python.compatr Ztwisted.python.deprecater
Z incrementalr Ztwisted.internet.deferr Ztwisted.internet.addressr
r Ztwisted.internet.interfacesr r Z
twisted.trialr Ztwisted.web.http_headersr Ztwisted.web.resourcer Ztwisted.web.serverr r r Ztwisted.web._responsesr �objectr r r rx ZSynchronousTestCaser� r r r r �<module> s8 b ��