pip._vendor.requests.cookies Namespace Reference

Classes
class	CookieConflictError
class	MockRequest
class	MockResponse
class	RequestsCookieJar

Functions
	extract_cookies_to_jar (jar, request, response)
	get_cookie_header (jar, request)
	remove_cookie_by_name (cookiejar, name, domain=None, path=None)
	_copy_cookie_jar (jar)
	create_cookie (name, value, **kwargs)
	morsel_to_cookie (morsel)
	cookiejar_from_dict (cookie_dict, cookiejar=None, overwrite=True)
	merge_cookies (cookiejar, cookies)

Detailed Description

requests.cookies
~~~~~~~~~~~~~~~~

Compatibility code to be able to use `cookielib.CookieJar` with requests.

requests.utils imports from here, so be careful with imports.

Function Documentation

cookiejar_from_dict()

pip._vendor.requests.cookies.cookiejar_from_dict	(		cookie_dict,
			cookiejar = None,
			overwrite = True
	)

Returns a CookieJar from a key/value dictionary.

:param cookie_dict: Dict of key/values to insert into CookieJar.
:param cookiejar: (optional) A cookiejar to add the cookies to.
:param overwrite: (optional) If False, will not replace cookies
    already in the jar with new ones.
:rtype: CookieJar

create_cookie()

pip._vendor.requests.cookies.create_cookie	(		name,
			value,
		**	kwargs
	)

Make a cookie from underspecified parameters.

By default, the pair of `name` and `value` will be set for the domain ''
and sent on every request (this is sometimes called a "supercookie").

extract_cookies_to_jar()

pip._vendor.requests.cookies.extract_cookies_to_jar	(		jar,
			request,
			response
	)

Extract the cookies from the response into a CookieJar.

:param jar: cookielib.CookieJar (not necessarily a RequestsCookieJar)
:param request: our own requests.Request object
:param response: urllib3.HTTPResponse object

get_cookie_header()

pip._vendor.requests.cookies.get_cookie_header	(		jar,
			request
	)

Produce an appropriate Cookie header string to be sent with `request`, or None.

:rtype: str

merge_cookies()

pip._vendor.requests.cookies.merge_cookies	(		cookiejar,
			cookies
	)

Add cookies to cookiejar and returns a merged CookieJar.

:param cookiejar: CookieJar object to add the cookies to.
:param cookies: Dictionary or CookieJar object to be added.
:rtype: CookieJar

morsel_to_cookie()

pip._vendor.requests.cookies.morsel_to_cookie

(

morsel

)

Convert a Morsel object into a Cookie containing the one k/v pair.

remove_cookie_by_name()

pip._vendor.requests.cookies.remove_cookie_by_name	(		cookiejar,
			name,
			domain = None,
			path = None
	)

Unsets a cookie by name, by default over all domains and paths.

Wraps CookieJar.clear(), is O(n).