twisted.web.client : API documentation

HTTP client.

Function	urlunparse	Undocumented
Class	PartialDownloadError	Page was only partially downloaded, we got disconnected in middle.
Class	HTTPPageGetter	Gets a resource via HTTP, then quits.
Class	HTTPPageDownloader	Undocumented
Class	HTTPClientFactory	Download a given URL.
Class	HTTPDownloader	Download to a file.
Class	URI	A URI object.
Function	getPage	Download a web page as a string.
Function	downloadPage	Download a web page to a file.
Class	RequestGenerationFailed	There was an error while creating the bytes which make up a request.
Class	RequestTransmissionFailed	There was an error while sending the bytes which make up a request.
Class	Response	A `Response` instance describes an HTTP response received from an HTTP server.
Class	ResponseDone	`ResponseDone` may be passed to `IProtocol.connectionLost` on the protocol passed to `Response.deliverBody` and indicates that the entire response has been delivered.
Class	ResponseFailed	`ResponseFailed` indicates that all of the response to a request was not received for some reason.
Class	ResponseNeverReceived	A `ResponseFailed` that knows no response bytes at all have been received.
Class	WebClientContextFactory	This class is deprecated. Please simply use `Agent` as-is, or if you want to customize something, use `BrowserLikePolicyForHTTPS`.
Class	BrowserLikePolicyForHTTPS	SSL connection creator for web clients.
Class	FileBodyProducer	`FileBodyProducer` produces bytes from an input file object incrementally and writes them to a consumer.
Class	HTTPConnectionPool	A pool of persistent HTTP connections.
Class	Agent	`Agent` is a very basic HTTP client. It supports HTTP and HTTPS scheme URIs.
Class	ProxyAgent	An HTTP agent able to cross HTTP proxies.
Class	CookieAgent	`CookieAgent` extends the basic `Agent` to add RFC-compliant handling of HTTP cookies. Cookies are written to and extracted from a `cookielib.CookieJar` instance.
Class	GzipDecoder	A wrapper for a `Response` instance which handles gzip'ed body.
Class	ContentDecoderAgent	An `Agent` wrapper to handle encoded content.
Class	RedirectAgent	An `Agent` wrapper which handles HTTP redirects.
Class	BrowserLikeRedirectAgent	An `Agent` wrapper which handles HTTP redirects in the same fashion as web browsers.
Function	readBody	Get the body of an `IResponse` and return it as a byte string.
Function	_urljoin	No summary
Function	_makeGetterFactory	Create and connect an HTTP page getting factory.
Function	_deprecateGetPageClasses	Mark the protocols and factories associated with `getPage` and `downloadPage` as deprecated.
Function	_requireSSL	The decorated method requires pyOpenSSL to be present, or it raises `NotImplementedError`.
Class	_ContextFactoryWithContext	A `_ContextFactoryWithContext` is like a `twisted.internet.ssl.ContextFactory` with a pre-created context.
Class	_DeprecatedToCurrentPolicyForHTTPS	Adapt a web context factory to a normal context factory.
Class	_HTTP11ClientFactory	A factory for `HTTP11ClientProtocol`, used by `HTTPConnectionPool`.
Class	_RetryingHTTP11ClientProtocol	A wrapper for `HTTP11ClientProtocol` that automatically retries requests.
Class	_AgentBase	Base class offering common facilities for `Agent`-type classes.
Class	_StandardEndpointFactory	Standard HTTP endpoint destinations - TCP for HTTP, TCP+TLS for HTTPS.
Class	_FakeUrllib2Request	A fake `urllib2.Request` object for `cookielib` to work with.
Class	_FakeUrllib2Response	A fake `urllib2.Response` object for `cookielib` to work with.
Class	_GzipProtocol	A `Protocol` implementation which wraps another one, transparently decompressing received data.
Class	_ReadBodyProtocol	Protocol that collects data sent to it.

def urlunparse(parts): (source)

Undocumented

def _urljoin(base, url): (source)

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.

Parameters	base	Base URL. (type: `bytes`)
	url	URL to combine with `base`. (type: `bytes`)
Returns	An absolute URL resulting from the combination of `base` and `url`.
See Also	`urlparse.urljoin`
	https://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-22#section-7.1.2

def _makeGetterFactory(url, factoryFactory, *args, contextFactory=None, **kwargs): (source)

Create and connect an HTTP page getting factory.

Any additional positional or keyword arguments are used when calling factoryFactory.

Parameters	factoryFactory	Factory factory that is called with `url`, `args` and `kwargs` to produce the getter
	contextFactory	Context factory to use when creating a secure connection, defaulting to `None`
Returns	The factory created by `factoryFactory`

def _deprecateGetPageClasses(): (source)

Mark the protocols and factories associated with getPage and downloadPage as deprecated.

def getPage(url, *args, contextFactory=None, **kwargs): (source)

Download a web page as a string.

Download a page. Return a deferred, which will callback with a page (as a string) or errback with a description of the error.

See HTTPClientFactory to see what extra arguments can be passed.

def downloadPage(url, file, *args, contextFactory=None, **kwargs): (source)

Download a web page to a file.

Parameters

file

path to file on filesystem, or file-like object.

See HTTPDownloader to see what extra args can be passed.

def _requireSSL(decoratee): (source)

The decorated method requires pyOpenSSL to be present, or it raises NotImplementedError.

Parameters	decoratee	A function which requires pyOpenSSL. (type: `callable`)
Returns	A function which raises `NotImplementedError` if pyOpenSSL is not installed; otherwise, if it is installed, simply return `decoratee`. (type: `callable`)

def readBody(response): (source)

Get the body of an 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.

Parameters	response	The HTTP response for which the body will be read. (type: `IResponse` provider)
Returns	A `Deferred` which will fire with the body of the response. Cancelling it will close the connection to the server immediately.

API Documentation for Twisted, generated by pydoctor at 2017-06-11 10:59:01.

twisted.web.client module documentation

`twisted.web.client` module documentation