开发接口

这部分文档包含了 Requests 所有的接口。对于 Requests 依赖的外部库部分，我们在这里介绍最重要的部分，并提供了规范文档的链接。

主要接口

Requests 所有的功能都可以通过以下 7 个方法访问。它们全部都会返回一个Response 对象的实例。

参数:

  • method — method for the new Request object.
  • url — URL for the new Request object.
  • params — (optional) Dictionary or bytes to be sent in the query string for the Request.
  • data — (optional) Dictionary or list of tuples [(key, value)] (will be form-encoded), bytes, or file-like object to send in the body of the Request.
  • json — (optional) json data to send in the body of the Request.
  • headers — (optional) Dictionary of HTTP Headers to send with the Request.
  • cookies — (optional) Dict or CookieJar object to send with the Request.
  • files — (optional) Dictionary of 'name': file-like-objects (or {'name': file-tuple}) for multipart encoding upload.file-tuple can be a 2-tuple ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type')or a 4-tuple ('filename', fileobj, 'content_type', custom_headers), where 'content-type' is a stringdefining the content type of the given file and custom_headers a dict-like object containing additional headersto add for the file.
  • auth — (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
  • timeout (float or tuple) — (optional) How many seconds to wait for the server to send databefore giving up, as a float, or a (connect timeout, readtimeout) tuple.
  • allow_redirects (bool) — (optional) Boolean. Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to True.
  • proxies — (optional) Dictionary mapping protocol to the URL of the proxy.
  • verify — (optional) Either a boolean, in which case it controls whether we verifythe server's TLS certificate, or a string, in which case it must be a pathto a CA bundle to use. Defaults to True.
  • stream — (optional) if False, the response content will be immediately downloaded.
  • cert — (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.返回: Response object 返回类型: requests.Response

Usage:

  1. >>> import requests
  2. >>> req = requests.request('GET', 'http://httpbin.org/get')
  3. <Response [200]>
  • requests.head(url, **kwargs)[源代码]
  • Sends a HEAD request.

参数:

  • requests.get(url, params=None, **kwargs)[源代码]
  • Sends a GET request.

参数:

  • url — URL for the new Request object.
  • params — (optional) Dictionary or bytes to be sent in the query string for the Request.
  • **kwargs — Optional arguments that request takes.返回: Response object 返回类型: requests.Response
  • requests.post(url, data=None, json=None, **kwargs)[源代码]
  • Sends a POST request.

参数:

  • url — URL for the new Request object.
  • data — (optional) Dictionary (will be form-encoded), bytes, or file-like object to send in the body of the Request.
  • json — (optional) json data to send in the body of the Request.
  • **kwargs — Optional arguments that request takes.返回: Response object 返回类型: requests.Response
  • requests.put(url, data=None, **kwargs)[源代码]
  • Sends a PUT request.

参数:

  • url — URL for the new Request object.
  • data — (optional) Dictionary (will be form-encoded), bytes, or file-like object to send in the body of the Request.
  • json — (optional) json data to send in the body of the Request.
  • **kwargs — Optional arguments that request takes.返回: Response object 返回类型: requests.Response
  • requests.patch(url, data=None, **kwargs)[源代码]
  • Sends a PATCH request.

参数:

  • url — URL for the new Request object.
  • data — (optional) Dictionary (will be form-encoded), bytes, or file-like object to send in the body of the Request.
  • json — (optional) json data to send in the body of the Request.
  • **kwargs — Optional arguments that request takes.返回: Response object 返回类型: requests.Response
  • requests.delete(url, **kwargs)[源代码]
  • Sends a DELETE request.

参数:

异常

  • exception requests.RequestException(*args, **kwargs)[源代码]

  • There was an ambiguous exception that occurred while handling yourrequest.

  • exception requests.ConnectionError(*args, **kwargs)[源代码]

  • A Connection error occurred.

  • exception requests.HTTPError(*args, **kwargs)[源代码]

  • An HTTP error occurred.

  • exception requests.URLRequired(*args, **kwargs)[源代码]

  • A valid URL is required to make a request.

  • exception requests.TooManyRedirects(*args, **kwargs)[源代码]

  • Too many redirects.

  • exception requests.ConnectTimeout(*args, **kwargs)[源代码]

  • The request timed out while trying to connect to the remote server.

Requests that produced this error are safe to retry.

  • exception requests.ReadTimeout(*args, **kwargs)[源代码]

  • The server did not send any data in the allotted amount of time.

  • exception requests.Timeout(*args, **kwargs)[源代码]

  • The request timed out.

Catching this error will catch bothConnectTimeout andReadTimeout errors.

请求会话

Provides cookie persistence, connection-pooling, and configuration.

Basic Usage:

  1. >>> import requests
  2. >>> s = requests.Session()
  3. >>> s.get('http://httpbin.org/get')
  4. <Response [200]>

Or as a context manager:

  1. >>> with requests.Session() as s:
  2. >>>     s.get('http://httpbin.org/get')
  3. <Response [200]>
  • auth = None

  • Default Authentication tuple or object to attach toRequest.

  • cert = None

  • SSL client certificate default, if String, path to ssl clientcert file (.pem). If Tuple, ('cert', 'key') pair.

  • close()[源代码]

  • Closes all adapters and as such the session

  • cookies = None

  • A CookieJar containing all currently outstanding cookies set on thissession. By default it is aRequestsCookieJar, butmay be any other cookielib.CookieJar compatible object.

  • delete(url, **kwargs)[源代码]

  • Sends a DELETE request. Returns Response object.

参数:

  1. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - ****kwargs** -- Optional arguments that <code>request</code> takes.返回类型:

requests.Response

参数:

  1. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - ****kwargs** -- Optional arguments that <code>request</code> takes.返回类型:

requests.Response

  • getadapter(_url)[源代码]
  • Returns the appropriate connection adapter for the given URL.

返回类型:requests.adapters.BaseAdapter

  • getredirect_target(_resp)

  • Receives a Response. Returns a redirect URI or None

  • head(url, **kwargs)[源代码]

  • Sends a HEAD request. Returns Response object.

参数:

  1. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - ****kwargs** -- Optional arguments that <code>request</code> takes.返回类型:

requests.Response

  • headers = None

  • A case-insensitive dictionary of headers to be sent on eachRequest sent from thisSession.

  • hooks = None

  • Event-handling hooks.

  • maxredirects = None_

  • Maximum number of redirects allowed. If the request exceeds thislimit, a TooManyRedirects exception is raised.This defaults to requests.models.DEFAULT_REDIRECT_LIMIT, which is30.

  • mergeenvironment_settings(_url, proxies, stream, verify, cert)[源代码]

  • Check the environment and merge it with some settings.

返回类型:dict

  • mount(prefix, adapter)[源代码]
  • Registers a connection adapter to a prefix.

Adapters are sorted in descending order by prefix length.

参数:

  1. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - ****kwargs** -- Optional arguments that <code>request</code> takes.返回类型:

requests.Response

  • params = None

  • Dictionary of querystring data to attach to eachRequest. The dictionary values may be lists forrepresenting multivalued query parameters.

  • patch(url, data=None, **kwargs)[源代码]

  • Sends a PATCH request. Returns Response object.

参数:

  1. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - **data** -- (optional) Dictionary, bytes, or file-like object to send in the body of the [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  3. - ****kwargs** -- Optional arguments that <code>request</code> takes.返回类型:

requests.Response

  • post(url, data=None, json=None, **kwargs)[源代码]
  • Sends a POST request. Returns Response object.

参数:

  1. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - **data** -- (optional) Dictionary, bytes, or file-like object to send in the body of the [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  3. - **json** -- (optional) json to send in the body of the [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  4. - ****kwargs** -- Optional arguments that <code>request</code> takes.返回类型:

requests.Response

参数:request — Request instance to prepare with thissession's settings.返回类型:requests.PreparedRequest

  • proxies = None

  • Dictionary mapping protocol or protocol and host to the URL of the proxy(e.g. {'http': 'foo.bar:3128', 'http://host.name&#39;: 'foo.bar:4012'}) tobe used on each Request.

  • put(url, data=None, **kwargs)[源代码]

  • Sends a PUT request. Returns Response object.

参数:

  1. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - **data** -- (optional) Dictionary, bytes, or file-like object to send in the body of the [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  3. - ****kwargs** -- Optional arguments that <code>request</code> takes.返回类型:

requests.Response

  • rebuildauth(_prepared_request, response)

  • When being redirected we may want to strip authentication from therequest to avoid leaking credentials. This method intelligently removesand reapplies authentication where possible to avoid credential loss.

  • rebuildmethod(_prepared_request, response)

  • When being redirected we may want to change the method of the requestbased on certain specs or browser behavior.

  • rebuildproxies(_prepared_request, proxies)

  • This method re-evaluates the proxy configuration by considering theenvironment variables. If we are redirected to a URL covered byNO_PROXY, we strip the proxy configuration. Otherwise, we set missingproxy keys for this URL (in case they were stripped by a previousredirect).

This method also replaces the Proxy-Authorization header wherenecessary.

返回类型:dict

  • request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None, timeout=None, allow_redirects=True, proxies=None, hooks=None, stream=None, verify=None, cert=None, json=None)[源代码]
  • Constructs a Request, prepares it and sends it.Returns Response object.

参数:

  1. - **method** -- method for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  2. - **url** -- URL for the new [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request) object.
  3. - **params** -- (optional) Dictionary or bytes to be sent in the querystring for the [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  4. - **data** -- (optional) Dictionary, bytes, or file-like object to sendin the body of the [<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  5. - **json** -- (optional) json to send in the body of the[<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  6. - **headers** -- (optional) Dictionary of HTTP Headers to send with the[<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  7. - **cookies** -- (optional) Dict or CookieJar object to send with the[<code>Request</code>](https://2.python-requests.org/zh_CN/latest/#requests.Request).
  8. - **files** -- (optional) Dictionary of <code>&#39;filename&#39;: file-like-objects</code>for multipart encoding upload.
  9. - **auth** -- (optional) Auth tuple or callable to enableBasic/Digest/Custom HTTP Auth.
  10. - **timeout** (_float__ or __tuple_) -- (optional) How long to wait for the server to senddata before giving up, as a float, or a [(connect timeout,read timeout)]($a97ca0386b4264f7.md#timeouts) tuple.
  11. - **allow_redirects** (_bool_) -- (optional) Set to True by default.
  12. - **proxies** -- (optional) Dictionary mapping protocol or protocol andhostname to the URL of the proxy.
  13. - **stream** -- (optional) whether to immediately download the responsecontent. Defaults to <code>False</code>.
  14. - **verify** -- (optional) Either a boolean, in which case it controls whether we verifythe server&#39;s TLS certificate, or a string, in which case it must be a pathto a CA bundle to use. Defaults to <code>True</code>.
  15. - **cert** -- (optional) if String, path to ssl client cert file (.pem).If Tuple, (&#39;cert&#39;, &#39;key&#39;) pair.返回类型:

requests.Response

  • resolveredirects(_resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, yield_requests=False, **adapter_kwargs)

  • Receives a Response. Returns a generator of Responses or Requests.

  • send(request, **kwargs)[源代码]

  • Send a given PreparedRequest.

返回类型:requests.Response

  • stream = None

  • Stream response content default.

  • trustenv = None_

  • Trust environment settings for proxy configuration, defaultauthentication and similar.

  • verify = None

  • SSL Verification default.

低级类

  • class requests.Request(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[源代码]
  • A user-created Request object.

Used to prepare a PreparedRequest, which is sent to the server.

参数:

  • method — HTTP method to use.
  • url — URL to send.
  • headers — dictionary of headers to send.
  • files — dictionary of {filename: fileobject} files to multipart upload.
  • data — the body to attach to the request. If a dictionary is provided, form-encoding will take place.
  • json — json for the body to attach to the request (if files or data is not specified).
  • params — dictionary of URL parameters to append to the URL.
  • auth — Auth handler or (user, pass) tuple.
  • cookies — dictionary or CookieJar of cookies to attach to this request.
  • hooks — dictionary of callback hooks, for internal usage.

Usage:

  1. >>> import requests
  2. >>> req = requests.Request('GET', 'http://httpbin.org/get')
  3. >>> req.prepare()
  4. <PreparedRequest [GET]>
  • deregisterhook(_event, hook)

  • Deregister a previously registered hook.Returns True if the hook existed, False if not.

  • prepare()[源代码]

  • Constructs a PreparedRequest for transmission and returns it.

  • registerhook(_event, hook)

  • Properly register a hook.
  • class requests.Response[源代码]

  • The Response object, which contains aserver's response to an HTTP request.

    • apparent_encoding

    • The apparent encoding, provided by the chardet library.

    • close()[源代码]

    • Releases the connection back to the pool. Once this method has beencalled the underlying raw object must not be accessed again.

Note: Should not normally need to be called explicitly.

  • content

  • Content of the response, in bytes.

  • cookies = None

  • A CookieJar of Cookies the server sent back.

  • elapsed = None

  • The amount of time elapsed between sending the requestand the arrival of the response (as a timedelta).This property specifically measures the time taken between sendingthe first byte of the request and finishing parsing the headers. Itis therefore unaffected by consuming the response content or thevalue of the stream keyword argument.

  • encoding = None

  • Encoding to decode with when accessing r.text.

  • headers = None

  • Case-insensitive Dictionary of Response Headers.For example, headers['content-encoding'] will return thevalue of a 'Content-Encoding' response header.

  • history = None

  • A list of Response objects fromthe history of the Request. Any redirect responses will endup here. The list is sorted from the oldest to the most recent request.

  • is_permanent_redirect

  • True if this Response one of the permanent versions of redirect.

  • is_redirect

  • True if this Response is a well-formed HTTP redirect that could havebeen processed automatically (by Session.resolve_redirects).

  • itercontent(_chunk_size=1, decode_unicode=False)[源代码]

  • Iterates over the response data. When stream=True is set on therequest, this avoids reading the content at once into memory forlarge responses. The chunk size is the number of bytes it shouldread into memory. This is not necessarily the length of each itemreturned as decoding can take place.

chunksize must be of type int or None. A value of None willfunction differently depending on the value of _stream.stream=True will read data as it arrives in whatever size thechunks are received. If stream=False, data is returned asa single chunk.

If decode_unicode is True, content will be decoded using the bestavailable encoding based on the response.

  • iterlines(_chunk_size=512, decode_unicode=None, delimiter=None)[源代码]
  • Iterates over the response data, one line at a time. Whenstream=True is set on the request, this avoids reading thecontent at once into memory for large responses.

注解

This method is not reentrant safe.

  • json(**kwargs)[源代码]
  • Returns the json-encoded content of a response, if any.

参数:**kwargs — Optional arguments that json.loads takes.引发:ValueError — If the response body does not contain valid json.

  • links

  • Returns the parsed header links of the response, if any.

  • next

  • Returns a PreparedRequest for the next request in a redirect chain, if there is one.

  • ok

  • Returns True if status_code is less than 400.

This attribute checks if the status code of the response is between400 and 600 to see if there was a client error or a server error. Ifthe status code, is between 200 and 400, this will return True. Thisis not a check to see if the response code is 200 OK.

  • raise_for_status()[源代码]

  • Raises stored HTTPError, if one occurred.

  • raw = None

  • File-like object representation of response (for advanced usage).Use of raw requires that stream=True be set on the request.

  • reason = None

  • Textual reason of responded HTTP Status, e.g. "Not Found" or "OK".

  • request = None

  • The PreparedRequest object to which thisis a response.

  • statuscode = None_

  • Integer Code of responded HTTP Status, e.g. 404 or 200.

  • text

  • Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed usingchardet.

The encoding of the response content is determined based solely on HTTPheaders, following RFC 2616 to the letter. If you can take advantage ofnon-HTTP knowledge to make a better guess at the encoding, you shouldset r.encoding appropriately before accessing this property.

  • url = None
  • Final URL location of Response.

更低级的类

  • class requests.PreparedRequest[源代码]
  • The fully mutable PreparedRequest object,containing the exact bytes that will be sent to the server.

Generated from either a Request object or manually.

Usage:

  1. >>> import requests
  2. >>> req = requests.Request('GET', 'http://httpbin.org/get')
  3. >>> r = req.prepare()
  4. <PreparedRequest [GET]>
  5.  
  6. >>> s = requests.Session()
  7. >>> s.send(r)
  8. <Response [200]>
  • body = None

  • request body to send to the server.

  • deregisterhook(_event, hook)

  • Deregister a previously registered hook.Returns True if the hook existed, False if not.

  • headers = None

  • dictionary of HTTP headers.

  • hooks = None

  • dictionary of callback hooks, for internal usage.

  • method = None

  • HTTP verb to send to the server.

  • path_url

  • Build the path URL to use.

  • prepare(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[源代码]

  • Prepares the entire request with the given parameters.

  • prepareauth(_auth, url='')[源代码]

  • Prepares the given HTTP auth data.

  • preparebody(_data, files, json=None)[源代码]

  • Prepares the given HTTP body data.

  • preparecontent_length(_body)[源代码]

  • Prepare Content-Length header based on request method and body

  • preparecookies(_cookies)[源代码]

  • Prepares the given HTTP cookie data.

This function eventually generates a Cookie header from thegiven cookies using cookielib. Due to cookielib's design, the headerwill not be regenerated if it already exists, meaning this functioncan only be called once for the life of thePreparedRequest object. Any subsequent callsto prepare_cookies will have no actual effect, unless the "Cookie"header is removed beforehand.

  • prepareheaders(_headers)[源代码]

  • Prepares the given HTTP headers.

  • preparehooks(_hooks)[源代码]

  • Prepares the given hooks.

  • preparemethod(_method)[源代码]

  • Prepares the given HTTP method.

  • prepareurl(_url, params)[源代码]

  • Prepares the given HTTP URL.

  • registerhook(_event, hook)

  • Properly register a hook.

  • url = None

  • HTTP URL to send the request to.
  • class requests.adapters.BaseAdapter[源代码]

  • The Base Transport Adapter

    • close()[源代码]

    • Cleans up adapter specific items.

    • send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)[源代码]

    • Sends PreparedRequest object. Returns Response object.

参数:

  1. - **request** -- The [<code>PreparedRequest</code>](https://2.python-requests.org/zh_CN/latest/#requests.PreparedRequest) being sent.
  2. - **stream** -- (optional) Whether to stream the request content.
  3. - **timeout** (_float__ or __tuple_) -- (optional) How long to wait for the server to senddata before giving up, as a float, or a [(connect timeout,read timeout)]($a97ca0386b4264f7.md#timeouts) tuple.
  4. - **verify** -- (optional) Either a boolean, in which case it controls whether we verifythe server&#39;s TLS certificate, or a string, in which case it must be a pathto a CA bundle to use
  5. - **cert** -- (optional) Any user-provided SSL certificate to be trusted.
  6. - **proxies** -- (optional) The proxies dictionary to apply to the request.
  • class requests.adapters.HTTPAdapter(pool_connections=10, pool_maxsize=10, max_retries=0, pool_block=False)[源代码]
  • The built-in HTTP Adapter for urllib3.

Provides a general-case interface for Requests sessions to contact HTTP andHTTPS urls by implementing the Transport Adapter interface. This class willusually be created by the Session class under thecovers.

参数:

  • pool_connections — The number of urllib3 connection pools to cache.
  • pool_maxsize — The maximum number of connections to save in the pool.
  • max_retries — The maximum number of retries each connectionshould attempt. Note, this applies only to failed DNS lookups, socketconnections and connection timeouts, never to requests where data hasmade it to the server. By default, Requests does not retry failedconnections. If you need granular control over the conditions underwhich we retry a request, import urllib3's Retry class and passthat instead.
  • pool_block — Whether the connection pool should block for connections.

Usage:

  1. >>> import requests
  2. >>> s = requests.Session()
  3. >>> a = requests.adapters.HTTPAdapter(max_retries=3)
  4. >>> s.mount('http://', a)
  • addheaders(_request, **kwargs)[源代码]
  • Add any headers needed by the connection. As of v2.0 this doesnothing by default, but is left for overriding by users that subclassthe HTTPAdapter.

This should not be called from user code, and is only exposed for usewhen subclassing theHTTPAdapter.

参数:

  1. - **request** -- The [<code>PreparedRequest</code>](https://2.python-requests.org/zh_CN/latest/#requests.PreparedRequest) to add headers to.
  2. - **kwargs** -- The keyword arguments from the call to send().
  • buildresponse(_req, resp)[源代码]
  • Builds a Response object from a urllib3response. This should not be called from user code, and is only exposedfor use when subclassing theHTTPAdapter

参数:

  1. - **req** -- The [<code>PreparedRequest</code>](https://2.python-requests.org/zh_CN/latest/#requests.PreparedRequest) used to generate the response.
  2. - **resp** -- The urllib3 response object.返回类型:

requests.Response

  • certverify(_conn, url, verify, cert)[源代码]
  • Verify a SSL certificate. This method should not be called from usercode, and is only exposed for use when subclassing theHTTPAdapter.

参数:

  1. - **conn** -- The urllib3 connection object associated with the cert.
  2. - **url** -- The requested URL.
  3. - **verify** -- Either a boolean, in which case it controls whether we verifythe server&#39;s TLS certificate, or a string, in which case it must be a pathto a CA bundle to use
  4. - **cert** -- The SSL certificate to verify.

Currently, this closes the PoolManager and any active ProxyManager,which closes any pooled connections.

  • getconnection(_url, proxies=None)[源代码]
  • Returns a urllib3 connection for the given URL. This should not becalled from user code, and is only exposed for use when subclassing theHTTPAdapter.

参数:

  1. - **url** -- The URL to connect to.
  2. - **proxies** -- (optional) A Requests-style dictionary of proxies used on this request.返回类型:

urllib3.ConnectionPool

  • initpoolmanager(_connections, maxsize, block=False, **pool_kwargs)[源代码]
  • Initializes a urllib3 PoolManager.

This method should not be called from user code, and is onlyexposed for use when subclassing theHTTPAdapter.

参数:

  1. - **connections** -- The number of urllib3 connection pools to cache.
  2. - **maxsize** -- The maximum number of connections to save in the pool.
  3. - **block** -- Block when no free connections are available.
  4. - **pool_kwargs** -- Extra keyword arguments used to initialize the Pool Manager.
  • proxyheaders(_proxy)[源代码]
  • Returns a dictionary of the headers to add to any request sentthrough a proxy. This works with urllib3 magic to ensure that they arecorrectly sent to the proxy, rather than in a tunnelled request ifCONNECT is being used.

This should not be called from user code, and is only exposed for usewhen subclassing theHTTPAdapter.

参数:proxies — The url of the proxy being used for this request.返回类型:dict

  • proxymanager_for(_proxy, **proxy_kwargs)[源代码]
  • Return urllib3 ProxyManager for the given proxy.

This method should not be called from user code, and is onlyexposed for use when subclassing theHTTPAdapter.

参数:

  1. - **proxy** -- The proxy to return a urllib3 ProxyManager for.
  2. - **proxy_kwargs** -- Extra keyword arguments used to configure the Proxy Manager.返回:

ProxyManager 返回类型: urllib3.ProxyManager

  • requesturl(_request, proxies)[源代码]
  • Obtain the url to use when making the final request.

If the message is being sent through a HTTP proxy, the full URL has tobe used. Otherwise, we should only use the path portion of the URL.

This should not be called from user code, and is only exposed for usewhen subclassing theHTTPAdapter.

参数:

  1. - **request** -- The [<code>PreparedRequest</code>](https://2.python-requests.org/zh_CN/latest/#requests.PreparedRequest) being sent.
  2. - **proxies** -- A dictionary of schemes or schemes and hosts to proxy URLs.返回类型:

str

  • send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)[源代码]
  • Sends PreparedRequest object. Returns Response object.

参数:

  1. - **request** -- The [<code>PreparedRequest</code>](https://2.python-requests.org/zh_CN/latest/#requests.PreparedRequest) being sent.
  2. - **stream** -- (optional) Whether to stream the request content.
  3. - **timeout** (_float__ or __tuple__ or __urllib3 Timeout object_) -- (optional) How long to wait for the server to senddata before giving up, as a float, or a [(connect timeout,read timeout)]($a97ca0386b4264f7.md#timeouts) tuple.
  4. - **verify** -- (optional) Either a boolean, in which case it controls whetherwe verify the server&#39;s TLS certificate, or a string, in which case itmust be a path to a CA bundle to use
  5. - **cert** -- (optional) Any user-provided SSL certificate to be trusted.
  6. - **proxies** -- (optional) The proxies dictionary to apply to the request.返回类型:

requests.Response

身份验证

  • class requests.auth.AuthBase[源代码]

  • Base class that all auth implementations derive from

  • class requests.auth.HTTPBasicAuth(username, password)[源代码]

  • Attaches HTTP Basic Authentication to the given Request object.

  • class requests.auth.HTTPProxyAuth(username, password)[源代码]

  • Attaches HTTP Proxy Authentication to a given Request object.

  • class requests.auth.HTTPDigestAuth(username, password)[源代码]

  • Attaches HTTP Digest Authentication to the given Request object.

编码

  • requests.utils.getencodings_from_content(_content)[源代码]
  • Returns encodings from given content string.

参数:content — bytestring to extract encodings from.

  • requests.utils.getencoding_from_headers(_headers)[源代码]
  • Returns encodings from given HTTP Header Dict.

参数:headers — dictionary to extract encoding from.返回类型:str

  • requests.utils.getunicode_from_response(_r)[源代码]
  • Returns the requested content back in unicode.

参数:r — Response object to get unicode content from.

Tried:

  • charset from content-type
  • fall back and replace all unicode characters 返回类型:str
  • requests.utils.adddict_to_cookiejar(_cj, cookie_dict)[源代码]
  • Returns a CookieJar from a key/value dictionary.

参数:

  • cj — CookieJar to insert cookies into.
  • cookie_dict — Dict of key/values to insert into CookieJar.返回类型: CookieJar
  • requests.utils.cookiejarfrom_dict(_cookie_dict, cookiejar=None, overwrite=True)[源代码]
  • Returns a CookieJar from a key/value dictionary.

参数:

  • cookie_dict — Dict of key/values to insert into CookieJar.
  • cookiejar — (optional) A cookiejar to add the cookies to.
  • overwrite — (optional) If False, will not replace cookiesalready in the jar with new ones.
  • class requests.cookies.RequestsCookieJar(policy=None)[源代码]
  • Compatibility class; is a cookielib.CookieJar, but exposes a dictinterface.

This is the CookieJar we create by default for requests and sessions thatdon't specify one, since some clients may expect response.cookies andsession.cookies to support dict operations.

Requests does not use the dict interface internally; it's just forcompatibility with external client code. All requests code should workout of the box with externally provided instances of CookieJar, e.g.LWPCookieJar and FileCookieJar.

Unlike a regular CookieJar, this class is pickleable.

警告

dictionary operations that are normally O(1) may be O(n).

  • addcookie_header(_request)
  • Add correct Cookie: header to request (urllib2.Request object).

The Cookie2 header is also added unless policy.hide_cookie2 is true.

  • clear(domain=None, path=None, name=None)
  • Clear some cookies.

Invoking this method without arguments will clear all cookies. Ifgiven a single argument, only cookies belonging to that domain will beremoved. If given two arguments, cookies belonging to the specifiedpath within that domain are removed. If given three arguments, thenthe cookie with the specified name, path and domain is removed.

Raises KeyError if no matching cookie exists.

  • clear_expired_cookies()
  • Discard all expired cookies.

You probably don't need to call this method: expired cookies are neversent back to the server (provided you're using DefaultCookiePolicy),this method is called by CookieJar itself every so often, and the.save() method won't save expired cookies anyway (unless you askotherwise by passing a true ignore_expires argument).

  • clear_session_cookies()
  • Discard all session cookies.

Note that the .save() method won't save session cookies anyway, unlessyou ask otherwise by passing a true ignore_discard argument.

  • copy()[源代码]

  • Return a copy of this RequestsCookieJar.

  • extractcookies(_response, request)

  • Extract cookies from response, where allowable given the request.

  • get(name, default=None, domain=None, path=None)[源代码]

  • Dict-like get() that also supports optional domain and path args inorder to resolve naming collisions from using one cookie jar overmultiple domains.

警告

operation is O(n), not O(1).

  • getdict(_domain=None, path=None)[源代码]
  • Takes as an argument an optional domain and path and returns a plainold Python dict of name-value pairs of cookies that meet therequirements.

返回类型:dict

  • items()[源代码]
  • Dict-like items() that returns a list of name-value tuples from thejar. Allows client-code to call dict(RequestsCookieJar) and get avanilla python dict of key value pairs.

参见

keys() and values().

  • iteritems()[源代码]
  • Dict-like iteritems() that returns an iterator of name-value tuplesfrom the jar.

参见

iterkeys() and itervalues().

  • iterkeys()[源代码]
  • Dict-like iterkeys() that returns an iterator of names of cookiesfrom the jar.

参见

itervalues() and iteritems().

  • itervalues()[源代码]
  • Dict-like itervalues() that returns an iterator of values of cookiesfrom the jar.

参见

iterkeys() and iteritems().

  • keys()[源代码]
  • Dict-like keys() that returns a list of names of cookies from thejar.

参见

values() and items().

  • list_domains()[源代码]

  • Utility method to list all the domains in the jar.

  • list_paths()[源代码]

  • Utility method to list all the paths in the jar.

  • makecookies(_response, request)

  • Return sequence of Cookie objects extracted from response object.

  • multiple_domains()[源代码]

  • Returns True if there are multiple domains in the jar.Returns False otherwise.

返回类型:bool

  • pop(k[, d]) → v, remove specified key and return the corresponding value.

  • If key is not found, d is returned if given, otherwise KeyError is raised.

  • popitem() → (k, v), remove and return some (key, value) pair

  • as a 2-tuple; but raise KeyError if D is empty.

  • set(name, value, **kwargs)[源代码]

  • Dict-like set() that also supports optional domain and path args inorder to resolve naming collisions from using one cookie jar overmultiple domains.

  • setcookie_if_ok(_cookie, request)

  • Set a cookie if policy says it's OK to do so.

  • setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

  • update(other)[源代码]

  • Updates this jar with cookies from another CookieJar or dict-like

  • values()[源代码]

  • Dict-like values() that returns a list of values of cookies from thejar.

参见

keys() and items().

  • class requests.cookies.CookieConflictError[源代码]
  • There 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.

状态码查询

  • requests.codes
  1. >>> requests.codes['temporary_redirect']
  2. 307
  3.  
  4. >>> requests.codes.teapot
  5. 418
  6.  
  7. >>> requests.codes['\o/']
  8. 200
  • class requests.Request(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[源代码]
  • A user-created Request object.

Used to prepare a PreparedRequest, which is sent to the server.

参数:

  • method — HTTP method to use.
  • url — URL to send.
  • headers — dictionary of headers to send.
  • files — dictionary of {filename: fileobject} files to multipart upload.
  • data — the body to attach to the request. If a dictionary is provided, form-encoding will take place.
  • json — json for the body to attach to the request (if files or data is not specified).
  • params — dictionary of URL parameters to append to the URL.
  • auth — Auth handler or (user, pass) tuple.
  • cookies — dictionary or CookieJar of cookies to attach to this request.
  • hooks — dictionary of callback hooks, for internal usage.

Usage:

  1. >>> import requests
  2. >>> req = requests.Request('GET', 'http://httpbin.org/get')
  3. >>> req.prepare()
  4. <PreparedRequest [GET]>
  • deregisterhook(_event, hook)

  • Deregister a previously registered hook.Returns True if the hook existed, False if not.

  • prepare()[源代码]

  • Constructs a PreparedRequest for transmission and returns it.

  • registerhook(_event, hook)

  • Properly register a hook.
  • class requests.Response[源代码]

  • The Response object, which contains aserver's response to an HTTP request.

    • apparent_encoding

    • The apparent encoding, provided by the chardet library.

    • close()[源代码]

    • Releases the connection back to the pool. Once this method has beencalled the underlying raw object must not be accessed again.

Note: Should not normally need to be called explicitly.

  • content

  • Content of the response, in bytes.

  • cookies = None

  • A CookieJar of Cookies the server sent back.

  • elapsed = None

  • The amount of time elapsed between sending the requestand the arrival of the response (as a timedelta).This property specifically measures the time taken between sendingthe first byte of the request and finishing parsing the headers. Itis therefore unaffected by consuming the response content or thevalue of the stream keyword argument.

  • encoding = None

  • Encoding to decode with when accessing r.text.

  • headers = None

  • Case-insensitive Dictionary of Response Headers.For example, headers['content-encoding'] will return thevalue of a 'Content-Encoding' response header.

  • history = None

  • A list of Response objects fromthe history of the Request. Any redirect responses will endup here. The list is sorted from the oldest to the most recent request.

  • is_permanent_redirect

  • True if this Response one of the permanent versions of redirect.

  • is_redirect

  • True if this Response is a well-formed HTTP redirect that could havebeen processed automatically (by Session.resolve_redirects).

  • itercontent(_chunk_size=1, decode_unicode=False)[源代码]

  • Iterates over the response data. When stream=True is set on therequest, this avoids reading the content at once into memory forlarge responses. The chunk size is the number of bytes it shouldread into memory. This is not necessarily the length of each itemreturned as decoding can take place.

chunksize must be of type int or None. A value of None willfunction differently depending on the value of _stream.stream=True will read data as it arrives in whatever size thechunks are received. If stream=False, data is returned asa single chunk.

If decode_unicode is True, content will be decoded using the bestavailable encoding based on the response.

  • iterlines(_chunk_size=512, decode_unicode=None, delimiter=None)[源代码]
  • Iterates over the response data, one line at a time. Whenstream=True is set on the request, this avoids reading thecontent at once into memory for large responses.

注解

This method is not reentrant safe.

  • json(**kwargs)[源代码]
  • Returns the json-encoded content of a response, if any.

参数:**kwargs — Optional arguments that json.loads takes.引发:ValueError — If the response body does not contain valid json.

  • links

  • Returns the parsed header links of the response, if any.

  • next

  • Returns a PreparedRequest for the next request in a redirect chain, if there is one.

  • ok

  • Returns True if status_code is less than 400.

This attribute checks if the status code of the response is between400 and 600 to see if there was a client error or a server error. Ifthe status code, is between 200 and 400, this will return True. Thisis not a check to see if the response code is 200 OK.

  • raise_for_status()[源代码]

  • Raises stored HTTPError, if one occurred.

  • raw = None

  • File-like object representation of response (for advanced usage).Use of raw requires that stream=True be set on the request.

  • reason = None

  • Textual reason of responded HTTP Status, e.g. "Not Found" or "OK".

  • request = None

  • The PreparedRequest object to which thisis a response.

  • statuscode = None_

  • Integer Code of responded HTTP Status, e.g. 404 or 200.

  • text

  • Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed usingchardet.

The encoding of the response content is determined based solely on HTTPheaders, following RFC 2616 to the letter. If you can take advantage ofnon-HTTP knowledge to make a better guess at the encoding, you shouldset r.encoding appropriately before accessing this property.

  • url = None
  • Final URL location of Response.

迁移到 1.x

本节详细介绍 0.x 和 1.x 的主要区别，减少升级带来的一些不便。

API 变化

  • Response.json 现在是可调用的并且不再是响应体的属性。
  1. import requests
  2. r = requests.get('https://github.com/timeline.json')
  3. r.json()   # 如果 JSON 解码失败，该调用会引发异常。
  • Session API 也发生了变化. Sessions 对象不再需要参数了。Session 现在是大写的了，但为了向后兼容，它仍然能被小写的 session 实例化。
  1. s = requests.Session()    # 过去会话需要接收参数
  2. s.auth = auth
  3. s.headers.update(headers)
  4. r = s.get('http://httpbin.org/headers')

  • 除了'response'，所有的请求挂钩已被移除。

  • 认证助手已经被分解成单独的模块了. 参见requests-oauthlib and requests-kerberos.

  • 流请求的参数已从 prefetch 改变到 stream ，并且逻辑也被颠倒。除此之外，stream 现在对于原始响应读取也是必需的。

  1. # 在 0.x 中，传入 prefetch=False 会达到同样的结果
  2. r = requests.get('https://github.com/timeline.json', stream=True)
  3. for chunk in r.iter_content(8192):
  4.     ...
  • requests 方法的 config 参数已全部删除。 现在配置这些选项都在 Session ，比如keep-alive 和最大数目的重定向。 详细程度选项应当由配置日志来处理。
  1. import requests
  2. import logging
  3.  
  4. # 启用调试于 http.client 级别 (requests->urllib3->http.client)
  5. # 你将能看到 REQUEST，包括 HEADERS 和 DATA，以及包含 HEADERS 但不包含 DATA 的 RESPONSE。
  6. # 唯一缺少的是 response.body，它不会被 log 记录。
  7. try: # for Python 3
  8.     from http.client import HTTPConnection
  9. except ImportError:
  10.     from httplib import HTTPConnection
  11. HTTPConnection.debuglevel = 1
  12.  
  13. logging.basicConfig() # 初始化 logging，否则不会看到任何 requests 的输出。
  14. logging.getLogger().setLevel(logging.DEBUG)
  15. requests_log = logging.getLogger("requests.packages.urllib3")
  16. requests_log.setLevel(logging.DEBUG)
  17. requests_log.propagate = True
  18.  
  19. requests.get('http://httpbin.org/headers')

许可

有一个关键的与 API 无关的区别是开放许可从 ISC 许可 变更到 Apache 2.0 许可. Apache 2.0license 确保了对于 Requests 的贡献也被涵盖在 Apache 2.0 许可内.

迁移到 2.x

和 1.0 发布版相比，破坏向后兼容的更改比较少。不过在这个主发布版本中，依然还有一些应该注意的问题。

更多关于变更的细节，包括 API，以及相关的 GitHub Issue 和部分 bug 修复，请参阅 Cory blog中的相关主题。

API 变化

  • Requests 处理异常的行为有部分更改。 RequestException 现在是 IOError的子类，而非 RuntimeError 的子类，新的归类更为合理。此外，无效的 URL转义序列现在会引发 RequestException 的一个子类，而非一个 ValueError。
  1. requests.get('http://%zz/')   # raises requests.exceptions.InvalidURL

最后， 错误分块导致的 httplib.IncompleteRead 异常现在变成了 ChunkedEncodingError。

  • 代理 API 略有改动，现在需要提供代理 URL 的 scheme。
  1. proxies = {
  2.   "http": "10.10.1.10:3128",    # 需使用 http://10.10.1.10:3128
  3. }
  4.  
  5. # requests 1.x 中有效， requests 2.x 中会引发 requests.exceptions.MissingSchema
  6.  
  7. requests.get("http://example.org", proxies=proxies)

行为变化

  • headers 字典中的 key 现在都是原生字符串，在所有版本的 Python中都是如此。也就是说，Python 2 中是 bytestring，Python 3 中是 unicode。如果 key 不是原声字符串（Python 2 中 unicode，或 Python 3 中 bytestring）它们会被以 UTF-8 编码转成原生字符串。
  • headers 字典中的 value 应该都是字符串。在 1.0 版之前该项目就是要求这样做的，只不过最近（v2.11.0之后）这条变成了强制条款。建议在可能的情况下，避免让 header 值使用 unicode 编码。