U lfS@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl m Z ddlmZmZddlmZddlmZddlmZmZmZmZdd lmZmZmZmZmZmZdd lm Z!dd lm"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(dd l)m*Z*dd l+m,Z,m-Z-m.Z.m/Z/ddl0m1Z1dZ2e3Z4dddZ5d6e7dedddZ8ej9dkrvddZ:ddZ"ddZ;dd Zd&d'Z?ej@d(d)ZAd*d+ZBd,d-ZCd.d/ZDd0d1ZEdud2d3ZFd4d5ZGd6d7ZHd8d9ZId:d;ZJdd?ZLd@dAZMdBdCZNeOdDZPdEdFZQdGdHZRdIdJZSdKdLZTdMdNZUdOdPZVej@dQdRZWdSdTZXdvdUdVZYdWdXZZdwdYdZZ[dxd\d]Z\d^d_Z]d`daZ^db_dcZ`e`ddZae`deZbdfdgZcdhdiZddjdkZedldmZfdndoZgdpdqZhdrdsZidS)yz requests.utils ~~~~~~~~~~~~~~ This module provides utility functions that are used within Requests that are also useful for external consumption. N) OrderedDict) make_headers parse_url)certs __version__)_HEADER_VALIDATORS_BYTE_HEADER_VALIDATORS_STRHEADER_VALIDATORSto_native_string)Mapping basestringbytes getproxiesgetproxies_environment integer_types)parse_http_list) proxy_bypassproxy_bypass_environmentquotestrunquoteurlparse urlunparsecookiejar_from_dict)FileModeWarning InvalidHeader InvalidURLUnrewindableBodyError)CaseInsensitiveDict)z.netrc_netrcPi)httphttpsz, z,\s*T)accept_encodingzaccept-encodingwin32c Csz ddl}Wntk r"YdSXz6||jd}t||dd}||dd}Wnttfk rtYdSX|r~|sdS|d}t d|}|D]T}|dkrd|krd S| dd }| d d }| d d}t ||t j rd SqdS)NrFz;Software\Microsoft\Windows\CurrentVersion\Internet SettingsZ ProxyEnableZ ProxyOverride;z.Tz\.*z.*?)winreg ImportErrorOpenKeyHKEY_CURRENT_USERint QueryValueExOSError ValueErrorsplitfilterreplacerematchI)hostr,ZinternetSettingsZ proxyEnableZ proxyOverridetestr<cCstrt|St|SdS)zReturn True, if the host should be bypassed. Checks proxy settings gathered from the environment, if specified, or the registry. N)rrr>)r:r<r<r=rrsrcCst|dr|}|S)z/Returns an internal sequence dictionary update.items)hasattrr?)dr<r<r=dict_to_sequence~s rBc CsFd}d}t|tr|d}t|dr0t|}nft|drB|j}nTt|drz |}Wntjtfk rrYn$Xt |j }d|j krt dtt|dr*z |}Wn tk r|dk r|}Yn\Xt|d r*|dkr*z(|dd |}||pdWntk r(d}YnX|dkr8d}td||S) Nrutf-8__len__lenfilenoba%Requests has determined the content-length for this request using the binary size of the file: however, the file has been opened in text mode (i.e. without the 'b' flag in the mode). This may lead to an incorrect content-length. In Requests 3.0, support will be removed for files in text mode.tellseek) isinstancerencoder@rErFioUnsupportedOperationAttributeErrorosfstatst_sizemodewarningswarnrrHr2rImax)o total_lengthcurrent_positionrFr<r<r= super_lensF               rZFc CsLtjd}|dk r|f}nddtD}zddlm}m}d}|D]D}ztj|}Wntk rtYWdSXtj |rF|}qqF|dkrWdSt |} d} t |t r| d} | j| d} z<||| } | r| drdnd } | | | d fWWSWn"|tfk r(|r$YnXWnttfk rFYnXdS) z;Returns the Requests tuple auth for a given url from netrc.NETRCNcss|]}d|VqdS)z~/Nr<).0fr<r<r= sz!get_netrc_auth..r)NetrcParseErrornetrc:asciirrJ)rPenvironget NETRC_FILESr`r_path expanduserKeyErrorexistsrrKrdecodenetlocr4authenticatorsr2r-rO)url raise_errors netrc_filenetrc_locationsr_r` netrc_pathr]locrisplitstrr:r"login_ir<r<r=get_netrc_auths@      rvcCsBt|dd}|r>t|tr>|ddkr>|ddkr>tj|SdS)z0Tries to guess the filename of the given object.nameNr<>)getattrrKrrPrfbasename)objrwr<r<r=guess_filenames &r~c Cstj|r|Stj|\}}|rVtj|sVtj|\}}|sFqVd||g}q t|sd|St|}||kr~|St }tj||dd}tj|st |}| | |W5QRX|S)zReplace nonexistent paths that look like they refer to a member of a zip archive with the location of an extracted copy of the target, or else just return the provided path unchanged. /ry)rPrfrir4joinzipfile is_zipfileZipFilenamelisttempfile gettempdir atomic_openwriteread)rfarchivememberprefixzip_filetmpextracted_path file_handlerr<r<r=extract_zipped_paths s&      rc csltjtj|d\}}z.t|d }|VW5QRXt||Wn tk rft|YnXdS)z-Write a file to the disk in an atomic fashion)dirwbN) rmkstemprPrfdirnamefdopenr6 BaseExceptionremove)filenametmp_descriptortmp_name tmp_handlerr<r<r=r1s rcCs.|dkr dSt|ttttfr&tdt|S)aTake an object and test to see if it can be represented as a dictionary. Unless it can not be represented as such, return an OrderedDict, e.g., :: >>> from_key_val_list([('key', 'val')]) OrderedDict([('key', 'val')]) >>> from_key_val_list('string') Traceback (most recent call last): ... ValueError: cannot encode objects that are not 2-tuples >>> from_key_val_list({'key': 'val'}) OrderedDict([('key', 'val')]) :rtype: OrderedDict N+cannot encode objects that are not 2-tuples)rKrrboolr0r3rvaluer<r<r=from_key_val_list>s rcCs@|dkr dSt|ttttfr&tdt|tr8|}t|S)aTake an object and test to see if it can be represented as a dictionary. If it can be, return a list of tuples, e.g., :: >>> to_key_val_list([('key', 'val')]) [('key', 'val')] >>> to_key_val_list({'key': 'val'}) [('key', 'val')] >>> to_key_val_list('string') Traceback (most recent call last): ... ValueError: cannot encode objects that are not 2-tuples :rtype: list Nr) rKrrrr0r3r r?listrr<r<r=to_key_val_listYs rcCsXg}t|D]F}|dd|ddkr4dkrHnnt|dd}||q |S)aParse lists as described by RFC 2068 Section 2. In particular, parse comma-separated lists where the elements of the list may include quoted-strings. A quoted-string could contain a comma. A non-quoted string could have quotes in the middle. Quotes are removed automatically after parsing. It basically works like :func:`parse_set_header` just that items may appear multiple times and case sensitivity is preserved. The return value is a standard :class:`list`: >>> parse_list_header('token, "quoted value"') ['token', 'quoted value'] To create a header from the :class:`list` again, use the :func:`dump_header` function. :param value: a string with a list header. :return: :class:`list` :rtype: list Nrry")_parse_list_headerunquote_header_valueappend)rresultitemr<r<r=parse_list_headerws  ( rcCsxi}t|D]f}d|kr"d||<q |dd\}}|dd|ddkrVdkrjnnt|dd}|||<q |S)a^Parse lists of key, value pairs as described by RFC 2068 Section 2 and convert them into a python dict: >>> d = parse_dict_header('foo="is a fish", bar="as well"') >>> type(d) is dict True >>> sorted(d.items()) [('bar', 'as well'), ('foo', 'is a fish')] If there is no value for a key it will be `None`: >>> parse_dict_header('key_without_value') {'key_without_value': None} To create a header from the :class:`dict` again, use the :func:`dump_header` function. :param value: a string with a dict header. :return: :class:`dict` :rtype: dict =Nrryr)rr4r)rrrrwr<r<r=parse_dict_headers ( rcCs\|rX|d|dkr dkrXnn4|dd}|rD|dddkrX|ddd dS|S) zUnquotes a header value. (Reversal of :func:`quote_header_value`). This does not use the real unquoting but what browsers are actually using for quoting. :param value: the header value to unquote. :rtype: str rryrrNrJz\\\z\")r6)r is_filenamer<r<r=rs $ rcCsdd|D}|S)zReturns a key/value dictionary from a CookieJar. :param cj: CookieJar object to extract cookies from. :rtype: dict cSsi|]}|j|jqSr<)rwr)r\cookier<r<r= sz'dict_from_cookiejar..r<cj cookie_dictr<r<r=dict_from_cookiejarsrcCs t||S)zReturns a CookieJar from a key/value dictionary. :param cj: CookieJar to insert cookies into. :param cookie_dict: Dict of key/values to insert into CookieJar. :rtype: CookieJar rrr<r<r=add_dict_to_cookiejarsrcCsTtdttjdtjd}tjdtjd}td}||||||S)zlReturns encodings from given content string. :param content: bytestring to extract encodings from. zIn requests 3.0, get_encodings_from_content will be removed. For more information, please see the discussion on issue #2266. (This warning should only appear once.)z!])flagsz+]z$^<\?xml.*?encoding=["\']*(.+?)["\'>])rTrUDeprecationWarningr7compiler9findall)content charset_re pragma_rexml_rer<r<r=get_encodings_from_contents  rc Cs|d}|d|dd}}i}d}|D]`}|}|r0|d}}|d} | dkr|d| |}|| dd|}|||<q0||fS) zReturns content type and parameters from given header :param header: string :return: tuple containing content type and dictionary of parameters r(rrNz"' Trry)r4stripfindlower) headertokens content_typeparams params_dictitems_to_stripparamkeyrindex_of_equalsr<r<r=_parse_content_type_headers   rcCsP|d}|sdSt|\}}d|kr4|ddSd|kr@dSd|krLdSdS) z}Returns encodings from given HTTP Header Dict. :param headers: dictionary to extract encoding from. :rtype: str z content-typeNcharsetz'"textz ISO-8859-1zapplication/jsonrC)rdrr)headersrrr<r<r=get_encoding_from_headerss  rccsd|jdkr|EdHdSt|jdd}|D]}||}|r.|Vq.|jddd}|r`|VdS)zStream decodes an iterator.Nr6errorsT)final)encodingcodecsgetincrementaldecoderrj)iteratorrdecoderchunkrvr<r<r=stream_decode_response_unicode4s   rccsHd}|dks|dkrt|}|t|krD||||V||7}qdS)z Iterate over slices of a string.rN)rE)string slice_lengthposr<r<r= iter_slicesEs  rcCs~tdtg}t|j}|rLzt|j|WStk rJ||YnXzt|j|ddWSt k rx|jYSXdS)zReturns the requested content back in unicode. :param r: Response object to get unicode content from. Tried: 1. charset from content-type 2. fall back and replace all unicode characters :rtype: str zIn requests 3.0, get_unicode_from_response will be removed. For more information, please see the discussion on issue #2266. (This warning should only appear once.)r6rN) rTrUrrrrr UnicodeErrorr TypeError)rtried_encodingsrr<r<r=get_unicode_from_responseOs   rzBABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~c Cs|d}tdt|D]}||dd}t|dkr|rztt|d}Wn$tk rvtd|dYnX|tkr|||dd||<qd||||<qd||||<qd |S) zUn-escape any percent-escape sequences in a URI that are unreserved characters. This leaves all reserved, illegal and non-ASCII bytes encoded. :rtype: str %rrrJz"Invalid percent-escape sequence: ''N) r4rangerEisalnumchrr0r3rUNRESERVED_SETr)uripartsihcr<r<r=unquote_unreserved|s rcCs@d}d}ztt||dWStk r:t||dYSXdS)zRe-quote the given URI. This function passes the given URI through an unquote/quote cycle to ensure that it is fully and consistently quoted. :rtype: str z!#$%&'()*+,/:;=?@[]~z!#$&'()*+,/:;=?@[]~)safeN)rrr)rsafe_with_percentsafe_without_percentr<r<r= requote_uris rcCsltdt|d}|d\}}tdttt|d}tdt|d|@}||@||@kS)zThis function allows you to check if an IP belongs to a network subnet Example: returns True if ip = 192.168.1.1 and net = 192.168.1.0/24 returns False if ip = 192.168.1.1 and net = 192.168.100.0/24 :rtype: bool z=Lrr)structunpacksocket inet_atonr4dotted_netmaskr0)ipnetipaddrnetaddrbitsnetmasknetworkr<r<r=address_in_networks rcCs&ddd|>dA}ttd|S)zConverts mask from /xx format to xxx.xxx.xxx.xxx Example: if mask is 24 function returns 255.255.255.0 :rtype: str lr z>I)r inet_ntoarpack)maskrr<r<r=rsrcCs*zt|Wntk r$YdSXdS)z :rtype: bool FT)rrr2) string_ipr<r<r=is_ipv4_addresss r cCs|ddkrzt|dd}Wntk r:YdSX|dksL|dkrPdSzt|ddWqtk r~YdSXndSdS)zV Very simple check of the cidr format in no_proxy variable. :rtype: bool rrFrrT)countr0r4r3rrr2)string_networkrr<r<r= is_valid_cidrs r c csT|dk }|r"tj|}|tj|<z dVW5|rN|dkrDtj|=n |tj|<XdS)zSet the environment variable 'env_name' to 'value' Save previous value, yield, and then restore the previous value stored in the environment variable 'env_name'. If 'value' is None, do nothingN)rPrcrd)env_namer value_changed old_valuer<r<r= set_environs    rc Cs*dd}|}|dkr|d}t|}|jdkr2dS|rdd|dd d D}t|jr|D]0}t|rt|j|rdSq`|j|kr`dSq`nB|j}|jr|d |j7}|D] }|j|s||rdSqt d|6zt |j}Wn t t j fk rd }YnXW5QRX|r&dSd S) zL Returns whether we should bypass proxies or not. :rtype: bool cSstj|ptj|SN)rPrcrdupper)rr<r<r= get_proxysz(should_bypass_proxies..get_proxyNno_proxyTcss|]}|r|VqdSrr<)r\r:r<r<r=r^sz(should_bypass_proxies.. r,:F)rhostnamer6r4r r rportendswithrrrrgaierror) rmrr no_proxy_argparsedproxy_iphost_with_portr:bypassr<r<r=should_bypass_proxiess<       r!cCst||driStSdS)zA Return a dict of environment proxies. :rtype: dict rN)r!r)rmrr<r<r=get_environ_proxies:s r#cCst|pi}t|}|jdkr.||j|dS|jd|j|jd|jdg}d}|D]}||krV||}qpqV|S)zSelect a proxy for the url, if applicable. :param url: The url being for the request :param proxies: A dictionary of schemes or schemes and hosts to proxy URLs Nallz://zall://)rrrdscheme)rmproxiesurlparts proxy_keysproxy proxy_keyr<r<r= select_proxyFs r+c Cst|dk r |ni}|j}t|j}|d}|}|rpt||dspt||d}|||d}|rp||||S)aThis method takes proxy information from a request and configuration input to resolve a mapping of target proxies. This will consider settings such as NO_PROXY to strip proxy configurations. :param request: Request or PreparedRequest :param proxies: A dictionary of schemes or schemes and hosts to proxy URLs :param trust_env: Boolean declaring whether to trust environment configs :rtype: dict Nrr"r$)rmrr%rdcopyr!r# setdefault) requestr& trust_envrmr%r new_proxiesenviron_proxiesr)r<r<r=resolve_proxies`s     r2python-requestscCs|dtS)zO Return a string representing the default user agent. :rtype: str rr)rwr<r<r=default_user_agent{sr4cCstttdddS)z9 :rtype: requests.structures.CaseInsensitiveDict z*/*z keep-alive)z User-AgentzAccept-EncodingAccept Connection)r!r4DEFAULT_ACCEPT_ENCODINGr<r<r<r=default_headerssr8c Csg}d}||}|s|Std|D]}z|dd\}}Wntk r\|d}}YnXd|di}|dD]F}z|d\}}Wntk rYqYnX|||||<qv||q&|S) zReturn a list of parsed link headers proxies. i.e. Link: ; rel=front; type="image/jpeg",; rel=back;type="image/jpeg" :rtype: list z '"z, * '"r)rr7r4r3r) rlinks replace_charsvalrmrlinkrrr<r<r=parse_header_linkss&   r=rbrJcCs|dd}|tjtjfkr dS|ddtjkr6dS|ddtjtjfkrRdS|t}|dkrhd S|dkr|dddtkrd S|d ddtkrd S|dkr|ddt krd S|d dt krdSdS)z :rtype: str Nzutf-32r?z utf-8-sigrJzutf-16rrCz utf-16-berz utf-16-lez utf-32-bez utf-32-le) r BOM_UTF32_LE BOM_UTF32_BEBOM_UTF8 BOM_UTF16_LE BOM_UTF16_BEr _null_null2_null3)datasample nullcountr<r<r=guess_json_utfs*  rLc Cslt|}|\}}}}}}} |j} | s.|| } }|r@d|| g} |dkrL|}|dkrXd}t|| |d|| fS)zGiven a URL that may or may not have a scheme, prepend the given scheme. Does not replace a present scheme with the one provided as an argument. :rtype: str @Nr)rrkrr) rm new_schemerr%authr:rrfqueryfragmentrkr<r<r=prepend_scheme_if_neededs rRc CsBt|}zt|jt|jf}Wnttfk r<d}YnX|S)z{Given a url with authentication components, extract them into a tuple of username,password. :rtype: (str,str) )rr)rrusernamepasswordrOr)rmrrOr<r<r=get_auth_from_urls  rUcCs$|\}}t||dt||ddS)zVerifies that header parts don't contain leading whitespace reserved characters, or return characters. :param header: tuple, in the format (name, value). rrN)_validate_header_part)rrwrr<r<r=check_header_validity s rWcCsxt|trt|}n2t|tr(t|}ntd|d|dt|||st|dkr\dnd}td|d|dS) Nz Header part (z) from z# must be of type str or bytes, not rrwrzTInvalid leading whitespace, reserved character(s), or return character(s) in header z: )rKrr rr rtyper8)r header_partheader_validator_index validator header_kindr<r<r=rVs     rVcCsFt|\}}}}}}|s"||}}|ddd}t|||||dfS)zW Given a url remove the fragment and the authentication part. :rtype: str rMrryr)rrsplitr)rmr%rkrfrrPrQr<r<r= urldefragauth(s  r^cCs\t|jdd}|dk rPt|jtrPz||jWqXtk rLtdYqXXntddS)zfMove file pointer back to its recorded starting position so it can be read again on redirect. rINz;An error occurred when rewinding request body for redirect.z+Unable to rewind request body for redirect.)r{bodyrK_body_positionrr2r )prepared_request body_seekr<r<r= rewind_body9s  rc)F)F)N)T)r3)j__doc__r contextlibrMrPr7rrsysrrTr collectionsrZ urllib3.utilrrrrr_internal_utilsr r r r compatr rrrrrrrrrrrrrrcookiesr exceptionsrrrr structuresr!rewhereDEFAULT_CA_BUNDLE_PATH DEFAULT_PORTSrr4r7platformr>rBrZrvr~rcontextmanagerrrrrrrrrrrrrrr frozensetrrrrrr r rr!r#r+r2r4r8r=rLrFrGrHrLrRrUrWrVr^rcr<r<r<r=s     $    &  E 9%  #    (   =   &