twisted.web.http_headers.Headers(object)
class documentationtwisted.web.http_headers
View Source
(View In Hierarchy)
Stores HTTP headers in a key and multiple value format.
Most methods accept bytes
and unicode
, with an internal bytes
representation. When passed unicode
, header names (e.g. 'Content-Type') are encoded using ISO-8859-1 and header values (e.g. 'text/html;charset=utf-8') are encoded using UTF-8. Some methods that return values will return them in the same type as the name given.
If the header keys or values cannot be encoded or decoded using the rules above, using just bytes
arguments to the methods of this class will ensure no decoding or encoding is done, and Headers
will treat the keys and values as opaque byte strings.
Method | __init__ | Undocumented |
Method | __repr__ | Return a string fully describing the headers set on this object. |
Method | __cmp__ | Define Headers instances as being equal to each other if they have the same raw headers. |
Method | copy | Return a copy of itself with the same headers set. |
Method | hasHeader | Check for the existence of a given header. |
Method | removeHeader | Remove the named header from this header object. |
Method | setRawHeaders | Sets the raw representation of the given header. |
Method | addRawHeader | Add a new raw value for the given header. |
Method | getRawHeaders | Returns a list of headers matching the given name as the raw string given. |
Method | getAllRawHeaders | Return an iterator of key, value pairs of all headers contained in this object, as bytes . The keys are capitalized in canonical capitalization. |
Class Variable | _caseMappings | A dict that maps lowercase header names to their canonicalized representation. |
Instance Variable | _rawHeaders | A dict mapping header names as bytes to list s of header values as bytes . |
Method | _encodeName | Encode the name of a header (eg 'Content-Type') to an ISO-8859-1 encoded bytestring if required. |
Method | _encodeValue | Encode a single header value to a UTF-8 encoded bytestring if required. |
Method | _encodeValues | Encode a list of header values to a list of UTF-8 encoded bytestrings if required. |
Method | _decodeValues | Decode a list of header values into a list of Unicode strings. |
Method | _canonicalNameCaps | Return the canonical name for the given header. |
dict
that maps lowercase header names to their canonicalized representation.Dict[str, str]
)
Define Headers
instances as being equal to each other if they have the same raw headers.
Returns a list of headers matching the given name as the raw string given.
Parameters | name | The name of the HTTP header to get the values of. (type: bytes or unicode ) |
default | The value to return if no header with the given name exists. | |
Returns | If the named header is present, a list of its values. Otherwise, default . (type: list of strings, same type as name (except when default is returned).) |