Developer Interface¶
This part of the documentation covers all the interfaces of Requests. For parts where Requests depends on external libraries, we document the most important right here and provide links to the canonical documentation.
Main Interface¶
All of Request’s functionality can be accessed by these 7 methods.
They all return an instance of the Response object.
-
requests.request(method, url, **kwargs)¶ Constructs and sends a
Request. ReturnsResponseobject.Parameters: - method – method for the new
Requestobject. - url – URL for the new
Requestobject. - 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. - 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’: (‘filename’, fileobj)}) for multipart encoding upload.
- auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
- timeout – (optional) Float describing the timeout of the request.
- allow_redirects – (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) if
True, the SSL cert will be verified. A CA_BUNDLE path can also be provided. - 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.
Usage:
>>> import requests >>> req = requests.request('GET', 'http://httpbin.org/get') <Response [200]>
- method – method for the new
-
requests.head(url, **kwargs)¶ Sends a HEAD request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
requests.get(url, **kwargs)¶ Sends a GET request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
requests.patch(url, data=None, **kwargs)¶ Sends a PATCH request. Returns
Responseobject.Parameters:
-
requests.delete(url, **kwargs)¶ Sends a DELETE request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
Lower-Level Classes¶
-
class
requests.Request(method=None, url=None, headers=None, files=None, data={}, params={}, auth=None, cookies=None, hooks=None)¶ A user-created
Requestobject.Used to prepare a
PreparedRequest, which is sent to the server.Parameters: - 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 the request. If a dictionary is provided, form-encoding will take place.
- 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
PreparedRequestfor transmission and returns it.
-
register_hook(event, hook)¶ Properly register a hook.
-
class
requests.Response¶ The
Responseobject, which contains a server’s response to an HTTP request.-
apparent_encoding¶ The apparent encoding, provided by the lovely Charade library (Thanks, Ian!).
-
content¶ Content of the response, in bytes.
A CookieJar of Cookies the server sent back.
-
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
Responseobjects 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.
-
iter_content(chunk_size=1, decode_unicode=False)¶ Iterates over the response data. 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.
-
iter_lines(chunk_size=10240, decode_unicode=None)¶ Iterates over the response data, one line at a time. This avoids reading the content at once into memory for large responses.
-
json()¶ Returns the json-encoded content of a response, if any.
-
links¶ Returns the parsed header links of the response, if any.
-
raw= None¶ File-like object representation of response (for advanced usage). Requires that ``stream=True` on the request.
-
status_code= None¶ Integer Code of responded HTTP Status.
-
text¶ Content of the response, in unicode.
if Response.encoding is None and chardet module is available, encoding will be guessed.
-
url= None¶ Final URL location of Response.
-
Request Sessions¶
-
class
requests.Session¶ A Requests session.
Provides cookie persistience, connection-pooling, and configuration.
Basic Usage:
>>> import requests >>> s = requests.Session() >>> s.get('http://httpbin.org/get') 200
-
cert= None¶ SSL certificate default.
-
close()¶ Closes all adapters and as such the session
-
delete(url, **kwargs)¶ Sends a DELETE request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
get(url, **kwargs)¶ Sends a GET request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
get_adapter(url)¶ Returns the appropriate connnection adapter for the given URL.
-
head(url, **kwargs)¶ Sends a HEAD request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
headers= None¶ A case-insensitive dictionary of headers to be sent on each
Requestsent from thisSession.
-
hooks= None¶ Event-handling hooks.
-
max_redirects= None¶ Maximum number of redirects to follow.
-
mount(prefix, adapter)¶ Registers a connection adapter to a prefix.
-
options(url, **kwargs)¶ Sends a OPTIONS request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
params= None¶ Dictionary of querystring data to attach to each
Request. The dictionary values may be lists for representing multivalued query parameters.
-
proxies= None¶ Dictionary mapping protocol to the URL of the proxy (e.g. {‘http’: ‘foo.bar:3128’}) to be used on each
Request.
-
resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None)¶ Receives a Response. Returns a generator of Responses.
-
send(request, **kwargs)¶ Send a given PreparedRequest.
-
stream= None¶ Stream response content default.
-
trust_env= None¶ Should we trust the environment?
-
verify= None¶ SSL Verification default.
-
Exceptions¶
-
exception
requests.RequestException¶ There was an ambiguous exception that occurred while handling your request.
-
exception
requests.ConnectionError¶ A Connection error occurred.
-
exception
requests.HTTPError¶ An HTTP error occurred.
-
exception
requests.URLRequired¶ A valid URL is required to make a request.
-
exception
requests.TooManyRedirects¶ Too many redirects.
Status Code Lookup¶
-
requests.codes()¶ Dictionary lookup object.
>>> requests.codes['temporary_redirect']
307
>>> requests.codes.teapot
418
>>> requests.codes['\o/']
200
Cookies¶
Encodings¶
Classes¶
-
class
requests.Response The
Responseobject, which contains a server’s response to an HTTP request.-
apparent_encoding The apparent encoding, provided by the lovely Charade library (Thanks, Ian!).
-
content Content of the response, in bytes.
-
cookies= None A CookieJar of Cookies the server sent back.
-
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
Responseobjects 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.
-
iter_content(chunk_size=1, decode_unicode=False) Iterates over the response data. 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.
-
iter_lines(chunk_size=10240, decode_unicode=None) Iterates over the response data, one line at a time. This avoids reading the content at once into memory for large responses.
-
json() Returns the json-encoded content of a response, if any.
-
links Returns the parsed header links of the response, if any.
-
raise_for_status() Raises stored
HTTPErrororURLError, if one occurred.
-
raw= None File-like object representation of response (for advanced usage). Requires that ``stream=True` on the request.
-
status_code= None Integer Code of responded HTTP Status.
-
text Content of the response, in unicode.
if Response.encoding is None and chardet module is available, encoding will be guessed.
-
url= None Final URL location of Response.
-
-
class
requests.Request(method=None, url=None, headers=None, files=None, data={}, params={}, auth=None, cookies=None, hooks=None) A user-created
Requestobject.Used to prepare a
PreparedRequest, which is sent to the server.Parameters: - 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 the request. If a dictionary is provided, form-encoding will take place.
- 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
PreparedRequestfor transmission and returns it.
-
register_hook(event, hook) Properly register a hook.
-
class
requests.PreparedRequest¶ The fully mutable
PreparedRequestobject, containing the exact bytes that will be sent to the server.Generated from either a
Requestobject 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_auth(auth)¶ Prepares the given HTTP auth data.
-
prepare_body(data, files)¶ Prepares the given HTTP body data.
Prepares the given HTTP cookie data.
-
prepare_headers(headers)¶ Prepares the given HTTP headers.
-
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.Session A Requests session.
Provides cookie persistience, connection-pooling, and configuration.
Basic Usage:
>>> import requests >>> s = requests.Session() >>> s.get('http://httpbin.org/get') 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
-
delete(url, **kwargs) Sends a DELETE request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
get(url, **kwargs) Sends a GET request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
get_adapter(url) Returns the appropriate connnection adapter for the given URL.
-
head(url, **kwargs) Sends a HEAD request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
headers= None A case-insensitive dictionary of headers to be sent on each
Requestsent from thisSession.
-
hooks= None Event-handling hooks.
-
max_redirects= None Maximum number of redirects to follow.
-
mount(prefix, adapter) Registers a connection adapter to a prefix.
-
options(url, **kwargs) Sends a OPTIONS request. Returns
Responseobject.Parameters: - url – URL for the new
Requestobject. - **kwargs – Optional arguments that
requesttakes.
- url – URL for the new
-
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
Responseobject.Parameters:
-
post(url, data=None, **kwargs) Sends a POST request. Returns
Responseobject.Parameters:
-
proxies= None Dictionary mapping protocol to the URL of the proxy (e.g. {‘http’: ‘foo.bar:3128’}) to be used on each
Request.
-
put(url, data=None, **kwargs) Sends a PUT request. Returns
Responseobject.Parameters:
-
resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None) Receives a Response. Returns a generator of Responses.
-
send(request, **kwargs) Send a given PreparedRequest.
-
stream= None Stream response content default.
-
trust_env= None Should we trust the environment?
-
verify= None SSL Verification default.
-