twisted.web.http_headers.Headers : API documentation

This class stores the HTTP headers as both a parsed representation and the raw string representation. It converts between the two on demand.

Instance Variables	_rawHeaders	A `dict` mapping header names as `str` to `lists` of header values as `str`.
Class Variables	_caseMappings	A `dict` that maps lowercase header names to their canonicalized representation.

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
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
Method	getAllRawHeaders	Return an iterator of key, value pairs of all headers contained in this
Method	_canonicalNameCaps	Return the canonical name for the given header.

def __cmp__(self, other): (source)

Define Headers instances as being equal to each other if they have the same raw headers.

def hasHeader(self, name): (source)

Check for the existence of a given header.

Parameters	name	The name of the HTTP header to check for. (type: `str` )
Returns	`True` if the header exists, otherwise `False`. (type: `bool` )

def removeHeader(self, name): (source)

Remove the named header from this header object.

Parameters	name	The name of the HTTP header to remove. (type: `str` )
Returns	`None`

def setRawHeaders(self, name, values): (source)

Sets the raw representation of the given header.

Parameters	name	The name of the HTTP header to set the values for. (type: `str` )
	values	A list of strings each one being a header value of the given name. (type: `list` )
Returns	`None`

def addRawHeader(self, name, value): (source)

Add a new raw value for the given header.

Parameters	name	The name of the header for which to set the value. (type: `str` )
	value	The value to set for the named header. (type: `str` )

def getRawHeaders(self, name, default=None): (source)

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: `str` )
	default	The value to return if no header with the given `name` exists.
Returns	A `list` of values for the given header. (type: `list` )

def getAllRawHeaders(self): (source)

Return an iterator of key, value pairs of all headers contained in this object, as strings. The keys are capitalized in canonical capitalization.

def _canonicalNameCaps(self, name): (source)

Return the canonical name for the given header.

Parameters	name	The all-lowercase header name to capitalize in its canonical form. (type: `str` )
Returns	The canonical name of the header. (type: `str` )

t.w.h.Headers(object) : class documentation