3
aj G
@ s d Z ddlZddlZddlZddlZddlmZ ddlmZm Z m
Z
m Z y ddl Z W n e
k
rp ddlZ Y nX G dd deZG dd d eZd
d Zd d
Zd ddZG dd deZG dd dejejZdd Zdd Zdd Z d dd Z d d Z dS )!z
requests.cookies
~~~~~~~~~~~~~~~~
Compatibility code to be able to use `cookielib.CookieJar` with requests.
requests.utils imports from here, so be careful with imports.
N )to_native_string) cookieliburlparse
urlunparseMorselc @ s e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
d ddZ dd Z dd Z
dd Zedd Zedd Zed d ZdS ) MockRequesta 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.
c C s || _ i | _t| j jj| _d S )N)_r _new_headersr urlschemetype)selfrequest r /usr/lib/python3.6/cookies.py__init__& s zMockRequest.__init__c C s | j S )N)r
)r r r r get_type+ s zMockRequest.get_typec C s t | jjjS )N)r r r Znetloc)r r r r get_host. s zMockRequest.get_hostc C s | j S )N)r )r r r r get_origin_req_host1 s z MockRequest.get_origin_req_hostc C sT | j jjds| j jS t| j jd dd}t| j j}t|j||j|j |j
|j gS )NZHostzutf-8)encoding) r headersgetr r r r r pathZparamsZqueryZfragment)r hostZparsedr r r get_full_url4 s zMockRequest.get_full_urlc C s dS )NTr )r r r r is_unverifiableB s zMockRequest.is_unverifiablec C s || j jkp|| jkS )N)r r r
)r namer r r
has_headerE s zMockRequest.has_headerNc C s | j jj|| jj||S )N)r r r r
)r r defaultr r r
get_headerH s zMockRequest.get_headerc C s t ddS )zMcookielib has no legitimate use for this method; add it back if you find one.z=Cookie headers should be added with add_unredirected_header()N)NotImplementedError)r keyvalr r r
add_headerK s zMockRequest.add_headerc C s || j |< d S )N)r
)r r valuer r r add_unredirected_headerO s z#MockRequest.add_unredirected_headerc C s | j S )N)r
)r r r r get_new_headersR s zMockRequest.get_new_headersc C s | j S )N)r )r r r r unverifiableU s zMockRequest.unverifiablec C s | j S )N)r )r r r r origin_req_hostY s zMockRequest.origin_req_hostc C s | j S )N)r )r r r r r ] s zMockRequest.host)N)__name__
__module__ __qualname____doc__r r r r r r r r r$ r& r' propertyr( r) r r r r r r s
r c @ s( e Zd ZdZdd Zdd Zdd ZdS ) MockResponsezWraps 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.
c C s
|| _ dS )zMake a MockResponse for `cookielib` to read.
:param headers: a httplib.HTTPMessage or analogous carrying the headers
N)_headers)r r r r r r i s zMockResponse.__init__c C s | j S )N)r0 )r r r r infop s zMockResponse.infoc C s | j j| d S )N)r0
getheaders)r r r r r r2 s s zMockResponse.getheadersN)r* r+ r, r- r r1 r2 r r r r r/ b s r/ c C s8 t |do|jsdS t|}t|jj}| j|| dS )zExtract 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
_original_responseN)hasattrr3 r r/ msgZextract_cookies)jarr ZresponseZreqresr r r extract_cookies_to_jarw s
r8 c C s t |}| j| |j jdS )zj
Produce an appropriate Cookie header string to be sent with `request`, or None.
:rtype: str
Cookie)r Zadd_cookie_headerr' r )r6 r rr r r get_cookie_header s
r; c C s g }xV| D ]N}|j |krq
|dk r.||jkr.q
|dk rB||jkrBq
|j|j|j|j f q
W x |D ]\}}}| j||| qbW dS )zkUnsets a cookie by name, by default over all domains and paths.
Wraps CookieJar.clear(), is O(n).
N)r domainr appendclear) cookiejarr r< r Z
clearablescookier r r remove_cookie_by_name s
rA c @ s e Zd ZdZdS )CookieConflictErrorzThere are two cookies that meet the criteria specified in the cookie jar.
Use .get and .set and include domain and path args in order to be more specific.
N)r* r+ r, r- r r r r rB s rB c s e Zd ZdZd1ddZdd Zdd Zd d
Zd d Zd
d Z dd Z
dd Z dd Z dd Z
dd Zd2ddZ fdd Zd d Zd d Zd!d" Z fd#d$Z fd%d&Zd3d'd(Zd4d)d*Zd+d, Zd-d. Zd/d0 Z ZS )5RequestsCookieJara Compatibility class; is a cookielib.CookieJar, but exposes a dict
interface.
This is the CookieJar we create by default for requests and sessions that
don't specify one, since some clients may expect response.cookies and
session.cookies to support dict operations.
Requests does not use the dict interface internally; it's just for
compatibility with external client code. All requests code should work
out of the box with externally provided instances of ``CookieJar``, e.g.
``LWPCookieJar`` and ``FileCookieJar``.
Unlike a regular CookieJar, this class is pickleable.
.. warning:: dictionary operations that are normally O(1) may be O(n).
Nc C s( y| j |||S tk
r" |S X dS )zDict-like get() that also supports optional domain and path args in
order to resolve naming collisions from using one cookie jar over
multiple domains.
.. warning:: operation is O(n), not O(1).
N)_find_no_duplicatesKeyError)r r r r< r r r r r s zRequestsCookieJar.getc K sX |dkr(t | ||jd|jdd dS t|tr<t|}nt||f|}| j| |S )zDict-like set() that also supports optional domain and path args in
order to resolve naming collisions from using one cookie jar over
multiple domains.
Nr< r )r< r )rA r
isinstancer morsel_to_cookie
create_cookie
set_cookie)r r r% kwargscr r r set s
zRequestsCookieJar.setc c s xt | D ] }|jV q
W dS )zDict-like iterkeys() that returns an iterator of names of cookies
from the jar.
.. seealso:: itervalues() and iteritems().
N)iterr )r r@ r r r iterkeys s zRequestsCookieJar.iterkeysc C s t | j S )zDict-like keys() that returns a list of names of cookies from the
jar.
.. seealso:: values() and items().
)listrN )r r r r keys s zRequestsCookieJar.keysc c s xt | D ] }|jV q
W dS )zDict-like itervalues() that returns an iterator of values of cookies
from the jar.
.. seealso:: iterkeys() and iteritems().
N)rM r% )r r@ r r r
itervalues s z RequestsCookieJar.itervaluesc C s t | j S )zDict-like values() that returns a list of values of cookies from the
jar.
.. seealso:: keys() and items().
)rO rQ )r r r r values s zRequestsCookieJar.valuesc c s$ x t | D ]}|j|jfV q
W dS )zDict-like iteritems() that returns an iterator of name-value tuples
from the jar.
.. seealso:: iterkeys() and itervalues().
N)rM r r% )r r@ r r r iteritems s zRequestsCookieJar.iteritemsc C s t | j S )zDict-like items() that returns a list of name-value tuples from the
jar. Allows client-code to call ``dict(RequestsCookieJar)`` and get a
vanilla python dict of key value pairs.
.. seealso:: keys() and values().
)rO rS )r r r r items s zRequestsCookieJar.itemsc C s0 g }x&t | D ]}|j|kr|j|j qW |S )z2Utility method to list all the domains in the jar.)rM r< r= )r domainsr@ r r r list_domains s
z RequestsCookieJar.list_domainsc C s0 g }x&t | D ]}|j|kr|j|j qW |S )z0Utility method to list all the paths in the jar.)rM r r= )r pathsr@ r r r
list_paths s
z RequestsCookieJar.list_pathsc C s> g }x4t | D ](}|jdk r*|j|kr*dS |j|j qW dS )zvReturns True if there are multiple domains in the jar.
Returns False otherwise.
:rtype: bool
NTF)rM r< r= )r rU r@ r r r multiple_domains s z"RequestsCookieJar.multiple_domainsc C sJ i }x@t | D ]4}|dks$|j|kr|dks6|j|kr|j||j< qW |S )zTakes as an argument an optional domain and path and returns a plain
old Python dict of name-value pairs of cookies that meet the
requirements.
:rtype: dict
N)rM r< r r% r )r r< r Z
dictionaryr@ r r r get_dict, s zRequestsCookieJar.get_dictc s* yt t| j|S tk
r$ dS X d S )NT)superrC __contains__rB )r r ) __class__r r r\ < s z RequestsCookieJar.__contains__c C s
| j |S )zDict-like __getitem__() for compatibility with client code. Throws
exception if there are more than one cookie with name. In that case,
use the more explicit get() method instead.
.. warning:: operation is O(n), not O(1).
)rD )r r r r r __getitem__B s z RequestsCookieJar.__getitem__c C s | j || dS )zDict-like __setitem__ for compatibility with client code. Throws
exception if there is already a cookie of that name in the jar. In that
case, use the more explicit set() method instead.
N)rL )r r r% r r r __setitem__K s z RequestsCookieJar.__setitem__c C s t | | dS )zlDeletes a cookie given a name. Wraps ``cookielib.CookieJar``'s
``remove_cookie_by_name()``.
N)rA )r r r r r __delitem__R s z RequestsCookieJar.__delitem__c sL t |jdr4|jjdr4|jjdr4|jjdd|_tt| j|f||S )N
startswith"z\" )r4 r% ra endswithreplacer[ rC rI )r r@ argsrJ )r] r r rI X s $z RequestsCookieJar.set_cookiec s@ t |tjr,x.|D ]}| jtj| qW ntt| j| dS )zAUpdates this jar with cookies from another CookieJar or dict-likeN)rF r CookieJarrI copyr[ rC update)r otherr@ )r] r r ri ] s
zRequestsCookieJar.updatec C s\ xDt | D ]8}|j|kr
|dks*|j|kr
|dks<|j|kr
|jS q
W td|||f dS )a Requests uses this method internally to get cookie values.
If there are conflicting cookies, _find arbitrarily chooses one.
See _find_no_duplicates if you want an exception thrown if there are
conflicting cookies.
:param name: a string containing name of cookie
:param domain: (optional) string containing domain of cookie
:param path: (optional) string containing path of cookie
:return: cookie.value
Nzname=%r, domain=%r, path=%r)rM r r< r r% rE )r r r< r r@ r r r _finde s
zRequestsCookieJar._findc C s| d}xXt | D ]L}|j|kr|dks.|j|kr|dks@|j|kr|dk rTtd| |j}qW |rf|S td|||f dS )a Both ``__get_item__`` and ``get`` call this function: it's never
used elsewhere in Requests.
:param name: a string containing name of cookie
:param domain: (optional) string containing domain of cookie
:param path: (optional) string containing path of cookie
:raises KeyError: if cookie is not found
:raises CookieConflictError: if there are multiple cookies
that match name and optionally domain and path
:return: cookie.value
Nz(There are multiple cookies with name, %rzname=%r, domain=%r, path=%r)rM r r< r rB r% rE )r r r< r ZtoReturnr@ r r r rD y s
z%RequestsCookieJar._find_no_duplicatesc C s | j j }|jd |S )z4Unlike a normal CookieJar, this class is pickleable.
_cookies_lock)__dict__rh pop)r stater r r __getstate__ s
z RequestsCookieJar.__getstate__c C s$ | j j| d| j kr tj | _dS )z4Unlike a normal CookieJar, this class is pickleable.rl N)rm ri threadingRLockrl )r ro r r r __setstate__ s
z RequestsCookieJar.__setstate__c C s t }|j| |S )z(Return a copy of this RequestsCookieJar.)rC ri )r Znew_cjr r r rh s
zRequestsCookieJar.copy)NNN)NN)NN)NN) r* r+ r, r- r rL rN rP rQ rR rS rT rV rX rY rZ r\ r^ r_ r` rI ri rk rD rp rs rh
__classcell__r r )r] r rC s0
rC c C sR | d kr d S t | dr | j S tj| }|j x | D ]}|jtj| q6W |S )Nrh )r4 rh r> rI )r6 Znew_jarr@ r r r _copy_cookie_jar s
ru c K s t d| |ddddddddddidd
}t|t| }|rNd }t|t| |j| t|d
|d < t|d |d
< |d jd|d< t|d |d< tjf |S )zMake 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").
r Nrc /FTHttpOnly)
versionr r% portr< r secureexpiresdiscardcomment comment_urlrestrfc2109z4create_cookie() got unexpected keyword arguments: %sry Zport_specifiedr< Zdomain_specified.Zdomain_initial_dotr Zpath_specified) dictrL TypeErrorrO ri boolra r r9 )r r% rJ resultZbadargserrr r r rH s0
rH c C s d}| d rPy t tj t | d }W qr tk
rL td| d Y qrX n"| d rrd}tjtj| d |}t| d t| d d| d || j | d dd
| d idt| d | j
| d
pdd
S )zBConvert a Morsel object into a Cookie containing the one k/v pair.Nzmax-agezmax-age: %s must be integerr{ z%a, %d-%b-%Y %H:%M:%S GMTr} Fr< r rw Zhttponlyrz rx r )
r} r~ r| r< r{ r r ry r r rz r% rx ) inttime
ValueErrorr calendarZtimegmZstrptimerH r r" r% )Zmorselr{ Z
time_templater r r rG s0
rG Tc C sV |dkrt }| dk rRdd |D }x,| D ]$}|s:||kr*|jt|| | q*W |S )a- 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.
Nc S s g | ]
}|j qS r )r ).0r@ r r r
<listcomp> s z'cookiejar_from_dict.<locals>.<listcomp>)rC rI rH )Z cookie_dictr? overwriteZnames_from_jarr r r r cookiejar_from_dict s
r c C sz t | tjstdt |tr.t|| dd} nHt |tjrvy| j| W n, tk
rt x|D ]}| j| q^W Y nX | S )zAdd 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.
z!You can only merge into CookieJarF)r? r ) rF r rg r r r ri AttributeErrorrI )r? ZcookiesZ
cookie_in_jarr r r
merge_cookies s
r )NN)NT) r- rh r r collectionsZ_internal_utilsr compatr r r r rq ImportErrorZdummy_threadingobjectr r/ r8 r; rA RuntimeErrorrB rg MutableMappingrC ru rH rG r r r r r r <module>
s. H
{#