twisted.web.client.CookieAgent : API documentation

class documentation

class twisted.web.client.CookieAgent: (source)

Implements interfaces: twisted.web.iweb.IAgent

CookieAgent extends the basic Agent to add RFC-compliant handling of HTTP cookies. Cookies are written to and extracted from a cookielib.CookieJar instance.

The same cookie jar instance will be used for any requests through this agent, mutating it whenever a Set-Cookie header appears in a response.

Present Since 11.1

Instance Variable	cookieJar	Initialized cookie jar to read cookies from and store cookies to.
Method	__init__	Undocumented
Method	request	Issue a new request to the wrapped `Agent`.
Instance Variable	_agent	Underlying Twisted Web agent to issue requests through.
Method	_extractCookies	Extract response cookies and store them in the cookie jar.

_agent = (source)

Underlying Twisted Web agent to issue requests through.

(type: twisted.web.client.Agent)

cookieJar = (source)

Initialized cookie jar to read cookies from and store cookies to.

(type: cookielib.CookieJar)

def __init__(self, agent, cookieJar): (source)

Undocumented

def request(self, method, uri, headers=None, bodyProducer=None): (source)

from twisted.web.iweb.IAgent

Issue a new request to the wrapped Agent.

Send a Cookie header if a cookie for uri is stored in CookieAgent.cookieJar. Cookies are automatically extracted and stored from requests.

If a 'cookie' header appears in headers it will override the automatic cookie header obtained from the cookie jar.

Parameters	response	Twisted Web response. (type: `twisted.web.iweb.IResponse`)
	request	A urllib2 compatible request object.