3 h`p @sdZddlZddlZddlZddlmZddlmZddlm Z ddl m Z m Z m Z mZmZddlmZmZmZmZdd lmZmZmZdd lmZmZdd lmZdd lmZm Z dd l!m"Z"m#Z#m$Z$m%Z%ddl&m'Z'ddl(m)Z)ddlm*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0ddl1m2Z2ddlm3Z3ej4dkrXy ej5Z6Wne7k rTej8Z6YnXnejZ6e fddZ9e fddZ:Gddde;ZdS)z requests.session ~~~~~~~~~~~~~~~~ This module provides a Session object to manage and persist settings across requests (cookies, auth, proxies). N)Mapping) timedelta)_basic_auth_str) cookielibis_py3 OrderedDicturljoinurlparse)cookiejar_from_dictextract_cookies_to_jarRequestsCookieJar merge_cookies)RequestPreparedRequestDEFAULT_REDIRECT_LIMIT) default_hooks dispatch_hook)to_native_string)to_key_val_listdefault_headers)TooManyRedirects InvalidSchemaChunkedEncodingErrorContentDecodingError)CaseInsensitiveDict) HTTPAdapter) requote_uriget_environ_proxiesget_netrc_authshould_bypass_proxiesget_auth_from_url rewind_body DEFAULT_PORTS)codes)REDIRECT_STATIWindowscCst|dkr |S|dkr|St|to*t|ts0|S|t|}|jt|dd|jD}x|D] }||=qbW|S)zDetermines appropriate setting for a given request, taking into account the explicit setting on that request, and the setting in the session. If a setting is a dictionary, they will be merged together using `dict_class` NcSsg|]\}}|dkr|qS)N).0kvr'r'Jsz!merge_setting..) isinstancerrupdateitems)request_settingsession_setting dict_classmerged_setting none_keyskeyr'r'r+ merge_setting2s     r6cCs@|dks|jdgkr|S|dks0|jdgkr4|St|||S)zProperly merges both requests and session hooks. This is necessary because when request_hooks == {'response': []}, the merge breaks Session hooks entirely. Nresponse)getr6) request_hooks session_hooksr2r'r'r+ merge_hooksQs r;c@s>eZdZddZddZddd Zd d Zd d ZddZdS)SessionRedirectMixincCs,|jr(|jd}tr|jd}t|dSdS)z7Receives a Response. Returns a redirect URI or ``None``locationlatin1utf8N) is_redirectheadersrencoder)selfrespr=r'r'r+get_redirect_targetbs    z(SessionRedirectMixin.get_redirect_targetcCst|}t|}|j|jkr dS|jdkrL|jdkrL|jdkrL|jd krLdS|j|jk}|j|jk}tj|jddf}| r|j|kr|j|krdS|p|S) zFDecide whether Authorization header should be removed when redirectingThttpPNhttpsF)rGN)rIN)r hostnameschemeportr#r8)rCold_urlnew_url old_parsed new_parsed changed_portchanged_scheme default_portr'r'r+should_strip_authxs    z&SessionRedirectMixin.should_strip_authFNTc ks.g} |j|} x| r(|j} | j|| dd|_y |jWn(tttfk rj|jj ddYnXt |j|j krt d|j |d|j | jdrt|j} dt| j| f} t| }|j} |jst|jt| } nt| } t| | _|j| ||jtjtjfkr>d}x|D]}| jj|dq Wd| _| j}y |d =Wntk rdYnXt | j!||jt"| j!|j#| j$| j!|j%| |}|j&| || j'dk od |kpd |k}|rt(| | }|r|Vq|j)|f|||||dd | }t |j#| |j|j|} |VqWdS)zBReceives a Response. Returns a generator of Responses or Requests.rNF)decode_contentzExceeded %s redirects.)r7z//z%s:%sContent-Length Content-TypeTransfer-EncodingCookie)streamtimeoutverifycertproxiesallow_redirects)rVrWrX)*rEcopyappendhistorycontentrr RuntimeErrorrawreadlen max_redirectsrclose startswithr urlrrKgeturlnetlocr rrebuild_method status_coder$temporary_redirectpermanent_redirectrApopbodyKeyErrorr _cookiesrcookiesprepare_cookiesrebuild_proxies rebuild_auth_body_positionr"send)rCrDreqrZr[r\r]r^yield_requestsadapter_kwargshistrkprepared_request parsed_rurlparsedpurged_headersheaderrA rewindabler'r'r+resolve_redirectssr               z&SessionRedirectMixin.resolve_redirectscCsR|j}|j}d|kr*|j|jj|r*|d=|jr8t|nd}|dk rN|j|dS)zWhen being redirected we may want to strip authentication from the request to avoid leaking credentials. This method intelligently removes and reapplies authentication where possible to avoid credential loss. AuthorizationN)rArkrTrequest trust_envr prepare_auth)rCrr7rArknew_authr'r'r+rys z!SessionRedirectMixin.rebuild_authc Cs|dk r |ni}|j}|j}t|j}|j}|jd}t||d}|jr~| r~t||d} | j|| jd} | r~|j || d|kr|d=yt ||\} } Wnt k rd\} } YnX| r| rt | | |d<|S)aThis method re-evaluates the proxy configuration by considering the environment variables. If we are redirected to a URL covered by NO_PROXY, we strip the proxy configuration. Otherwise, we set missing proxy keys for this URL (in case they were stripped by a previous redirect). This method also replaces the Proxy-Authorization header where necessary. :rtype: dict Nno_proxy)rallzProxy-Authorization)NN) rArkr rKr`r8r rr setdefaultr!rtr) rCrr^rArkrK new_proxiesr bypass_proxyenviron_proxiesproxyusernamepasswordr'r'r+rxs*       z$SessionRedirectMixin.rebuild_proxiescCsX|j}|jtjkr|dkrd}|jtjkr6|dkr6d}|jtjkrN|dkrNd}||_dS)zWhen being redirected we may want to change the method of the request based on certain specs or browser behavior. HEADGETPOSTN)methodror$ see_otherfoundmoved)rCrr7rr'r'r+rn:sz#SessionRedirectMixin.rebuild_method)FNTNNF) __name__ __module__ __qualname__rErTrryrxrnr'r'r'r+r<`s k)r<c@seZdZdZdddddddd d d d d dg ZddZddZddZddZd7ddZ ddZ ddZ dd Z d8d!d"Z d9d#d$Zd:d%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Zd5d6ZdS);Sessiona~A Requests session. Provides cookie persistence, connection-pooling, and configuration. Basic Usage:: >>> import requests >>> s = requests.Session() >>> s.get('http://httpbin.org/get') Or as a context manager:: >>> with requests.Session() as s: >>> s.get('http://httpbin.org/get') rArvauthr^hooksparamsr\r]prefetchadaptersrZrrhcCsrt|_d|_i|_t|_i|_d|_d|_d|_ t |_ d|_ t i|_t|_|jdt|jdtdS)NFTzhttps://zhttp://)rrArr^rrrrZr\r]rrhrr rvrrmountr)rCr'r'r+__init__js zSession.__init__cCs|S)Nr')rCr'r'r+ __enter__szSession.__enter__cGs |jdS)N)ri)rCargsr'r'r+__exit__szSession.__exit__c Cs|jpi}t|tjst|}ttt|j|}|j}|jrV| rV|j rVt |j }t }|j |j j|j |j|j|jt|j|jtdt|j|jt||j|t|j|jd |S)aConstructs a :class:`PreparedRequest ` for transmission and returns it. The :class:`PreparedRequest` has settings merged from the :class:`Request ` instance and those of the :class:`Session`. :param request: :class:`Request` instance to prepare with this session's settings. :rtype: requests.PreparedRequest )r2) rrkfilesdatajsonrArrrvr)rvr-r CookieJarr rr rrrrkrpreparerupperrrrr6rArrr;r)rCrrvmerged_cookiesrpr'r'r+prepare_requests*     zSession.prepare_requestNTc Cstt|j||||pi||pi||| d }|j|}| p8i} |j|j| | ||}| | d}|j||j|f|}|S)aConstructs a :class:`Request `, prepares it and sends it. Returns :class:`Response ` object. :param method: method for the new :class:`Request` object. :param url: URL for the new :class:`Request` object. :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`. :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param json: (optional) json to send in the body of the :class:`Request`. :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`. :param cookies: (optional) Dict or CookieJar object to send with the :class:`Request`. :param files: (optional) Dictionary of ``'filename': file-like-objects`` for multipart encoding upload. :param auth: (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth. :param timeout: (optional) How long to wait for the server to send data before giving up, as a float, or a :ref:`(connect timeout, read timeout) ` tuple. :type timeout: float or tuple :param allow_redirects: (optional) Set to True by default. :type allow_redirects: bool :param proxies: (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy. :param stream: (optional) whether to immediately download the response content. Defaults to ``False``. :param verify: (optional) Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to ``True``. :param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair. :rtype: requests.Response ) rrkrArrrrrrvr)r[r_)rrrmerge_environment_settingsrkr.r{)rCrrkrrrArvrrr[r_r^rrZr\r]rr|prepsettings send_kwargsrDr'r'r+rs()  zSession.requestcKs|jdd|jd|f|S)zSends a GET request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param \*\*kwargs: Optional arguments that ``request`` takes. :rtype: requests.Response r_Tr)rr)rCrkkwargsr'r'r+r8s z Session.getcKs|jdd|jd|f|S)zSends a OPTIONS request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param \*\*kwargs: Optional arguments that ``request`` takes. :rtype: requests.Response r_TOPTIONS)rr)rCrkrr'r'r+options!s zSession.optionscKs|jdd|jd|f|S)zSends a HEAD request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param \*\*kwargs: Optional arguments that ``request`` takes. :rtype: requests.Response r_Fr)rr)rCrkrr'r'r+head,s z Session.headcKs|jd|f||d|S)aSends a POST request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param json: (optional) json to send in the body of the :class:`Request`. :param \*\*kwargs: Optional arguments that ``request`` takes. :rtype: requests.Response r)rr)r)rCrkrrrr'r'r+post7s z Session.postcKs|jd|fd|i|S)aYSends a PUT request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param \*\*kwargs: Optional arguments that ``request`` takes. :rtype: requests.Response PUTr)r)rCrkrrr'r'r+putCs z Session.putcKs|jd|fd|i|S)a[Sends a PATCH request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param \*\*kwargs: Optional arguments that ``request`` takes. :rtype: requests.Response PATCHr)r)rCrkrrr'r'r+patchNs z Session.patchcKs|jd|f|S)zSends a DELETE request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param \*\*kwargs: Optional arguments that ``request`` takes. :rtype: requests.Response DELETE)r)rCrkrr'r'r+deleteYszSession.deletec Ks~|jd|j|jd|j|jd|j|jd|jt|trJtd|jdd}|j d}|j }|j |j d}t }|j|f|}t |} t| d |_td ||f|}|jrx |jD]} t|j| j| jqWt|j||j|j||f|} |r d d | Dng} | r.| jd || j}| |_|sny"t|j||fddi||_Wntk rlYnX|sz|j|S)zISend a given PreparedRequest. :rtype: requests.Response rZr\r]r^z#You can only send PreparedRequests.r_T)rk)secondsr7cSsg|]}|qSr'r')r(rDr'r'r+r,sz Session.send..rr})rrZr\r]r^r-r ValueErrorrrr8r get_adapterrkpreferred_clockr{relapsedrrbr rvrrerinsertnext_next StopIterationrc) rCrrr_rZradapterstartrrrDgenrbr'r'r+r{csB       "z Session.sendc Cs|jrr|dk r|jdnd}t||d}x |jD]\}} |j|| q2W|dksZ|dkrrtjjdpptjjd}t||j}t||j }t||j }t||j }||||dS)z^ Check the environment and merge it with some settings. :rtype: dict Nr)rTREQUESTS_CA_BUNDLECURL_CA_BUNDLE)r\r^rZr]) rr8rr/rosenvironr6r^rZr\r]) rCrkr^rZr\r]r env_proxiesr)r*r'r'r+rs       z"Session.merge_environment_settingscCs:x(|jjD]\}}|jj|r |Sq Wtd|dS)z~ Returns the appropriate connection adapter for the given URL. :rtype: requests.adapters.BaseAdapter z*No connection adapters were found for '%s'N)rr/lowerrjr)rCrkprefixrr'r'r+rszSession.get_adaptercCs x|jjD] }|jq WdS)z+Closes all adapters and as such the sessionN)rvaluesri)rCr*r'r'r+risz Session.closecsB||j<fdd|jD}x|D]}|jj||j|<q$WdS)zwRegisters a connection adapter to a prefix. Adapters are sorted in descending order by prefix length. cs g|]}t|tkr|qSr')rg)r(r))rr'r+r,sz!Session.mount..N)rrr)rCrr keys_to_mover5r')rr+rs  z Session.mountcstfddjD}|S)Nc3s|]}|t|dfVqdS)N)getattr)r(attr)rCr'r+ sz'Session.__getstate__..)dict __attrs__)rCstater')rCr+ __getstate__szSession.__getstate__cCs&x |jD]\}}t|||q WdS)N)r/setattr)rCrrvaluer'r'r+ __setstate__szSession.__setstate__)NNNNNNNTNNNNNN)NN)N)N)rrr__doc__rrrrrrr8rrrrrrr{rrrirrrr'r'r'r+rQs2 7) D    I rcCstS)zQ Returns a :class:`Session` for context-management. :rtype: Session )rr'r'r'r+sessionsr)?rrplatformtime collectionsrdatetimerrrcompatrrrr r rvr r r rmodelsrrrrrr_internal_utilsrutilsrr exceptionsrrrr structuresrrrrrrr r!r"r# status_codesr$r%system perf_counterrAttributeErrorclockr6r;objectr<rrr'r'r'r+ sB      $     r"