pip._vendor.requests.cookies Namespace Reference

Data Structures
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

_copy_cookie_jar()

_copy_cookie_jar (   jar )

protected

Definition at line 440 of file cookies.py.

def _copy_cookie_jar(jar):
    if jar is None:
        return None
 
    if hasattr(jar, "copy"):
        # We're dealing with an instance of RequestsCookieJar
        return jar.copy()
    # We're dealing with a generic CookieJar instance
    new_jar = copy.copy(jar)
    new_jar.clear()
    for cookie in jar:
        new_jar.set_cookie(copy.copy(cookie))
    return new_jar
 
 

References i.

cookiejar_from_dict()

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

Definition at line 521 of file cookies.py.

def 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
    """
    if cookiejar is None:
        cookiejar = RequestsCookieJar()
 
    if cookie_dict is not None:
        names_from_jar = [cookie.name for cookie in cookiejar]
        for name in cookie_dict:
            if overwrite or (name not in names_from_jar):
                cookiejar.set_cookie(create_cookie(name, cookie_dict[name]))
 
    return cookiejar
 
 

References pip._vendor.requests.cookies.create_cookie(), and i.

Here is the call graph for this function:

create_cookie()

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").

Definition at line 455 of file cookies.py.

def 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").
    """
    result = {
        "version": 0,
        "name": name,
        "value": value,
        "port": None,
        "domain": "",
        "path": "/",
        "secure": False,
        "expires": None,
        "discard": True,
        "comment": None,
        "comment_url": None,
        "rest": {"HttpOnly": None},
        "rfc2109": False,
    }
 
    badargs = set(kwargs) - set(result)
    if badargs:
        raise TypeError(
            f"create_cookie() got unexpected keyword arguments: {list(badargs)}"
        )
 
    result.update(kwargs)
    result["port_specified"] = bool(result["port"])
    result["domain_specified"] = bool(result["domain"])
    result["domain_initial_dot"] = result["domain"].startswith(".")
    result["path_specified"] = bool(result["path"])
 
    return cookielib.Cookie(**result)
 
 

References i.

Referenced by pip._vendor.requests.cookies.cookiejar_from_dict(), pip._vendor.requests.cookies.morsel_to_cookie(), and RequestsCookieJar.set().

Here is the caller graph for this function:

extract_cookies_to_jar()

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

Definition at line 124 of file cookies.py.

def 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
    """
    if not (hasattr(response, "_original_response") and response._original_response):
        return
    # the _original_response field is the wrapped httplib.HTTPResponse object,
    req = MockRequest(request)
    # pull out the HTTPMessage with the headers and put it in the mock:
    res = MockResponse(response._original_response.msg)
    jar.extract_cookies(res, req)
 
 

References i.

get_cookie_header()

get_cookie_header	(		jar,
			request
	)

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

:rtype: str

Definition at line 140 of file cookies.py.

def get_cookie_header(jar, request):
    """
    Produce an appropriate Cookie header string to be sent with `request`, or None.
 
    :rtype: str
    """
    r = MockRequest(request)
    jar.add_cookie_header(r)
    return r.get_new_headers().get("Cookie")
 
 

References i.

merge_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

Definition at line 542 of file cookies.py.

def 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
    """
    if not isinstance(cookiejar, cookielib.CookieJar):
        raise ValueError("You can only merge into CookieJar")
 
    if isinstance(cookies, dict):
        cookiejar = cookiejar_from_dict(cookies, cookiejar=cookiejar, overwrite=False)
    elif isinstance(cookies, cookielib.CookieJar):
        try:
            cookiejar.update(cookies)
        except AttributeError:
            for cookie_in_jar in cookies:
                cookiejar.set_cookie(cookie_in_jar)
 
    return cookiejar

References i.

morsel_to_cookie()

morsel_to_cookie

(

morsel

)

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

Definition at line 492 of file cookies.py.

def morsel_to_cookie(morsel):
    """Convert a Morsel object into a Cookie containing the one k/v pair."""
 
    expires = None
    if morsel["max-age"]:
        try:
            expires = int(time.time() + int(morsel["max-age"]))
        except ValueError:
            raise TypeError(f"max-age: {morsel['max-age']} must be integer")
    elif morsel["expires"]:
        time_template = "%a, %d-%b-%Y %H:%M:%S GMT"
        expires = calendar.timegm(time.strptime(morsel["expires"], time_template))
    return create_cookie(
        comment=morsel["comment"],
        comment_url=bool(morsel["comment"]),
        discard=False,
        domain=morsel["domain"],
        expires=expires,
        name=morsel.key,
        path=morsel["path"],
        port=None,
        rest={"HttpOnly": morsel["httponly"]},
        rfc2109=False,
        secure=bool(morsel["secure"]),
        value=morsel.value,
        version=morsel["version"] or 0,
    )
 
 

References pip._vendor.requests.cookies.create_cookie(), and i.

Referenced by RequestsCookieJar.set().

Here is the call graph for this function:

Here is the caller graph for this function:

remove_cookie_by_name()

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).

Definition at line 151 of file cookies.py.

def 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).
    """
    clearables = []
    for cookie in cookiejar:
        if cookie.name != name:
            continue
        if domain is not None and domain != cookie.domain:
            continue
        if path is not None and path != cookie.path:
            continue
        clearables.append((cookie.domain, cookie.path, cookie.name))
 
    for domain, path, name in clearables:
        cookiejar.clear(domain, path, name)
 
 

References i.

Referenced by RequestsCookieJar.__delitem__(), and RequestsCookieJar.set().

Here is the caller graph for this function: