grab.util.cookies

THe module provides things to operate with cookies.

Manuals:

• http://docs.python.org/2/library/cookielib.html#cookie-objects

Some code got from

https://github.com/kennethreitz/requests/blob/master/requests/cookies.py

Module Contents

Classes

MockRequest	Wraps a requests.Request to mimic a urllib2.Request.
MockResponse	Wraps a httplib.HTTPMessage to mimic a urllib.addinfourl.

Functions

create_cookie(→ http.cookiejar.Cookie)	Create cookielib.Cookie instance.
build_cookie_header(→ None | str)	Build HTTP Cookie header value for given cookies.
build_jar(→ http.cookiejar.CookieJar)
extract_response_cookies(...)

class grab.util.cookies.MockRequest(url: str, headers: dict[str, str])

Wraps a requests.Request to mimic a urllib2.Request.

The code in cookielib.CookieJar expects this interface in order to correctly manage cookie policies, i.e., determine whether a cookie can be set, given the domains of the request and the cookie. The original request object is read-only. The client is responsible for collecting the new headers via get_new_headers() and interpreting them appropriately. You probably want get_cookie_header, defined below.

property unverifiable: bool

property origin_req_host: str

property host: str

get_type() → str

get_host() → str

get_origin_req_host() → str

get_full_url() → str

is_unverifiable() → bool

has_header(name: str) → bool

get_header(name: str, default: Any = None) → str

abstract add_header(key: str, val: str) → None

Cookielib has no legitimate use for this method.

Add it back if you find one.

add_unredirected_header(name: str, value: str) → None

get_new_headers() → dict[str, str]

class grab.util.cookies.MockResponse(headers: http.client.HTTPMessage | urllib3._collections.HTTPHeaderDict)

Wraps a httplib.HTTPMessage to mimic a urllib.addinfourl.

…what? Basically, expose the parsed HTTP headers from the server response the way cookielib expects to see them.

info() → http.client.HTTPMessage | urllib3._collections.HTTPHeaderDict

grab.util.cookies.create_cookie(*, name: str, value: str, domain: str, comment: None | str = None, comment_url: None | str = None, discard: bool = True, domain_initial_dot: None | bool = None, domain_specified: None | bool = None, expires: None | int = None, path: str = '/', path_specified: None | bool = None, port: None | int = None, port_specified: None | bool = None, rest: None | dict[str, Any] = None, rfc2109: bool = False, secure: bool = False, version: int = 0, httponly: None | bool = None) → http.cookiejar.Cookie

Create cookielib.Cookie instance.

grab.util.cookies.build_cookie_header(cookiejar: http.cookiejar.CookieJar, url: str, headers: collections.abc.Mapping[str, str]) → None | str

Build HTTP Cookie header value for given cookies.

grab.util.cookies.build_jar(cookies: collections.abc.Sequence[http.cookiejar.Cookie]) → http.cookiejar.CookieJar

grab.util.cookies.extract_response_cookies(req_url: str, req_headers: collections.abc.Mapping[str, Any] | http.client.HTTPMessage | urllib3._collections.HTTPHeaderDict, response_headers: http.client.HTTPMessage | urllib3._collections.HTTPHeaderDict) → collections.abc.Sequence[http.cookiejar.Cookie]