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)[source]¶
Constructs and sends a
Request
.- Parameters:
method – method for the new
Request
object:GET
,OPTIONS
,HEAD
,POST
,PUT
,PATCH
, orDELETE
.url – URL for the new
Request
object.params – (optional) Dictionary, list of tuples or bytes to send 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) A JSON serializable Python 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': 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 andcustom_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 many seconds 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. 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 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
.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.
- Returns:
Response
object- Return type:
Usage:
>>> import requests >>> req = requests.request('GET', 'https://httpbin.org/get') >>> req <Response [200]>
- 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
.
- raw¶
File-like object representation of response (for advanced usage). Use of
raw
requires thatstream=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
orchardet
.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.
- requests.head(url, **kwargs)[source]¶
Sends a HEAD request.
- Parameters:
- Returns:
Response
object- Return type:
- requests.get(url, params=None, **kwargs)[source]¶
Sends a GET request.
- Parameters:
- Returns:
Response
object- Return type:
- requests.post(url, data=None, json=None, **kwargs)[source]¶
Sends a POST request.
- Parameters:
- Returns:
Response
object- Return type:
- requests.put(url, data=None, **kwargs)[source]¶
Sends a PUT request.
- Parameters:
- Returns:
Response
object- Return type:
- requests.patch(url, data=None, **kwargs)[source]¶
Sends a PATCH request.
- Parameters:
- Returns:
Response
object- Return type:
- requests.delete(url, **kwargs)[source]¶
Sends a DELETE request.
- requests.session()[source]¶
Returns a
Session
for context-management.Deprecated since version 1.0.0: This method has been deprecated since version 1.0.0 and is only kept for backwards compatibility. New code should use
Session
to create a session. This may be removed at a future date.- Return type:
- 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]>
- cert¶
SSL client certificate default, if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.
- cookies¶
A CookieJar containing all currently outstanding cookies set on this session. By default it is a
RequestsCookieJar
, but may be any othercookielib.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:
- 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:
- 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:
- headers¶
A case-insensitive dictionary of headers to be sent on each
Request
sent from thisSession
.
- 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:
- 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:
- Return type:
- post(url, data=None, json=None, **kwargs)[source]¶
Sends a POST request. Returns
Response
object.- Parameters:
- Return type:
- prepare_request(request)[source]¶
Constructs a
PreparedRequest
for transmission and returns it. ThePreparedRequest
has settings merged from theRequest
instance and those of theSession
.- 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:
- Return type:
- 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. ReturnsResponse
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 toFalse
, 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 toFalse
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:
- 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.
- 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.