twisted.web.http

module documentation

(source)

HyperText Transfer Protocol implementation.

This is the basic server-side protocol implementation used by the Twisted Web server. It can parse HTTP 1.0 requests and supports many HTTP 1.1 features as well. Additionally, some functionality implemented here is also useful for HTTP clients (such as the chunked encoding parser).

Class	`HTTPChannel`	A receiver for HTTP requests.
Class	`HTTPClient`	A client for HTTP 1.0.
Class	`HTTPFactory`	Factory for HTTP server.
Class	`PotentialDataLoss`	No summary
Class	`Request`	A HTTP request.
Class	`StringTransport`	I am a BytesIO wrapper that conforms for the transport API. I support the `writeSequence' method.
Function	`combinedLogFormatter`
Function	`datetimeToLogString`	Convert seconds since epoch to log datetime string.
Function	`datetimeToString`	Convert seconds since epoch to HTTP datetime string.
Function	`fromChunk`	Convert chunk to string.
Function	`parse_qs`	Like `cgi.parse_qs`, but with support for parsing byte strings on Python 3.
Function	`parseContentRange`	Parse a content-range header into (start, end, realLength).
Function	`proxiedLogFormatter`
Function	`stringToDatetime`	Convert an HTTP date string (one of three formats) to seconds since epoch.
Function	`timegm`	Convert time tuple in GMT to seconds since epoch, GMT
Function	`toChunk`	Convert string to a chunk.
Function	`urlparse`	Parse an URL into six components.
Constant	`ACCEPTED`	Undocumented
Constant	`BAD_GATEWAY`	Undocumented
Constant	`BAD_REQUEST`	Undocumented
Constant	`CACHED`	A marker value to be returned from cache-related request methods to indicate to the caller that a cached response will be usable and no response body should be generated.
Constant	`CONFLICT`	Undocumented
Constant	`CREATED`	Undocumented
Constant	`EXPECTATION_FAILED`	Undocumented
Constant	`FORBIDDEN`	Undocumented
Constant	`FOUND`	Undocumented
Constant	`GATEWAY_TIMEOUT`	Undocumented
Constant	`GONE`	Undocumented
Constant	`H2_ENABLED`	Undocumented
Constant	`HTTP_VERSION_NOT_SUPPORTED`	Undocumented
Constant	`INSUFFICIENT_STORAGE_SPACE`	Undocumented
Constant	`INTERNAL_SERVER_ERROR`	Undocumented
Constant	`LENGTH_REQUIRED`	Undocumented
Constant	`MOVED_PERMANENTLY`	Undocumented
Constant	`MULTI_STATUS`	Undocumented
Constant	`MULTIPLE_CHOICE`	Undocumented
Constant	`NO_BODY_CODES`	Undocumented
Constant	`NO_CONTENT`	Undocumented
Constant	`NON_AUTHORITATIVE_INFORMATION`	Undocumented
Constant	`NOT_ACCEPTABLE`	Undocumented
Constant	`NOT_ALLOWED`	Undocumented
Constant	`NOT_EXTENDED`	Undocumented
Constant	`NOT_FOUND`	Undocumented
Constant	`NOT_IMPLEMENTED`	Undocumented
Constant	`NOT_MODIFIED`	Undocumented
Constant	`OK`	Undocumented
Constant	`PARTIAL_CONTENT`	Undocumented
Constant	`PAYMENT_REQUIRED`	Undocumented
Constant	`PERMANENT_REDIRECT`	Undocumented
Constant	`PRECONDITION_FAILED`	Undocumented
Constant	`PROXY_AUTH_REQUIRED`	Undocumented
Constant	`REQUEST_ENTITY_TOO_LARGE`	Undocumented
Constant	`REQUEST_TIMEOUT`	Undocumented
Constant	`REQUEST_URI_TOO_LONG`	Undocumented
Constant	`REQUESTED_RANGE_NOT_SATISFIABLE`	Undocumented
Constant	`RESET_CONTENT`	Undocumented
Constant	`RESPONSES`	Undocumented
Constant	`SEE_OTHER`	Undocumented
Constant	`SERVICE_UNAVAILABLE`	Undocumented
Constant	`SWITCHING`	Undocumented
Constant	`TEMPORARY_REDIRECT`	Undocumented
Constant	`UNAUTHORIZED`	Undocumented
Constant	`UNSUPPORTED_MEDIA_TYPE`	Undocumented
Constant	`USE_PROXY`	Undocumented
Variable	`monthname`	Undocumented
Variable	`monthname_lower`	Undocumented
Variable	`protocol_version`	Undocumented
Variable	`weekdayname`	Undocumented
Variable	`weekdayname_lower`	Undocumented
Interface	`_IDeprecatedHTTPChannelToRequestInterface`	The interface `HTTPChannel` expects of `Request`.
Class	`_ChunkedTransferDecoder`	No summary
Class	`_DataLoss`	No summary
Class	`_GenericHTTPChannelProtocol`	A proxy object that wraps one of the HTTP protocol objects, and switches between them depending on TLS negotiated protocol.
Class	`_IdentityTransferDecoder`	Protocol for accumulating bytes up to a specified length. This handles the case where no Transfer-Encoding is specified.
Class	`_MalformedChunkedDataError`	No summary
Class	`_NoPushProducer`	A no-op version of `interfaces.IPushProducer`, used to abstract over the possibility that a `HTTPChannel` transport does not provide `IPushProducer`.
Class	`_XForwardedForAddress`	`IAddress` which represents the client IP to log for a request, as gleaned from an X-Forwarded-For header.
Class	`_XForwardedForRequest`	Add a layer on top of another request that only uses the value of an X-Forwarded-For header as the result of `getClientAddress`.
Function	`_escape`	Return a string like python repr, but always escaped as if surrounding quotes were double quotes.
Function	`_genericHTTPChannelProtocolFactory`	Returns an appropriately initialized _GenericHTTPChannelProtocol.
Function	`_getContentFile`	Get a writeable file-like object to which request content can be written.
Function	`_parseHeader`	Undocumented
Constant	`_QUEUED_SENTINEL`	Undocumented
Constant	`_REQUEST_TIMEOUT`	Undocumented
Variable	`_hostHeaderExpression`	Undocumented

@provider(IAccessLogFormatter)
def combinedLogFormatter(timestamp, request): (source)

Returns
A combined log formatted log line for the given request.
See Also
`IAccessLogFormatter`

def datetimeToLogString(msSinceEpoch=None): (source)

Convert seconds since epoch to log datetime string.

Returns
`str`	Undocumented

def datetimeToString(msSinceEpoch=None): (source)

Convert seconds since epoch to HTTP datetime string.

Returns
`bytes`	Undocumented

def fromChunk(data): (source)

Convert chunk to string.

Parameters
data:`bytes`	Undocumented
Returns
tuple of (result, remaining) - both `bytes`.
Raises
`ValueError`	If the given data is not a correctly formatted chunked byte string.

def parse_qs(qs, keep_blank_values=0, strict_parsing=0): (source)

Like cgi.parse_qs, but with support for parsing byte strings on Python 3.

Parameters
qs:`bytes`	Undocumented
keep_blank_values	Undocumented
strict_parsing	Undocumented

def parseContentRange(header): (source)

Parse a content-range header into (start, end, realLength).

realLength might be None if real length is not known ('*').

@provider(IAccessLogFormatter)
def proxiedLogFormatter(timestamp, request): (source)

Returns
A combined log formatted log line for the given request but use the value of the X-Forwarded-For header as the value for the client IP address.
See Also
`IAccessLogFormatter`

def stringToDatetime(dateString): (source)

Convert an HTTP date string (one of three formats) to seconds since epoch.

Parameters
dateString:`bytes`	Undocumented

def timegm(year, month, day, hour, minute, second): (source)

Convert time tuple in GMT to seconds since epoch, GMT

def toChunk(data): (source)

Convert string to a chunk.

Parameters
data:`bytes`	Undocumented
Returns
a tuple of `bytes` representing the chunked encoding of data

def urlparse(url): (source)

Parse an URL into six components.

This is similar to urlparse.urlparse, but rejects str input and always produces bytes output.

Parameters
url:`bytes`	Undocumented
Returns
`ParseResultBytes`	The scheme, net location, path, params, query string, and fragment of the URL - all as `bytes`.
Raises
`TypeError`	The given url was a `str` string instead of a `bytes`.

ACCEPTED: int = (source)

Undocumented

Value

BAD_GATEWAY: int = (source)

Undocumented

Value

BAD_REQUEST: int = (source)

Undocumented

Value

CACHED: str = (source)

A marker value to be returned from cache-related request methods to indicate to the caller that a cached response will be usable and no response body should be generated.

Value

'''Magic constant returned by http.Request methods to set cache
validation headers when the request is conditional and the value fails
the condition.'''

CONFLICT: int = (source)

Undocumented

Value

CREATED: int = (source)

Undocumented

Value

EXPECTATION_FAILED: int = (source)

Undocumented

Value

FORBIDDEN: int = (source)

Undocumented

Value

FOUND: int = (source)

Undocumented

Value

GATEWAY_TIMEOUT: int = (source)

Undocumented

Value

GONE: int = (source)

Undocumented

Value

H2_ENABLED: bool = (source)

Undocumented

Value

False

HTTP_VERSION_NOT_SUPPORTED: int = (source)

Undocumented

Value

INSUFFICIENT_STORAGE_SPACE: int = (source)

Undocumented

Value

INTERNAL_SERVER_ERROR: int = (source)

Undocumented

Value

LENGTH_REQUIRED: int = (source)

Undocumented

Value

MOVED_PERMANENTLY: int = (source)

Undocumented

Value

MULTI_STATUS: int = (source)

Undocumented

Value

MULTIPLE_CHOICE: int = (source)

Undocumented

Value

NO_BODY_CODES: tuple[int, ...] = (source)

Undocumented

Value

(204, 304)

NO_CONTENT: int = (source)

Undocumented

Value

NON_AUTHORITATIVE_INFORMATION: int = (source)

Undocumented

Value

NOT_ACCEPTABLE: int = (source)

Undocumented

Value

NOT_ALLOWED: int = (source)

Undocumented

Value

NOT_EXTENDED: int = (source)

Undocumented

Value

NOT_FOUND: int = (source)

Undocumented

Value

NOT_IMPLEMENTED: int = (source)

Undocumented

Value

NOT_MODIFIED: int = (source)

Undocumented

Value

OK: int = (source)

Undocumented

Value

PARTIAL_CONTENT: int = (source)

Undocumented

Value

PAYMENT_REQUIRED: int = (source)

Undocumented

Value

PERMANENT_REDIRECT: int = (source)

Undocumented

Value

PRECONDITION_FAILED: int = (source)

Undocumented

Value

PROXY_AUTH_REQUIRED: int = (source)

Undocumented

Value

REQUEST_ENTITY_TOO_LARGE: int = (source)

Undocumented

Value

REQUEST_TIMEOUT: int = (source)

Undocumented

Value

REQUEST_URI_TOO_LONG: int = (source)

Undocumented

Value

REQUESTED_RANGE_NOT_SATISFIABLE: int = (source)

Undocumented

Value

RESET_CONTENT: int = (source)

Undocumented

Value

RESPONSES = (source)

Undocumented

Value

{_CONTINUE: b'Continue',
 SWITCHING: b'Switching Protocols',
 OK: b'OK',
 CREATED: b'Created',
 ACCEPTED: b'Accepted',
 NON_AUTHORITATIVE_INFORMATION: b'Non-Authoritative Information',
 NO_CONTENT: b'No Content',
...

SEE_OTHER: int = (source)

Undocumented

Value

SERVICE_UNAVAILABLE: int = (source)

Undocumented

Value

SWITCHING: int = (source)

Undocumented

Value

TEMPORARY_REDIRECT: int = (source)

Undocumented

Value

UNAUTHORIZED: int = (source)

Undocumented

Value

UNSUPPORTED_MEDIA_TYPE: int = (source)

Undocumented

Value

USE_PROXY: int = (source)

Undocumented

Value

monthname: list = (source)

Undocumented

monthname_lower = (source)

Undocumented

protocol_version: str = (source)

Undocumented

weekdayname: list[str] = (source)

Undocumented

weekdayname_lower = (source)

Undocumented

def _escape(s): (source)

Return a string like python repr, but always escaped as if surrounding quotes were double quotes.

Parameters
s:`bytes` or `str`	The string to escape.
Returns
`str`	An escaped string.

def _genericHTTPChannelProtocolFactory(self): (source)

Returns an appropriately initialized _GenericHTTPChannelProtocol.

def _getContentFile(length): (source)

Get a writeable file-like object to which request content can be written.

def _parseHeader(line): (source)

Undocumented

_QUEUED_SENTINEL = (source)

Undocumented

Value

object()

_REQUEST_TIMEOUT = (source)

Undocumented

Value

1*60

_hostHeaderExpression = (source)

Undocumented