Python requests模塊相關接口

主要接口

Requests 全部的功能均可以經過如下 7 個方法訪問。它們所有都會返回一個 Response 對象的實例。

requests.request(method, url, **kwargs)[源代碼]

Constructs and sends a Request.

參數:	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, 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 string defining the content type of the given file and custom_headers a dict-like object containing additional headers to add for the file. auth -- (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth. timeout (float or tuple) -- (optional) How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple. allow_redirects (bool) -- (optional) Boolean. Set to True if POST/PUT/DELETE redirect following is allowed. proxies -- (optional) Dictionary mapping protocol to the URL of the proxy. verify -- (optional) whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. 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:

>>> import requests
>>> req = requests.request('GET', 'http://httpbin.org/get')
<Response [200]>

requests.head(url, **kwargs)[源代碼]

Sends a HEAD request.

參數:	url -- URL for the new Request object. **kwargs -- Optional arguments that request takes.
返回:	Response object
返回類型:	requests.Response

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, 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, bytes, or file-like object 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, bytes, or file-like object 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.

參數:	url -- URL for the new Request object. **kwargs -- Optional arguments that request takes.
返回:	Response object
返回類型:	requests.Response

異常

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

There was an ambiguous exception that occurred while handling your request.

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 both ConnectTimeout and ReadTimeout errors.

請求會話

class requests.Session[源代碼]

A Requests session.

Provides cookie persistence, connection-pooling, and configuration.

Basic Usage:

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

Or as a context manager:

>>> with requests.Session() as s:
>>>     s.get('http://httpbin.org/get')
<Response [200]>

auth = None

Default Authentication tuple or object to attach to Request.

cert = None

SSL certificate default.

close()[源代碼]

Closes all adapters and as such the session

cookies = None

A CookieJar containing all currently outstanding cookies set on this session. By default it is aRequestsCookieJar, but may be any other cookielib.CookieJar compatible object.

delete(url, **kwargs)[源代碼]

Sends a DELETE request. Returns Response object.

參數:	url -- URL for the new Request object. **kwargs -- Optional arguments that request takes.

get(url, **kwargs)[源代碼]

Sends a GET request. Returns Response object.

參數:	url -- URL for the new Request object. **kwargs -- Optional arguments that request takes.

get_adapter(url)[源代碼]

Returns the appropriate connection adapter for the given URL.

head(url, **kwargs)[源代碼]

Sends a HEAD request. Returns Response object.

參數:	url -- URL for the new Request object. **kwargs -- Optional arguments that request takes.

headers = None

A case-insensitive dictionary of headers to be sent on each Request sent from this Session.

hooks = None

Event-handling hooks.

max_redirects = None

Maximum number of redirects allowed. If the request exceeds this limit, a TooManyRedirectsexception is raised. This defaults to requests.models.DEFAULT_REDIRECT_LIMIT, which is 30.

merge_environment_settings(url, proxies, stream, verify, cert)[源代碼]

Check the environment and merge it with some settings.

mount(prefix, adapter)[源代碼]

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by key length.

options(url, **kwargs)[源代碼]

Sends a OPTIONS request. Returns Response object.

參數:	url -- URL for the new Request object. **kwargs -- Optional arguments that request takes.

params = None

Dictionary of querystring data to attach to each Request. The dictionary values may be lists for representing multivalued query parameters.

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

Sends a PATCH request. Returns Response object.

參數:	url -- URL for the new Request object. data -- (optional) Dictionary, bytes, or file-like object to send in the body of the Request. **kwargs -- Optional arguments that request takes.

post(url, data=None, json=None, **kwargs)[源代碼]

Sends a POST request. Returns Response object.

參數:	url -- URL for the new Request object. data -- (optional) Dictionary, bytes, or file-like object to send in the body of the Request. json -- (optional) json to send in the body of the Request. **kwargs -- Optional arguments that request takes.

prepare_request(request)[源代碼]

Constructs a PreparedRequest for transmission and returns it. The PreparedRequest has settings merged from the Request instance and those of the Session.

參數:	request -- Request instance to prepare with this session's settings.

proxies = None

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

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

Sends a PUT request. Returns Response object.

參數:	url -- URL for the new Request object. data -- (optional) Dictionary, bytes, or file-like object to send in the body of the Request. **kwargs -- Optional arguments that request takes.

rebuild_auth(prepared_request, response)

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

rebuild_method(prepared_request, response)

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

rebuild_proxies(prepared_request, proxies)

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

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.

參數:

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, bytes, or file-like object to send in the body of the Request. json -- (optional) json 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 'filename': file-like-objects for multipart encoding upload. auth -- (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth. timeout (float or tuple) -- (optional) How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple. allow_redirects (bool) -- (optional) Set to True by default. proxies -- (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy. stream -- (optional) whether to immediately download the response content. Defaults to False. verify -- (optional) whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. Defaults to True. cert -- (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.

返回類型:

requests.Response

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, **adapter_kwargs)

Receives a Response. Returns a generator of Responses.

send(request, **kwargs)[源代碼]

Send a given PreparedRequest.

stream = None

Stream response content default.

trust_env = None

Trust environment settings for proxy configuration, default authentication 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:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> req.prepare()
<PreparedRequest [GET]>

deregister_hook(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.

register_hook(event, hook)

Properly register a hook.

class requests.Response[源代碼]

The Response object, which contains a server'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 been called the underlying rawobject 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 request and the arrival of the response (as a timedelta). This property specifically measures the time taken between sending the first byte of the request and finishing parsing the headers. It is therefore unaffected by consuming the response content or the value 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 the value of a 'Content-Encoding' response header.

history = None

A list of Response objects from the history of the Request. Any redirect responses will end up 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 have been processed automatically (by Session.resolve_redirects).

iter_content(chunk_size=1, decode_unicode=False)[源代碼]

Iterates over the response data. When stream=True is set on the request, this avoids reading the content at once into memory for large responses. The chunk size is the number of bytes it should read into memory. This is not necessarily the length of each item returned as decoding can take place.

chunk_size must be of type int or None. A value of None will function differently depending on the value of stream. stream=True will read data as it arrives in whatever size the chunks are recieved. If stream=False, data is returned as a single chunk.

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

iter_lines(chunk_size=512, decode_unicode=None, delimiter=None)[源代碼]

Iterates over the response data, one line at a time. When stream=True is set on the request, this avoids reading the content 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.

links

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

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 this is a response.

status_code = 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 using chardet.

The encoding of the response content is determined based solely on HTTP headers, following RFC 2616 to the letter. If you can take advantage of non-HTTP knowledge to make a better guess at the encoding, you should set 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:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> r = req.prepare()
<PreparedRequest [GET]>

>>> s = requests.Session()
>>> s.send(r)
<Response [200]>

body = None

request body to send to the server.

deregister_hook(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.

prepare_auth(auth, url='')[源代碼]

Prepares the given HTTP auth data.

prepare_body(data, files, json=None)[源代碼]

Prepares the given HTTP body data.

prepare_cookies(cookies)[源代碼]

Prepares the given HTTP cookie data.

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

prepare_headers(headers)[源代碼]

Prepares the given HTTP headers.

prepare_hooks(hooks)[源代碼]

Prepares the given hooks.

prepare_method(method)[源代碼]

Prepares the given HTTP method.

prepare_url(url, params)[源代碼]

Prepares the given HTTP URL.

register_hook(event, hook)

Properly register a hook.

url = None

HTTP URL to send the request to.

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 and HTTPS urls by implementing the Transport Adapter interface. This class will usually be created by the Session class under the covers.

參數:

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 connection should attempt. Note, this applies only to failed DNS lookups, socket connections and connection timeouts, never to requests where data has made it to the server. By default, Requests does not retry failed connections. If you need granular control over the conditions under which we retry a request, import urllib3's Retry class and pass that instead. pool_block -- Whether the connection pool should block for connections.

Usage:

>>> import requests
>>> s = requests.Session()
>>> a = requests.adapters.HTTPAdapter(max_retries=3)
>>> s.mount('http://', a)

add_headers(request, **kwargs)[源代碼]

Add any headers needed by the connection. As of v2.0 this does nothing by default, but is left for overriding by users that subclass the HTTPAdapter.

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

參數:	request -- The PreparedRequest to add headers to. kwargs -- The keyword arguments from the call to send().

build_response(req, resp)[源代碼]

Builds a Response object from a urllib3 response. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter

參數:	req -- The PreparedRequest used to generate the response. resp -- The urllib3 response object.

cert_verify(conn, url, verify, cert)[源代碼]

Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

參數:	conn -- The urllib3 connection object associated with the cert. url -- The requested URL. verify -- Whether we should actually verify the certificate. cert -- The SSL certificate to verify.

close()[源代碼]

Disposes of any internal state.

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

get_connection(url, proxies=None)[源代碼]

Returns a urllib3 connection for the given URL. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

參數:	url -- The URL to connect to. proxies -- (optional) A Requests-style dictionary of proxies used on this request.

init_poolmanager(connections, maxsize, block=False, **pool_kwargs)[源代碼]

Initializes a urllib3 PoolManager.

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

參數:	connections -- The number of urllib3 connection pools to cache. maxsize -- The maximum number of connections to save in the pool. block -- Block when no free connections are available. pool_kwargs -- Extra keyword arguments used to initialize the Pool Manager.

proxy_headers(proxy)[源代碼]

Returns a dictionary of the headers to add to any request sent through a proxy. This works with urllib3 magic to ensure that they are correctly sent to the proxy, rather than in a tunnelled request if CONNECT is being used.

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

參數:	proxies -- The url of the proxy being used for this request.

proxy_manager_for(proxy, **proxy_kwargs)[源代碼]

Return urllib3 ProxyManager for the given proxy.

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

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

request_url(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 to be 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 use when subclassing theHTTPAdapter.

參數:	request -- The PreparedRequest being sent. proxies -- A dictionary of schemes or schemes and hosts to proxy URLs.

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

Sends PreparedRequest object. Returns Response object.

參數:

request -- The PreparedRequest being sent. stream -- (optional) Whether to stream the request content. timeout (float or tuple) -- (optional) How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple. verify -- (optional) Whether to verify SSL certificates. cert -- (optional) Any user-provided SSL certificate to be trusted. proxies -- (optional) The proxies dictionary to apply to the request.

身份驗證

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.get_encodings_from_content(content)[源代碼]

Returns encodings from given content string.

參數:	content -- bytestring to extract encodings from.

requests.utils.get_encoding_from_headers(headers)[源代碼]

Returns encodings from given HTTP Header Dict.

參數:	headers -- dictionary to extract encoding from.

requests.utils.get_unicode_from_response(r)[源代碼]

Returns the requested content back in unicode.

參數:	r -- Response object to get unicode content from.

Tried:

1. charset from content-type
2. fall back and replace all unicode characters

Cookie

requests.utils.dict_from_cookiejar(cj)[源代碼]

Returns a key/value dictionary from a CookieJar.

參數:	cj -- CookieJar object to extract cookies from.

requests.utils.cookiejar_from_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 cookies already in the jar with new ones.

requests.utils.add_dict_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.

class requests.cookies.RequestsCookieJar(policy=None)[源代碼]

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.

警告

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

add_cookie_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. If given a single argument, only cookies belonging to that domain will be removed. If given two arguments, cookies belonging to the specified path within that domain are removed. If given three arguments, then the 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 never sent 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 ask otherwise 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, unless you ask otherwise by passing a true ignore_discard argument.

copy()[源代碼]

Return a copy of this RequestsCookieJar.

extract_cookies(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 in order to resolve naming collisions from using one cookie jar over multiple domains.

警告

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

get_dict(domain=None, path=None)[源代碼]

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

items()[源代碼]

Dict-like items() that returns a list of name-value tuples from the jar. See keys() and values(). Allows client-code to call dict(RequestsCookieJar) and get a vanilla python dict of key value pairs.

iteritems()[源代碼]

Dict-like iteritems() that returns an iterator of name-value tuples from the jar. See iterkeys() and itervalues().

iterkeys()[源代碼]

Dict-like iterkeys() that returns an iterator of names of cookies from the jar. See itervalues() and iteritems().

itervalues()[源代碼]

Dict-like itervalues() that returns an iterator of values of cookies from the jar. See iterkeys() and iteritems().

keys()[源代碼]

Dict-like keys() that returns a list of names of cookies from the jar. See 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.

make_cookies(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.

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 in order to resolve naming collisions from using one cookie jar over multiple domains.

set_cookie_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 the jar. See 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

>>> requests.codes['temporary_redirect']
307

>>> requests.codes.teapot
418

>>> requests.codes['\o/']
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:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> req.prepare()
<PreparedRequest [GET]>

deregister_hook(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.

register_hook(event, hook)

Properly register a hook.

class requests.Response[源代碼]

The Response object, which contains a server'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 been called the underlying rawobject 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 request and the arrival of the response (as a timedelta). This property specifically measures the time taken between sending the first byte of the request and finishing parsing the headers. It is therefore unaffected by consuming the response content or the value 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 the value of a 'Content-Encoding' response header.

history = None

A list of Response objects from the history of the Request. Any redirect responses will end up 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 have been processed automatically (by Session.resolve_redirects).

iter_content(chunk_size=1, decode_unicode=False)[源代碼]

Iterates over the response data. When stream=True is set on the request, this avoids reading the content at once into memory for large responses. The chunk size is the number of bytes it should read into memory. This is not necessarily the length of each item returned as decoding can take place.

chunk_size must be of type int or None. A value of None will function differently depending on the value of stream. stream=True will read data as it arrives in whatever size the chunks are recieved. If stream=False, data is returned as a single chunk.

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

iter_lines(chunk_size=512, decode_unicode=None, delimiter=None)[源代碼]

Iterates over the response data, one line at a time. When stream=True is set on the request, this avoids reading the content 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.

links

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

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 this is a response.

status_code = 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 using chardet.

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

url = None

Final URL location of Response.

遷移到 1.x

本節詳細介紹 0.x 和 1.x 的主要區別，減小升級帶來的一些不便。

API 變化

• Response.json 如今是可調用的而且再也不是響應體的屬性。

  import requests
  r = requests.get('https://github.com/timeline.json')
  r.json()   # 若是 JSON 解碼失敗，該調用會引起異常。

• Session API 也發生了變化. Sessions 對象再也不須要參數了。 Session 如今是大寫的了，但爲了向後兼容，它仍然能被小寫的 session 實例化。

  s = requests.Session()    # 過去會話須要接收參數
  s.auth = auth
  s.headers.update(headers)
  r = s.get('http://httpbin.org/headers')

• 除了'response'，全部的請求掛鉤已被移除。

• 認證助手已經被分解成單獨的模塊了. 參見 requests-oauthlib and requests-kerberos.

• 流請求的參數已從 prefetch 改變到 stream ，而且邏輯也被顛倒。除此以外， stream 如今對於原始響應讀取也是必需的。

  # 在 0.x 中，傳入 prefetch=False 會達到一樣的結果
  r = requests.get('https://github.com/timeline.json', stream=True)
  for chunk in r.iter_content(8192):
      ...

• requests 方法的 config 參數已所有刪除。 如今配置這些選項都在 Session ，好比 keep-alive 和最大數目的重定向。 詳細程度選項應當由配置日誌來處理。

  import requests
  import logging
  
  # 啓用調試於 http.client 級別 (requests->urllib3->http.client)
  # 你將能看到 REQUEST，包括 HEADERS 和 DATA，以及包含 HEADERS 但不包含 DATA 的 RESPONSE。
  # 惟一缺乏的是 response.body，它不會被 log 記錄。
  try: # for Python 3
      from http.client import HTTPConnection
  except ImportError:
      from httplib import HTTPConnection
  HTTPConnection.debuglevel = 1
  
  logging.basicConfig() # 初始化 logging，不然不會看到任何 requests 的輸出。
  logging.getLogger().setLevel(logging.DEBUG)
  requests_log = logging.getLogger("requests.packages.urllib3")
  requests_log.setLevel(logging.DEBUG)
  requests_log.propagate = True
  
  requests.get('http://httpbin.org/headers')