Developer Interface¶

Lower-Level Classes¶

class requests.Request(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[source]¶

A user-created Request object.

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 to the request. If a dictionary or list of tuples [(key, value)] 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 – URL parameters to append to the URL. If a dictionary or list of tuples [(key, value)] is provided, form-encoding will take place.

• 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', 'https://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()[source]¶

Constructs a PreparedRequest for transmission and returns it.

register_hook(event, hook)¶

Properly register a hook.

class requests.Response[source]¶

The Response object, which contains a server’s response to an HTTP request.

property apparent_encoding¶

The apparent encoding, provided by the charset_normalizer or chardet libraries.

close()[source]¶

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

Note: Should not normally need to be called explicitly.

property content¶

Content of the response, in bytes.

cookies¶

A CookieJar of Cookies the server sent back.

elapsed¶

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¶

Encoding to decode with when accessing r.text.

headers¶

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

history¶

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.

property is_permanent_redirect¶

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

property 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)[source]¶

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 received. 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=False, delimiter=None)[source]¶

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.

Note

This method is not reentrant safe.

json(**kwargs)[source]¶

Returns the json-encoded content of a response, if any.

Parameters:

**kwargs – Optional arguments that json.loads takes.

Raises:

requests.exceptions.JSONDecodeError – If the response body does not contain valid json.

property links¶

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

property next¶

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

property ok¶

Returns True if status_code is less than 400, False if not.

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

raise_for_status()[source]¶

Raises HTTPError, if one occurred.

raw¶

File-like object representation of response (for advanced usage). Use of raw requires that stream=True be set on the request. This requirement does not apply for use internally to Requests.

reason¶

Textual reason of responded HTTP Status, e.g. “Not Found” or “OK”.

request¶

The PreparedRequest object to which this is a response.

status_code¶

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

property text¶

Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed using charset_normalizer or 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¶

Final URL location of Response.

Exceptions¶

exception requests.RequestException(*args, **kwargs)[source]¶

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

exception requests.ConnectionError(*args, **kwargs)[source]¶

A Connection error occurred.

exception requests.HTTPError(*args, **kwargs)[source]¶

An HTTP error occurred.

exception requests.URLRequired(*args, **kwargs)[source]¶

A valid URL is required to make a request.

exception requests.TooManyRedirects(*args, **kwargs)[source]¶

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[source]¶

The Response object, which contains a server’s response to an HTTP request.

property apparent_encoding¶

The apparent encoding, provided by the charset_normalizer or chardet libraries.

close()[source]¶

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

Note: Should not normally need to be called explicitly.

property content¶

Content of the response, in bytes.

cookies¶

A CookieJar of Cookies the server sent back.

elapsed¶

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¶

Encoding to decode with when accessing r.text.

headers¶

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

history¶

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.

property is_permanent_redirect¶

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

property 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)[source]¶

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 received. 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=False, delimiter=None)[source]¶

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.

Note

This method is not reentrant safe.

json(**kwargs)[source]¶

Returns the json-encoded content of a response, if any.

Parameters:

**kwargs – Optional arguments that json.loads takes.

Raises:

requests.exceptions.JSONDecodeError – If the response body does not contain valid json.

property links¶

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

property next¶

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

property ok¶

Returns True if status_code is less than 400, False if not.

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

raise_for_status()[source]¶

Raises HTTPError, if one occurred.

raw¶

File-like object representation of response (for advanced usage). Use of raw requires that stream=True be set on the request. This requirement does not apply for use internally to Requests.

reason¶

Textual reason of responded HTTP Status, e.g. “Not Found” or “OK”.

request¶

The PreparedRequest object to which this is a response.

status_code¶

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

property text¶

Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed using charset_normalizer or 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¶

Final URL location of Response.

class requests.Request(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[source]¶

A user-created Request object.

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 to the request. If a dictionary or list of tuples [(key, value)] 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 – URL parameters to append to the URL. If a dictionary or list of tuples [(key, value)] is provided, form-encoding will take place.

• 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', 'https://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()[source]¶

Constructs a PreparedRequest for transmission and returns it.

register_hook(event, hook)¶

Properly register a hook.

class requests.PreparedRequest[source]¶

The fully mutable PreparedRequest object, containing the exact bytes that will be sent to the server.

Instances are generated from a Request object, and should not be instantiated manually; doing so may produce undesirable effects.

Usage:

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

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

body¶

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¶

dictionary of HTTP headers.

hooks¶

dictionary of callback hooks, for internal usage.

method¶

HTTP verb to send to the server.

property 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)[source]¶

Prepares the entire request with the given parameters.

prepare_auth(auth, url='')[source]¶

Prepares the given HTTP auth data.

prepare_body(data, files, json=None)[source]¶

Prepares the given HTTP body data.

prepare_content_length(body)[source]¶

Prepare Content-Length header based on request method and body

prepare_cookies(cookies)[source]¶

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)[source]¶

Prepares the given HTTP headers.

prepare_hooks(hooks)[source]¶

Prepares the given hooks.

prepare_method(method)[source]¶

Prepares the given HTTP method.

prepare_url(url, params)[source]¶

Prepares the given HTTP URL.

register_hook(event, hook)¶

Properly register a hook.

url¶

HTTP URL to send the request to.

class requests.Session[source]¶

A Requests session.

Provides cookie persistence, connection-pooling, and configuration.

Basic Usage:

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

Or as a context manager:

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

auth¶

Default Authentication tuple or object to attach to Request.

cert¶

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

close()[source]¶

Closes all adapters and as such the session

cookies¶

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

delete(url, **kwargs)[source]¶

Sends a DELETE request. Returns Response object.

Parameters:

• url – URL for the new Request object.

• **kwargs – Optional arguments that request takes.

Return type:

requests.Response

get(url, **kwargs)[source]¶

Sends a GET request. Returns Response object.

Parameters:

• url – URL for the new Request object.

• **kwargs – Optional arguments that request takes.

Return type:

requests.Response

get_adapter(url)[source]¶

Returns the appropriate connection adapter for the given URL.

Return type:

requests.adapters.BaseAdapter

get_redirect_target(resp)¶

Receives a Response. Returns a redirect URI or None

head(url, **kwargs)[source]¶

Sends a HEAD request. Returns Response object.

Parameters:

• url – URL for the new Request object.

• **kwargs – Optional arguments that request takes.

Return type:

requests.Response

headers¶

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

hooks¶

Event-handling hooks.

max_redirects¶

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

merge_environment_settings(url, proxies, stream, verify, cert)[source]¶

Check the environment and merge it with some settings.

Return type:

dict

mount(prefix, adapter)[source]¶

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by prefix length.

options(url, **kwargs)[source]¶

Sends a OPTIONS request. Returns Response object.

Parameters:

• url – URL for the new Request object.

• **kwargs – Optional arguments that request takes.

Return type:

requests.Response

params¶

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)[source]¶

Sends a PATCH request. Returns Response object.

Parameters:

• url – URL for the new Request object.

• data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.

• **kwargs – Optional arguments that request takes.

Return type:

requests.Response

post(url, data=None, json=None, **kwargs)[source]¶

Sends a POST request. Returns Response object.

Parameters:

• url – URL for the new Request object.

• data – (optional) Dictionary, list of tuples, 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.

Return type:

requests.Response

prepare_request(request)[source]¶

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

Parameters:

request – Request instance to prepare with this session’s settings.

Return type:

requests.PreparedRequest

proxies¶

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)[source]¶

Sends a PUT request. Returns Response object.

Parameters:

• url – URL for the new Request object.

• data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.

• **kwargs – Optional arguments that request takes.

Return type:

requests.Response

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.

Return type:

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)[source]¶

Constructs a Request, prepares it and sends it. Returns Response object.

Parameters:

• 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, list of tuples, 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) Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to True. When set to False, requests will accept any TLS certificate presented by the server, and will ignore hostname mismatches and/or expired certificates, which will make your application vulnerable to man-in-the-middle (MitM) attacks. Setting verify to False may be useful during local development or testing.

• cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

Return type:

requests.Response

resolve_redirects(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)[source]¶

Send a given PreparedRequest.

Return type:

requests.Response

should_strip_auth(old_url, new_url)¶

Decide whether Authorization header should be removed when redirecting

stream¶

Stream response content default.

trust_env¶

Trust environment settings for proxy configuration, default authentication and similar.

verify¶

SSL Verification default. Defaults to True, requiring requests to verify the TLS certificate at the remote end. If verify is set to False, requests will accept any TLS certificate presented by the server, and will ignore hostname mismatches and/or expired certificates, which will make your application vulnerable to man-in-the-middle (MitM) attacks. Only set this to False for testing.