/usr/lib/python3/dist-packages/twisted/web/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/web/__pycache__/client.cpython-310.pyc (57889B)
o
bs @ s d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
m Z m Z
ddlmZ ddlmZ ddlmZmZmZ dd lmZ dd
lmZmZ dd lm Z m Z dd l m Z dd
l m!Z!m"Z" ddl#m$Z$ ddl%m&Z&m'Z' ddl(m)Z) ddl*m+Z+m,Z, ddl-m.Z.m/Z/ ddl0m1Z1 ddl2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8 dd Z G dd de+j9Z:G dd dZ;dd Z
Z>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZH dd lImJZJ zdd!lKmLZL W n eMy dZLY n w dd"lNmOZOmPZPmQZQ d#d$ ZRG d%d& d&ZSee7G d'd( d(ZTe&ed)d*dde'eSed)d*ddeTd+Ud,d- eSjVeSjW ee7G d.d/ d/ZXee G d0d1 d1ZYee7G d2d3 d3ZZee6G d4d5 d5Z[G d6d7 d7ej\Z]G d8d9 d9Z^G d:d; d;Z_G dd? d?Zaee4G d@dA dAe`Zbee4G dBdC dCe`ZcG dDdE dEZdG dFdG dGZeee4G dHdI dIZfG dJdK dKe$e8ZgG dLdM dMe$e Zhee4G dNdO dOZie1 jjZkelg dPZmee4G dQdR dRZnG dSdT dTenZoG dUdV dVejpZqdWe8dXejres fdYdZZtg d[ZudS )]z
HTTP client.
N)wraps)Iterable) urldefragurljoin
urlunparse) implementer)Version)deferprotocoltask)
isIPv6Address)HostnameEndpoint
wrapClientTLS)IOpenSSLContextFactory IProtocol)Logger) nativeString
networkString)proxyForInterface)deprecatedModuleAttributegetDeprecationWarningString)Failure)errorhttp)_ensureValidMethod_ensureValidURI)Headers)UNKNOWN_LENGTHIAgentIAgentEndpointFactory
IBodyProducerIPolicyForHTTPS IResponsec C s t tdd | D }|dS )Nc s s | ]}| d V qdS )charmapN)decode).0p r' 4/usr/lib/python3/dist-packages/twisted/web/client.py 0 s z urlunparse..r# ) _urlunparsetupleencode)partsresultr' r' r( r / s
r c @ s e Zd ZdZdS )PartialDownloadErrorz
Page was only partially downloaded, we got disconnected in middle.
@ivar response: All of the response body which was downloaded.
N)__name__
__module__ __qualname____doc__r' r' r' r( r/ 4 s r/ c @ s: e Zd ZdZdd Zed ddZdd Zed d
Z dS ) URIzd
A URI object.
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-21}
c C s: || _ || _|d| _|| _|| _|| _|| _|| _dS )a
@type scheme: L{bytes}
@param scheme: URI scheme specifier.
@type netloc: L{bytes}
@param netloc: Network location component.
@type host: L{bytes}
@param host: Host name. For IPv6 address literals the brackets are
stripped.
@type port: L{int}
@param port: Port number.
@type path: L{bytes}
@param path: Hierarchical path.
@type params: L{bytes}
@param params: Parameters for last path segment.
@type query: L{bytes}
@param query: Query string.
@type fragment: L{bytes}
@param fragment: Fragment identifier.
s []N) schemenetlocstriphostportpathparamsqueryfragment) selfr5 r6 r8 r9 r: r; r< r= r' r' r( __init__C s
z URI.__init__Nc C s | }t|\}}}}}}|du r |dkrd}nd}d|v r=|dd\} }
zt|
}
W n ty< ||} }
Y nw ||} }
| ||| |
||||S )aN
Parse the given URI into a L{URI}.
@type uri: C{bytes}
@param uri: URI to parse.
@type defaultPort: C{int} or L{None}
@param defaultPort: An alternate value to use as the port if the URI
does not include one.
@rtype: L{URI}
@return: Parsed URI instance.
N https P : )r7 r urlparsersplitint
ValueError) clsuri defaultPortr5 r6 r: r; r< r= r8 r9 r' r' r( fromBytesg s
z
URI.fromBytesc C s t | j| j| j| j| j| jfS )z
Assemble the individual parts of the I{URI} into a fully formed I{URI}.
@rtype: C{bytes}
@return: A fully formed I{URI}.
)r r5 r6 r: r; r< r= r> r' r' r( toBytes s z URI.toBytesc C s* t dd| j| j| jdf}|dkrd}|S )a!
The absolute I{URI} path including I{URI} parameters, query string and
fragment identifier.
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-21#section-5.3}
@return: The absolute path in original form.
@rtype: L{bytes}
/)r r: r; r< )r> r: r' r' r(
originForm s
zURI.originFormN)
r0 r1 r2 r3 r? classmethodrL rN propertyrQ r' r' r' r( r4 < s $ !r4 c C s0 t | \} }t t| |\}}t|d|p| S )a
Construct a full ("absolute") URL by combining a "base URL" with another
URL. Informally, this uses components of the base URL, in particular the
addressing scheme, the network location and (part of) the path, to provide
missing components in the relative URL.
Additionally, the fragment identifier is preserved according to the HTTP
1.1 bis draft.
@type base: C{bytes}
@param base: Base URL.
@type url: C{bytes}
@param url: URL to combine with C{base}.
@return: An absolute URL resulting from the combination of C{base} and
C{url}.
@see: L{urllib.parse.urljoin()}
@see: U{https://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-22#section-7.1.2}
#)r r )baseurlbaseFragurlFragr' r' r( _urljoin s rZ c O s t t| }|| g|R i |}ddlm} |jdkr;ddlm} |du r-| }| t
|j |j || |S |
t
|j |j | |S )a
Create and connect an HTTP page getting factory.
Any additional positional or keyword arguments are used when calling
C{factoryFactory}.
@param factoryFactory: Factory factory that is called with C{url}, C{args}
and C{kwargs} to produce the getter
@param contextFactory: Context factory to use when creating a secure
connection, defaulting to L{None}
@return: The factory created by C{factoryFactory}
r reactorr@ )sslN)r4 rL r r7 twisted.internetr\ r5 r] ClientContextFactory
connectSSLr r8 r9
connectTCP) rW factoryFactorycontextFactoryargskwargsrJ factoryr\ r] r' r' r( _makeGetterFactory s
rg ) HTTP11ClientProtocolPotentialDataLossRequestRequestGenerationFailedRequestNotSentRequestTransmissionFailedResponse ResponseDoneResponseFailedResponseNeverReceived_WrapperException)SchemeNotSupported)SSL)CertificateOptionsoptionsForClientTLS
platformTrustc C s t du rt| dd }|S | S )a}
The decorated method requires pyOpenSSL to be present, or it raises
L{NotImplementedError}.
@param decoratee: A function which requires pyOpenSSL.
@type decoratee: L{callable}
@return: A function which raises L{NotImplementedError} if pyOpenSSL is not
installed; otherwise, if it is installed, simply return C{decoratee}.
@rtype: L{callable}
Nc _ s t d)z
pyOpenSSL is not available.
@param a: The positional arguments for C{decoratee}.
@param kw: The keyword arguments for C{decoratee}.
@raise NotImplementedError: Always.
zSSL support unavailable)NotImplementedError)akwr' r' r( raiseNotImplemented s z(_requireSSL..raiseNotImplemented)rt r ) decorateer{ r' r' r( _requireSSL s
r} c @ s$ e Zd ZdZdd Zedd ZdS )WebClientContextFactorya
This class is deprecated. Please simply use L{Agent} as-is, or if you want
to customize something, use L{BrowserLikePolicyForHTTPS}.
A L{WebClientContextFactory} is an HTTPS policy which totally ignores the
hostname and port. It performs basic certificate verification, however the
lack of validation of service identity (e.g. hostname validation) means it
is still vulnerable to man-in-the-middle attacks. Don't use it any more.
c C s t tjt dS )z
Return a L{CertificateOptions}.
@param hostname: ignored
@param port: ignored
@return: A new CertificateOptions instance.
@rtype: L{CertificateOptions}
)method trustRoot)ru rt
SSLv23_METHODrw r> hostnamer9 r' r' r( _getCertificateOptions1 z.WebClientContextFactory._getCertificateOptionsc C s | || S )z
Return an L{OpenSSL.SSL.Context}.
@param hostname: ignored
@param port: ignored
@return: A new SSL context.
@rtype: L{OpenSSL.SSL.Context}
)r
getContextr r' r' r( r > r z"WebClientContextFactory.getContextN)r0 r1 r2 r3 r r} r r' r' r' r( r~ & s
r~ c @ s& e Zd ZdZdddZedd ZdS )BrowserLikePolicyForHTTPSz1
SSL connection creator for web clients.
Nc C
|| _ d S rR )
_trustRoot)r> r r' r' r( r? R
z"BrowserLikePolicyForHTTPS.__init__c C s t |d| jdS )a
Create a L{client connection creator
} for a
given network location.
@param hostname: The hostname part of the URI.
@type hostname: L{bytes}
@param port: The port part of the URI.
@type port: L{int}
@return: a connection creator with appropriate verification
restrictions set
@rtype: L{client connection creator
}
ascii)r )rv r$ r r r' r' r( creatorForNetlocU s z*BrowserLikePolicyForHTTPS.creatorForNetlocrR )r0 r1 r2 r3 r? r} r r' r' r' r( r L s
r Twisted ) replacementz; rD c @ s" e Zd ZdZdddZdd ZdS ) HostnameCachingHTTPSPolicya
IPolicyForHTTPS that wraps a L{IPolicyForHTTPS} and caches the created
L{IOpenSSLClientConnectionCreator}.
This policy will cache up to C{cacheSize}
L{client connection creators } for reuse in subsequent requests to
the same hostname.
@ivar _policyForHTTPS: See C{policyforHTTPS} parameter of L{__init__}.
@ivar _cache: A cache associating hostnames to their
L{client connection creators }.
@type _cache: L{collections.OrderedDict}
@ivar _cacheSize: See C{cacheSize} parameter of L{__init__}.
@since: Twisted 19.2.0
c C s || _ t | _|| _dS )z
@param policyforHTTPS: The IPolicyForHTTPS to wrap.
@type policyforHTTPS: L{IPolicyForHTTPS}
@param cacheSize: The maximum size of the hostname cache.
@type cacheSize: L{int}
N)_policyForHTTPS collections OrderedDict_cache
_cacheSize)r> policyforHTTPS cacheSizer' r' r( r? s
z#HostnameCachingHTTPSPolicy.__init__c C sh | d}z| j|}W n ty | j||}Y nw || j|< t| j| jkr2| jjdd |S )a<
Create a L{client connection creator
} for a
given network location and cache it for future use.
@param hostname: The hostname part of the URI.
@type hostname: L{bytes}
@param port: The port part of the URI.
@type port: L{int}
@return: a connection creator with appropriate verification
restrictions set
@rtype: L{client connection creator
}
r F)last) r$ r popKeyErrorr r lenr popitem)r> r r9 r8 creatorr' r' r( r s
z+HostnameCachingHTTPSPolicy.creatorForNetlocN)r r0 r1 r2 r3 r? r r' r' r' r( r v s
r c @ e Zd ZdZdd Zdd ZdS )_ContextFactoryWithContextz
A L{_ContextFactoryWithContext} is like a
L{twisted.internet.ssl.ContextFactory} with a pre-created context.
@ivar _context: A Context.
@type _context: L{OpenSSL.SSL.Context}
c C
|| _ dS )z
Initialize a L{_ContextFactoryWithContext} with a context.
@param context: An SSL context.
@type context: L{OpenSSL.SSL.Context}
N_context)r> contextr' r' r( r? s
z#_ContextFactoryWithContext.__init__c C | j S )z
Return the context created by
L{_DeprecatedToCurrentPolicyForHTTPS._webContextFactory}.
@return: A context.
@rtype: L{OpenSSL.SSL.Context}
r rM r' r' r( r s z%_ContextFactoryWithContext.getContextN)r0 r1 r2 r3 r? r r' r' r' r( r s r c @ r )"_DeprecatedToCurrentPolicyForHTTPSa+
Adapt a web context factory to a normal context factory.
@ivar _webContextFactory: An object providing a getContext method with
C{hostname} and C{port} arguments.
@type _webContextFactory: L{WebClientContextFactory} (or object with a
similar C{getContext} method).
c C r )a>
Wrap a web context factory in an L{IPolicyForHTTPS}.
@param webContextFactory: An object providing a getContext method with
C{hostname} and C{port} arguments.
@type webContextFactory: L{WebClientContextFactory} (or object with a
similar C{getContext} method).
N)_webContextFactory)r> webContextFactoryr' r' r( r? s
z+_DeprecatedToCurrentPolicyForHTTPS.__init__c C s | j ||}t|S )a
Called the wrapped web context factory's C{getContext} method with a
hostname and port number and return the resulting context object.
@param hostname: The hostname part of the URI.
@type hostname: L{bytes}
@param port: The port part of the URI.
@type port: L{int}
@return: A context factory.
@rtype: L{IOpenSSLContextFactory}
)r r r )r> r r9 r r' r' r( r s z3_DeprecatedToCurrentPolicyForHTTPS.creatorForNetlocNr r' r' r' r( r s r c @ sN e Zd ZdZedfddZdd Zdd Zd d
Zd d Z d
d Z
dd Z dS )FileBodyProducera
L{FileBodyProducer} produces bytes from an input file object incrementally
and writes them to a consumer.
Since file-like objects cannot be read from in an event-driven manner,
L{FileBodyProducer} uses a L{Cooperator} instance to schedule reads from
the file. This process is also paused and resumed based on notifications
from the L{IConsumer} provider being written to.
The file is closed after it has been read, or if the producer is stopped
early.
@ivar _inputFile: Any file-like object, bytes read from which will be
written to a consumer.
@ivar _cooperate: A method like L{Cooperator.cooperate} which is used to
schedule all reads.
@ivar _readSize: The number of bytes to read from C{_inputFile} at a time.
i c C s$ || _ |j| _|| _| || _d S rR )
_inputFile cooperate
_cooperate _readSize_determineLengthlength)r> inputFile
cooperatorreadSizer' r' r( r? s zFileBodyProducer.__init__c C sT z|j }|j}W n ty t Y S w | }|dtj | }||tj || S )z
Determine how many bytes can be read out of C{fObj} (assuming it is not
modified from this point on). If the determination cannot be made,
return C{UNKNOWN_LENGTH}.
r )seektellAttributeErrorr osSEEK_ENDSEEK_SET)r> fObjr r originalPositionendr' r' r( r s
z!FileBodyProducer._determineLengthc C s2 | j z| j W dS tjy Y dS w )z
Permanently stop writing bytes from the file to the consumer by
stopping the underlying L{CooperativeTask}.
N)r close_taskstopr TaskFinishedrM r' r' r(
stopProducing+ s
z FileBodyProducer.stopProducingc s< | _ j } fdd}|dd | |S )aZ
Start a cooperative task which will read bytes from the input file and
write them to C{consumer}. Return a L{Deferred} which fires after all
bytes have been written. If this L{Deferred} is cancelled before it is
fired, stop reading and writing bytes.
@param consumer: Any L{IConsumer} provider
c s6 | tjr t S | tjr t S | S rR )checkr CancelledErrorr r TaskStoppedDeferredreasonrM r' r( maybeStoppedB s z5FileBodyProducer.startProducing..maybeStoppedc S d S rR r' )ignoredr' r' r( M z1FileBodyProducer.startProducing..)r
_writeloopr whenDone addCallbacks)r> consumerdr r' rM r( startProducing6 s
z FileBodyProducer.startProducingc c s6 | j | j}|s| j dS || dV q)z
Return an iterator which reads one chunk of bytes from the input file
and writes them to the consumer for each time it is iterated.
TN)r readr r write)r> r bytesr' r' r( r P s
zFileBodyProducer._writeloopc C | j dS )z
Temporarily suspend copying bytes from the input file to the consumer
by pausing the L{CooperativeTask} which drives that activity.
N)r pauserM r' r' r( pauseProducing] s z FileBodyProducer.pauseProducingc C r )z
Undo the effects of a previous C{pauseProducing} and resume copying
bytes to the consumer by resuming the L{CooperativeTask} which drives
the write activity.
N)r resumerM r' r' r( resumeProducingd s z FileBodyProducer.resumeProducingN) r0 r1 r2 r3 r r? r r r r r r r' r' r' r( r s
r c @ s. e Zd ZdZdd ZdefddZdd Zd S )
_HTTP11ClientFactoryaa
A factory for L{HTTP11ClientProtocol}, used by L{HTTPConnectionPool}.
@ivar _quiescentCallback: The quiescent callback to be passed to protocol
instances, used to return them to the connection pool.
@ivar _metadata: Metadata about the low-level connection details,
used to make the repr more useful.
@since: 11.1
c C || _ || _d S rR )_quiescentCallback _metadata)r> quiescentCallbackmetadatar' r' r( r? z
z _HTTP11ClientFactory.__init__returnc C s d | j| jS )Nz _HTTP11ClientFactory({}, {}))formatr r rM r' r' r( __repr__~ s z _HTTP11ClientFactory.__repr__c C s
t | jS rR )rh r )r> addrr' r' r(
buildProtocol r z"_HTTP11ClientFactory.buildProtocolN)r0 r1 r2 r3 r? strr r r' r' r' r( r m s
r c @ ( e Zd ZdZdd Zdd Zdd ZdS ) _RetryingHTTP11ClientProtocolz
A wrapper for L{HTTP11ClientProtocol} that automatically retries requests.
@ivar _clientProtocol: The underlying L{HTTP11ClientProtocol}.
@ivar _newConnection: A callable that creates a new connection for a
retry.
c C r rR )_clientProtocol_newConnection)r> clientProtocol
newConnectionr' r' r( r? r z&_RetryingHTTP11ClientProtocol.__init__c C sX |dvrdS t |tttfsdS t |tr$|jD ] }|tjr# dS q|dur*dS dS )a
Indicate whether request should be retried.
Only returns C{True} if method is idempotent, no response was
received, the reason for the failed request was not due to
user-requested cancellation, and no body was sent. The latter
requirement may be relaxed in the future, and PUT added to approved
method list.
@param method: The method of the request.
@type method: L{bytes}
) GET HEADs OPTIONSs DELETEs TRACEFNT)
isinstancerl rm rq rr reasonsr r r )r> r exception bodyProduceraFailurer' r' r( _shouldRetry s
z*_RetryingHTTP11ClientProtocol._shouldRetryc s( j } fdd}|| |S )z
Do a request, and retry once (with a new connection) if it fails in
a retryable manner.
@param request: A L{Request} instance that will be requested using the
wrapped protocol.
c s. j| j jr fddS | S )Nc s
| S rR request)
connectionr r' r( r s
zG_RetryingHTTP11ClientProtocol.request..failed..)r r valuer r addCallbackr r r> r' r( failed s
z5_RetryingHTTP11ClientProtocol.request..failed)r r
addErrback)r> r r r r' r r( r s
z%_RetryingHTTP11ClientProtocol.requestN)r0 r1 r2 r3 r? r r r' r' r' r( r s
r c @ sX e Zd ZdZeZdZdZdZe Z
dddZ dd Z d d
Z
d d Zd
d Zdd ZdS )HTTPConnectionPoolaU
A pool of persistent HTTP connections.
Features:
- Cached connections will eventually time out.
- Limits on maximum number of persistent connections.
Connections are stored using keys, which should be chosen such that any
connections stored under a given key can be used interchangeably.
Failed requests done using previously cached connections will be retried
once if they use an idempotent method (e.g. GET), in case the HTTP server
timed them out.
@ivar persistent: Boolean indicating whether connections should be
persistent. Connections are persistent by default.
@ivar maxPersistentPerHost: The maximum number of cached persistent
connections for a C{host:port} destination.
@type maxPersistentPerHost: C{int}
@ivar cachedConnectionTimeout: Number of seconds a cached persistent
connection will stay open before disconnecting.
@ivar retryAutomatically: C{boolean} indicating whether idempotent
requests should be retried once if no response was received.
@ivar _factory: The factory used to connect to the proxy.
@ivar _connections: Map (scheme, host, port) to lists of
L{HTTP11ClientProtocol} instances.
@ivar _timeouts: Map L{HTTP11ClientProtocol} instances to a
C{IDelayedCall} instance of their timeout.
@since: 12.1
Tc C s || _ || _i | _i | _d S rR )_reactor
persistent _connections _timeouts)r> r\ r r' r' r( r? s
zHTTPConnectionPool.__init__c st j }|r4|d}j| j|= |jdkr2jr- fdd}t||}t |S |s
S )a
Supply a connection, newly created or retrieved from the pool, to be
used for one HTTP request.
The connection will remain out of the pool (not available to be
returned from future calls to this method) until one HTTP request has
been completed over it.
Afterwards, if the connection is still open, it will automatically be
added to the pool.
@param key: A unique key identifying connections that can be used
interchangeably.
@param endpoint: An endpoint that can be used to open a new connection
if no cached connection is available.
@return: A C{Deferred} that will fire with a L{HTTP11ClientProtocol}
(or a wrapper) that can be used to send a single HTTP request.
r QUIESCENTc s S rR )r r' endpointkeyr> r' r( r s z2HTTPConnectionPool.getConnection..) r getr r cancelstateretryAutomaticallyr r succeedr )r> r r connectionsr r r' r r(
getConnection s
z HTTPConnectionPool.getConnectionc s( fdd} |t|}||S )zv
Create a new connection.
This implements the new connection code path for L{getConnection}.
c s | d S rR )_putConnectionr
r r> r' r( r ' z.quiescentCallback)_factoryreprconnect)r> r r r rf r' r r( r s
z!HTTPConnectionPool._newConnectionc C s& |j | j| | | j|= dS )zG
Remove a connection from the cache and disconnect it.
N) transportloseConnectionr remover )r> r r r' r' r( _removeConnection- s
z$HTTPConnectionPool._removeConnectionc C s |j dkrztd ty | jd Y dS w | j|g }t|| jkr=| d}|j
| j |
| j |= || | j| j| j||}|| j |< dS )z
Return a persistent connection to the pool. This will be called by
L{HTTP11ClientProtocol} when the connection becomes quiescent.
r z5BUG: Non-quiescent protocol added to connection pool.Nr )r RuntimeError
BaseException_logfailurer
setdefaultr maxPersistentPerHostr r r r r
appendr callLatercachedConnectionTimeoutr )r> r r r droppedcidr' r' r( r 5 s,
z!HTTPConnectionPool._putConnectionc C sd g }| j D ]}|D ] }|| q qi | _ | j D ]}| q i | _t|dd S )z
Close all persistent connections and remove them from the pool.
@return: L{defer.Deferred} that fires when all connections have been
closed.
c S r rR r' )ignr' r' r( r ` r z;HTTPConnectionPool.closeCachedConnections..) r valuesr! abortr r
r
gatherResultsr )r> results protocolsr& dcr' r' r( closeCachedConnectionsQ s
z)HTTPConnectionPool.closeCachedConnectionsN)T)r0 r1 r2 r3 r r r r# r r r r? r r r r r- r' r' r' r( r s &
&
r c @ r )
_AgentBasea
Base class offering common facilities for L{Agent}-type classes.
@ivar _reactor: The C{IReactorTime} implementation which will be used by
the pool, and perhaps by subclasses as well.
@ivar _pool: The L{HTTPConnectionPool} used to manage HTTP connections.
c C s" |d u r t |d}|| _|| _d S NF)r r _pool)r> r\ poolr' r' r( r? m s
z_AgentBase.__init__c C s4 t t|r d| d }||fdv r|S d||f S )z
Compute the string to use for the value of the I{Host} header, based on
the given scheme, host name, and port number.
[ ]) httprB )r@ rA s %b:%d)r r )r> r5 r8 r9 r' r' r( _computeHostValues s
z _AgentBase._computeHostValuec
s t tstddt dtdu r t ds4 d j
j j j
||} fdd} || |S )zk
Issue a new request, given the endpoint and the path sent as part of
the request.
zmethod=z is z, but must be bytesNs hostc
s | tj jjdS )N)r parsedURI)r rj
_constructr0 r )protor headersr r7 requestPathr> r' r( cbConnected s z4_AgentBase._requestWithEndpoint..cbConnected)r r TypeErrortyper r hasHeadercopy addRawHeaderr6 r5 r8 r9 r0 r r )
r> r r r r7 r; r r< r r= r' r: r( _requestWithEndpoint~ s"
z _AgentBase._requestWithEndpointN)r0 r1 r2 r3 r? r6 rC r' r' r' r( r. c s
r. c @ r )_StandardEndpointFactorya
Standard HTTP endpoint destinations - TCP for HTTP, TCP+TLS for HTTPS.
@ivar _policyForHTTPS: A web context factory which will be used to create
SSL context objects for any SSL connections the agent needs to make.
@ivar _connectTimeout: If not L{None}, the timeout passed to
L{HostnameEndpoint} for specifying the connection timeout.
@ivar _bindAddress: If not L{None}, the address passed to
L{HostnameEndpoint} for specifying the local address to bind to.
c C s || _ || _|| _|| _dS )a
@param reactor: A provider to use to create endpoints.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param contextFactory: A factory for TLS contexts, to control the
verification parameters of OpenSSL.
@type contextFactory: L{IPolicyForHTTPS}.
@param connectTimeout: The amount of time that this L{Agent} will wait
for the peer to accept a connection.
@type connectTimeout: L{float} or L{None}
@param bindAddress: The local address for client sockets to bind to.
@type bindAddress: L{bytes} or L{None}
N)r r _connectTimeout _bindAddress)r> r\ rc connectTimeout bindAddressr' r' r( r? s
z!_StandardEndpointFactory.__init__c C s i }| j dur | j |d< | j|d< zt|j}W n ty' tdj|dw t| j||j fi |}|j
dkr;|S |j
dkrN| j |j|j }t
||S td|j
) z
Connect directly over TCP for C{b'http'} scheme, and TLS for
C{b'https'}.
@param uri: L{URI} to connect to.
@return: Endpoint to connect to.
@rtype: L{IStreamClientEndpoint}
NtimeoutrH zdThe host of the provided URI ({uri.host!r}) contains non-ASCII octets, it should be ASCII decodable.rJ r5 r@ zUnsupported scheme: )rE rF r r8 UnicodeDecodeErrorrH r r
r r9 r5 r r r rs )r> rJ re r8 r connectionCreatorr' r' r( endpointForURI s,
z'_StandardEndpointFactory.endpointForURIN)r0 r1 r2 r3 r? rM r' r' r' r( rD s
rD c @ sL e Zd ZdZe dddfddZed
ddZdd Zd d
Z dd d Z
dS )Agenta+
L{Agent} is a very basic HTTP client. It supports I{HTTP} and I{HTTPS}
scheme URIs.
@ivar _pool: An L{HTTPConnectionPool} instance.
@ivar _endpointFactory: The L{IAgentEndpointFactory} which will
be used to create endpoints for outgoing connections.
@since: 9.0
Nc C sJ t |stjt|d dtd t|}t||||}| ||| dS )a
Create an L{Agent}.
@param reactor: A reactor for this L{Agent} to place outgoing
connections.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param contextFactory: A factory for TLS contexts, to control the
verification parameters of OpenSSL. The default is to use a
L{BrowserLikePolicyForHTTPS}, so unless you have special
requirements you can leave this as-is.
@type contextFactory: L{IPolicyForHTTPS}.
@param connectTimeout: The amount of time that this L{Agent} will wait
for the peer to accept a connection.
@type connectTimeout: L{float}
@param bindAddress: The local address for client sockets to bind to.
@type bindAddress: L{bytes}
@param pool: An L{HTTPConnectionPool} instance, or L{None}, in which
case a non-persistent L{HTTPConnectionPool} instance will be
created.
@type pool: L{HTTPConnectionPool}
z was passed as the HTTPS policy for an Agent, but it does not provide IPolicyForHTTPS. Since Twisted 14.0, you must pass a provider of IPolicyForHTTPS.r )
stacklevelcategoryN) r!
providedBywarningswarnr DeprecationWarningr rD _init)r> r\ rc rG rH r1 endpointFactoryr' r' r( r? s
"zAgent.__init__c C s | | }|||| |S )a
Create a new L{Agent} that will use the endpoint factory to figure
out how to connect to the server.
@param reactor: A reactor for this L{Agent} to place outgoing
connections.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param endpointFactory: Used to construct endpoints which the
HTTP client will connect with.
@type endpointFactory: an L{IAgentEndpointFactory} provider.
@param pool: An L{HTTPConnectionPool} instance, or L{None}, in which
case a non-persistent L{HTTPConnectionPool} instance will be
created.
@type pool: L{HTTPConnectionPool}
@return: A new L{Agent}.
)__new__rU )rI r\ rV r1 agentr' r' r( usingEndpointFactory2 s
zAgent.usingEndpointFactoryc C s t | || || _dS )a
Initialize a new L{Agent}.
@param reactor: A reactor for this L{Agent} to place outgoing
connections.
@type reactor: see L{HostnameEndpoint.__init__} for acceptable reactor
types.
@param endpointFactory: Used to construct endpoints which the
HTTP client will connect with.
@type endpointFactory: an L{IAgentEndpointFactory} provider.
@param pool: An L{HTTPConnectionPool} instance, or L{None}, in which
case a non-persistent L{HTTPConnectionPool} instance will be
created.
@type pool: L{HTTPConnectionPool}
@return: A new L{Agent}.
N)r. r? _endpointFactory)r> r\ rV r1 r' r' r( rU L s
z Agent._initc C s | j |S )z
Get an endpoint for the given URI, using C{self._endpointFactory}.
@param uri: The URI of the request.
@type uri: L{URI}
@return: An endpoint which can be used to connect to given address.
)rZ rM )r> rJ r' r' r( _getEndpointc s zAgent._getEndpointc C sl t | }t|}z| |}W n ty! tt Y S w |j |j
|j f}| |||||||j
S )a)
Issue a request to the server indicated by the given C{uri}.
An existing connection from the connection pool may be used or a new
one may be created.
I{HTTP} and I{HTTPS} schemes are supported in C{uri}.
@see: L{twisted.web.iweb.IAgent.request}
)r r7 r4 rL r[ rs r failr r5 r8 r9 rC rQ )r> r rJ r; r r7 r r r' r' r( r n s"
z
Agent.requestrR NN) r0 r1 r2 r3 r r? rS rY rU r[ r r' r' r' r( rN s
1 rN c @ s$ e Zd ZdZdddZdddZdS )
ProxyAgentz
An HTTP agent able to cross HTTP proxies.
@ivar _proxyEndpoint: The endpoint used to connect to the proxy.
@since: 11.1
Nc C s, |d u r
ddl m} t| || || _d S )Nr r[ )r^ r\ r. r? _proxyEndpoint)r> r r\ r1 r' r' r( r? s
zProxyAgent.__init__c C s4 t | }d| jf}| || j|t||||S )z?
Issue a new request via the configured proxy.
z
http-proxy)r r7 r_ rC r4 rL )r> r rJ r; r r r' r' r( r s
zProxyAgent.requestr] )r0 r1 r2 r3 r? r r' r' r' r( r^ s
r^ c @ sR e Zd ZdZdd Zdd Zdd Zdd Zdd d Zd
d Z dd Z
dd Z d
S )_FakeUrllib2Requesta
A fake C{urllib2.Request} object for C{cookielib} to work with.
@see: U{http://docs.python.org/library/urllib2.html#request-objects}
@type uri: native L{str}
@ivar uri: Request URI.
@type headers: L{twisted.web.http_headers.Headers}
@ivar headers: Request headers.
@type type: native L{str}
@ivar type: The scheme of the URI.
@type host: native L{str}
@ivar host: The host[:port] of the URI.
@since: 11.1
c C sv t || _t | _t|}t |j| _t |j| _|j|j fdvr.| jdt
|j 7 _t |j| _ dd | _ dS )zn
Create a fake Urllib2 request.
@param uri: Request URI.
@type uri: L{bytes}
r4 :c S dS r/ r' )_r' r' r( r r z._FakeUrllib2Request.__init__..N)
r rJ r r; r4 rL r5 r? r8 r9 r origin_req_host unverifiable)r> rJ _urir' r' r( r? s
z _FakeUrllib2Request.__init__c C s | j t|S rR )r; r@ r )r> headerr' r' r(
has_header r z _FakeUrllib2Request.has_headerc C s | j t|t| d S rR )r; rB r )r> namer r' r' r( add_unredirected_header s z+_FakeUrllib2Request.add_unredirected_headerc C r rR rJ rM r' r' r( get_full_url z _FakeUrllib2Request.get_full_urlNc C s4 | j t||}|d urdd |D }|d S d S )Nc S g | ]}t |qS r' r r% xr' r' r(
z2_FakeUrllib2Request.get_header..r )r;
getRawHeadersr )r> ri defaultr; r' r' r(
get_header s
z _FakeUrllib2Request.get_headerc C r rR )r8 rM r' r' r( get_host rl z _FakeUrllib2Request.get_hostc C r rR )r? rM r' r' r( get_type rl z _FakeUrllib2Request.get_typec C rb r/ r' rM r' r' r( is_unverifiable s z#_FakeUrllib2Request.is_unverifiablerR ) r0 r1 r2 r3 r? rh rj rk ru rv rw rx r' r' r' r( r` s
r` c @ r )_FakeUrllib2Responsez
A fake C{urllib2.Response} object for C{cookielib} to work with.
@type response: C{twisted.web.iweb.IResponse}
@ivar response: Underlying Twisted Web response.
@since: 11.1
c C r rR responser> r{ r' r' r( r? r z _FakeUrllib2Response.__init__c s G fddd}| S )Nc s$ e Zd Z fddZ fddZdS )z(_FakeUrllib2Response.info.._Metac s j j|g }|S rR )r{ r; rs )zelfri r; rM r' r(
getheaders s z3_FakeUrllib2Response.info.._Meta.getheadersc s& j jt||}dd |D }|S )Nc S rm r' rn ro r' r' r( rq rr zD_FakeUrllib2Response.info.._Meta.get_all..)r{ r; rs r )r} ri rt r; hrM r' r( get_all s
z0_FakeUrllib2Response.info.._Meta.get_allN)r0 r1 r2 r~ r r' rM r' r( _Meta s r r' )r> r r' rM r( info s z_FakeUrllib2Response.infoN)r0 r1 r2 r3 r? r r' r' r' r( ry s ry c @ * e Zd ZdZdd Zd ddZdd ZdS )
CookieAgentaj
L{CookieAgent} extends the basic L{Agent} to add RFC-compliant
handling of HTTP cookies. Cookies are written to and extracted
from a C{cookielib.CookieJar} instance.
The same cookie jar instance will be used for any requests through this
agent, mutating it whenever a I{Set-Cookie} header appears in a response.
@type _agent: L{twisted.web.client.Agent}
@ivar _agent: Underlying Twisted Web agent to issue requests through.
@type cookieJar: C{cookielib.CookieJar}
@ivar cookieJar: Initialized cookie jar to read cookies from and store
cookies to.
@since: 11.1
c C r rR )_agent cookieJar)r> rX r r' r' r( r? + r zCookieAgent.__init__Nc C s| |du rt }t|}|ds,| j| |dd}|dur,| }|dt| | j
||||}| | j | |S )a
Issue a new request to the wrapped L{Agent}.
Send a I{Cookie} header if a cookie for C{uri} is stored in
L{CookieAgent.cookieJar}. Cookies are automatically extracted and
stored from requests.
If a C{'cookie'} header appears in C{headers} it will override the
automatic cookie header obtained from the cookie jar.
@see: L{Agent.request}
Ns cookieCookie)
r r` r@ r add_cookie_headerru rA rB r r r r _extractCookies)r> r rJ r; r lastRequest cookieHeaderr r' r' r( r / s
zCookieAgent.requestc C s t |}| j|| |S )z
Extract response cookies and store them in the cookie jar.
@type response: L{twisted.web.iweb.IResponse}
@param response: Twisted Web response.
@param request: A urllib2 compatible request object.
)ry r extract_cookies)r> r{ r respr' r' r( r L s zCookieAgent._extractCookiesr] )r0 r1 r2 r3 r? r r r' r' r' r( r s
r c @ r ) GzipDecoderz
A wrapper for a L{Response} instance which handles gzip'ed body.
@ivar original: The original L{Response} object.
@since: 11.1
c C s || _ t| _d S rR )originalr r r| r' r' r( r? c r zGzipDecoder.__init__c C s | j t|| j dS )zf
Override C{deliverBody} to wrap the given C{protocol} with
L{_GzipProtocol}.
N)r deliverBody
_GzipProtocol)r> r
r' r' r( r g s zGzipDecoder.deliverBodyN)r0 r1 r2 r3 r? r r' r' r' r( r Z s r c @ r ) r a0
A L{Protocol} implementation which wraps another one, transparently
decompressing received data.
@ivar _zlibDecompress: A zlib decompress object used to decompress the data
stream.
@ivar _response: A reference to the original response, in case of errors.
@since: 11.1
c C s" || _ || _tdtj | _d S )N )r _responsezlib
decompressobj MAX_WBITS_zlibDecompress)r> r
r{ r' r' r( r? | s z_GzipProtocol.__init__c C sJ z| j |}W n tjy tt g| jw |r#| j| dS dS )zz
Decompress C{data} with the zlib decompressor, forwarding the raw data
to the original protocol.
N) r
decompressr r rp r r r dataReceived)r> datarawDatar' r' r( r s z_GzipProtocol.dataReceivedc C sR z| j }W n tjy t|t g| jw |r!| j| | j | dS )zr
Forward the connection lost event, flushing remaining data from the
decompressor if any.
N)
r flushr r rp r r r r connectionLost)r> r r r' r' r( r s z _GzipProtocol.connectionLostNr0 r1 r2 r3 r? r r r' r' r' r( r o s
r c @ r )
ContentDecoderAgenta
An L{Agent} wrapper to handle encoded content.
It takes care of declaring the support for content in the
I{Accept-Encoding} header and automatically decompresses the received data
if the I{Content-Encoding} header indicates a supported encoding.
For example::
agent = ContentDecoderAgent(Agent(reactor),
[(b'gzip', GzipDecoder)])
@param agent: The agent to wrap
@type agent: L{IAgent}
@param decoders: A sequence of (name, decoder) objects. The name
declares which encoding the decoder supports. The decoder must accept
an L{IResponse} and return an L{IResponse} when called. The order
determines how the decoders are advertised to the server. Names must
be unique.not be duplicated.
@type decoders: sequence of (L{bytes}, L{callable}) tuples
@since: 11.1
@see: L{GzipDecoder}
c C s* || _ t|| _ddd |D | _d S )N ,c S s g | ]}|d qS )r r' )r% decoderr' r' r( rq rr z0ContentDecoderAgent.__init__..)r dict _decodersjoin
_supported)r> rX decodersr' r' r( r? s
z ContentDecoderAgent.__init__Nc C sD |du rt }n| }|d| j | j||||}|| jS )zv
Send a client request which declares supporting compressed content.
@see: L{Agent.request}.
Ns accept-encoding)r rA rB r r r r _handleResponser> r rJ r; r deferredr' r' r( r s zContentDecoderAgent.requestc C s |j dg }d|d}|r.| }| j|}|dur&||}n|| n|s|r=|j dd|g |S |j
d |S )zX
Check if the response is encoded, and wrap it to handle decompression.
s content-encodingr N) r; rs r splitr r7 r r r!
setRawHeaders removeHeader)r> r{ contentEncodingHeadersri r r' r' r( r s"
z#ContentDecoderAgent._handleResponser] )r0 r1 r2 r3 r? r r r' r' r' r( r s
r )s
Authorizations Cookies Cookie2s Proxy-Authorizations WWW-Authenticatec @ sn e Zd ZdZejejejejgZ ej
gZ dde de
dee fddZdd
d Zd d
Zdd Zdd Zd S )
RedirectAgenta
An L{Agent} wrapper which handles HTTP redirects.
The implementation is rather strict: 301 and 302 behaves like 307, not
redirecting automatically on methods different from I{GET} and I{HEAD}.
See L{BrowserLikeRedirectAgent} for a redirecting Agent that behaves more
like a web browser.
@param redirectLimit: The maximum number of times the agent is allowed to
follow redirects before failing with a L{error.InfiniteRedirection}.
@param sensitiveHeaderNames: An iterable of C{bytes} enumerating the names
of headers that must not be transmitted when redirecting to a different
origins. These will be consulted in addition to the protocol-specified
set of headers that contain sensitive information.
@cvar _redirectResponses: A L{list} of HTTP status codes to be redirected
for I{GET} and I{HEAD} methods.
@cvar _seeOtherResponses: A L{list} of HTTP status codes to be redirected
for any method and the method altered to I{GET}.
@since: 11.1
r r' rX
redirectLimitsensitiveHeaderNamesc C s. || _ || _dd |D }|t || _d S )Nc S s h | ]}t |qS r' )_canonicalHeaderName)r% eachr' r' r( rr z)RedirectAgent.__init__..)r _redirectLimitupdate_defaultSensitiveHeaders_sensitiveHeaderNames)r> rX r r sensitiver' r' r( r? s
zRedirectAgent.__init__Nc C s& | j ||||}|| j|||dS )zb
Send a client request following HTTP redirects.
@see: L{Agent.request}.
r )r r r r r r' r' r( r s zRedirectAgent.requestc C s
t ||S )a2
Resolve the redirect location against the request I{URI}.
@type requestURI: C{bytes}
@param requestURI: The request I{URI}.
@type location: C{bytes}
@param location: The redirect location.
@rtype: C{bytes}
@return: Final resolved I{URI}.
)rZ )r>
requestURIlocationr' r' r( _resolveLocation( s
z RedirectAgent._resolveLocationc s |j krtj jd|d}tt|g jdg }|s/t jd|}tt|g ||d }|rdt
|} t
|}
| j |
j koT| j
|
j
koT| j|
jk} | sdtfdd| D }j|||} fdd }
| |
| j||||d
S ) z
Handle a redirect response, checking the number of redirects already
followed, and extracting the location header fields.
s Infinite redirection detectedr s locations No location header fieldr c s i | ] \}}| j vr||qS r' )r )r% rawNamerawValuerM r' r(
R s
z1RedirectAgent._handleRedirect..c s | | S rR )setPreviousResponse) newResponserz r' r( _chainResponseZ s
z5RedirectAgent._handleRedirect.._chainResponserD )r r InfiniteRedirectioncoderp r r; rs RedirectWithNoLocationr r4 rL r5 r8 r9 r getAllRawHeadersr r r r )r> r{ r rJ r;
redirectCounterrlocationHeadersr r7 parsedLocation
sameOriginr r r' )r{ r> r( _handleRedirect7 s@
z RedirectAgent._handleRedirectc C sh |j | jv r#|dvrtj|j |d}tt|g|| |||||S |j | jv r2| |d|||S |S )zY
Handle the response, making another request if it indicates a redirect.
)r r r r )r _redirectResponsesr PageRedirectrp r r _seeOtherResponses)r> r{ r rJ r; r r r' r' r( r c s z RedirectAgent._handleResponse)r r' r] )r0 r1 r2 r3 r MOVED_PERMANENTLYFOUNDTEMPORARY_REDIRECTPERMANENT_REDIRECTr SEE_OTHERr r rG r r r? r r r r r' r' r' r( r s*
,r c @ s, e Zd ZdZejgZejejej ej
gZ dS )BrowserLikeRedirectAgentaO
An L{Agent} wrapper which handles HTTP redirects in the same fashion as web
browsers.
Unlike L{RedirectAgent}, the implementation is more relaxed: 301 and 302
behave like 303, redirecting automatically on any method and altering the
redirect request to a I{GET}.
@see: L{RedirectAgent}
@since: 13.1
N) r0 r1 r2 r3 r r r r r r r r r' r' r' r( r q s
r c @ r ) _ReadBodyProtocolak
Protocol that collects data sent to it.
This is a helper for L{IResponse.deliverBody}, which collects the body and
fires a deferred with it.
@ivar deferred: See L{__init__}.
@ivar status: See L{__init__}.
@ivar message: See L{__init__}.
@ivar dataBuffer: list of byte-strings received
@type dataBuffer: L{list} of L{bytes}
c C s || _ || _|| _g | _dS )a#
@param status: Status of L{IResponse}
@ivar status: L{int}
@param message: Message of L{IResponse}
@type message: L{bytes}
@param deferred: deferred to fire when response is complete
@type deferred: L{Deferred} firing with L{bytes}
N)r statusmessage
dataBuffer)r> r r r r' r' r( r? s
z_ReadBodyProtocol.__init__c C s | j | dS )z?
Accumulate some more bytes from the response.
N)r r! )r> r r' r' r( r s z _ReadBodyProtocol.dataReceivedc C s` | tr| jd| j dS | tr(| jt| j | j
d| j dS | j| dS )z
Deliver the accumulated response bytes to the waiting L{Deferred}, if
the response body has been completely received without error.
rO N) r ro r callbackr r ri errbackr/ r r )r> r r' r' r( r s
z _ReadBodyProtocol.connectionLostNr r' r' r' r( r s
r r{ r c sp dt jddf fdd }t |}t| j| j|fdd | jdur6 du r6tjdt d d
|S ) a
Get the body of an L{IResponse} and return it as a byte string.
This is a helper function for clients that don't want to incrementally
receive the body of an HTTP response.
@param response: The HTTP response for which the body will be read.
@type response: L{IResponse} provider
@return: A L{Deferred} which will fire with the body of the response.
Cancelling it will close the connection to the server immediately.
r r Nc s }|dur | dS dS )z
Cancel a L{readBody} call, close the connection to the HTTP server
immediately, if it is still open.
@param deferred: The cancelled L{defer.Deferred}.
Nr' )r r( )getAbortr' r( r
s
zreadBody..cancelc s t jdd S )NabortConnection)getattrr r' r r' r( r s zreadBody..getAbortzLUsing readBody with a transport that does not have an abortConnection methodr )rP rO )
r r r r phraser r rR rS rT )r{ r
r r' )r r
r( readBody s
r )rN r r r r r r r/ r^ r r rk rm rn ro rp rq r4 rR )vr3 r r rR r functoolsr typingr urllib.parser r r r* zope.interfacer incrementalr r^ r r
r twisted.internet.abstractr twisted.internet.endpointsr
r twisted.internet.interfacesr r twisted.loggerr twisted.python.compatr r twisted.python.componentsr twisted.python.deprecater r twisted.python.failurer twisted.webr r twisted.web._newclientr r twisted.web.http_headersr twisted.web.iwebr r r r r! r" Errorr/ r4 rZ rg rh ri rj rk rl rm rn ro rp rq rr twisted.web.errorrs OpenSSLrt ImportErrortwisted.internet.sslru rv rw r} r~ r r r1 r0 r r r r Factoryr r r r. rD rN r^ r` ry r r r r _canonicalNameCapsr frozensetr r r Protocolr r r r __all__r' r' r' r( s
r
4"
& @ 'o@ EJ 'E B,G 6 ,