Developer Interface — Requests 2.34.2 documentation (original) (raw)

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 Requests’ functionality can be accessed by these 7 methods. They all return an instance of the Response object.

requests.request(method: str, url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response[source]

Constructs and sends a Request.

Parameters:

Returns:

Response object

Return type:

requests.Response

Usage:

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

requests.head(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response[source]

Sends a HEAD request.

Parameters:

Returns:

Response object

Return type:

requests.Response

requests.get(url: _t.UriType, params: _t.ParamsType = None, **kwargs: Unpack[_t.GetKwargs]) → Response[source]

Sends a GET request.

Parameters:

Returns:

Response object

Return type:

requests.Response

requests.post(url: _t.UriType, data: _t.DataType = None, json: _t.JsonType = None, **kwargs: Unpack[_t.PostKwargs]) → Response[source]

Sends a POST request.

Parameters:

Returns:

Response object

Return type:

requests.Response

requests.put(url: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response[source]

Sends a PUT request.

Parameters:

Returns:

Response object

Return type:

requests.Response

requests.patch(url: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response[source]

Sends a PATCH request.

Parameters:

Returns:

Response object

Return type:

requests.Response

requests.delete(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response[source]

Sends a DELETE request.

Parameters:

Returns:

Response object

Return type:

requests.Response

Exceptions

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

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

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

A Connection error occurred.

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

An HTTP error occurred.

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

Too many redirects.

exception requests.ConnectTimeout(*args: Any, **kwargs: Any)[source]

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: Any, **kwargs: Any)[source]

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

exception requests.Timeout(*args: Any, **kwargs: Any)[source]

The request timed out.

Catching this error will catch bothConnectTimeout andReadTimeout errors.

exception requests.JSONDecodeError(*args: Any, **kwargs: Any)[source]

Couldn’t decode the text into json

Request Sessions

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_: _t.AuthType_

Default Authentication tuple or object to attach toRequest.

cert_: _t.CertType_

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

close() → None[source]

Closes all adapters and as such the session

cookies_: RequestsCookieJar_

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: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response[source]

Sends a DELETE request. Returns Response object.

Parameters:

Return type:

requests.Response

get(url: _t.UriType, params: _t.ParamsType = None, **kwargs: Unpack[_t.GetKwargs]) → Response[source]

Sends a GET request. Returns Response object.

Parameters:

Return type:

requests.Response

get_adapter(url: str) → BaseAdapter[source]

Returns the appropriate connection adapter for the given URL.

Return type:

requests.adapters.BaseAdapter

get_redirect_target(resp: Response) → str | None

Receives a Response. Returns a redirect URI or None

head(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response[source]

Sends a HEAD request. Returns Response object.

Parameters:

Return type:

requests.Response

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

hooks_: dict[str, list[_t.HookType]]_

Event-handling hooks.

max_redirects_: int_

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: str, proxies: dict[str, str] | None, stream: bool | None, verify: _t.VerifyType | None, cert: _t.CertType) → dict[str, Any][source]

Check the environment and merge it with some settings.

Return type:

dict

mount(prefix: str, adapter: BaseAdapter) → None[source]

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by prefix length.

options(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response[source]

Sends a OPTIONS request. Returns Response object.

Parameters:

Return type:

requests.Response

params_: MutableMapping[str, Any]_

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

patch(url: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response[source]

Sends a PATCH request. Returns Response object.

Parameters:

Return type:

requests.Response

post(url: _t.UriType, data: _t.DataType = None, json: _t.JsonType = None, **kwargs: Unpack[_t.PostKwargs]) → Response[source]

Sends a POST request. Returns Response object.

Parameters:

Return type:

requests.Response

prepare_request(request: Request) → PreparedRequest[source]

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

Parameters:

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

Return type:

requests.PreparedRequest

proxies_: dict[str, str]_

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: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response[source]

Sends a PUT request. Returns Response object.

Parameters:

Return type:

requests.Response

rebuild_auth(prepared_request: PreparedRequest, response: Response) → None

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: PreparedRequest, response: Response) → None

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

rebuild_proxies(prepared_request: PreparedRequest, proxies: dict[str, str] | None) → dict[str, str]

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: str, url: _t.UriType, params: _t.ParamsType = None, data: _t.DataType = None, headers: _t.HeadersType = None, cookies: RequestsCookieJar | CookieJar | dict[str, str] | None = None, files: _t.FilesType = None, auth: _t.AuthType = None, timeout: _t.TimeoutType = None, allow_redirects: bool = True, proxies: dict[str, str] | None = None, hooks: _t.HooksInputType | None = None, stream: bool | None = None, verify: _t.VerifyType | None = None, cert: _t.CertType = None, json: _t.JsonType = None) → Response[source]

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

Parameters:

Return type:

requests.Response

resolve_redirects(resp: Response, req: PreparedRequest, stream: bool = False, timeout: _t.TimeoutType = None, verify: _t.VerifyType = True, cert: _t.CertType = None, proxies: dict[str, str] | None = None, yield_requests: bool = False, **adapter_kwargs: Any) → Generator[Response, None, None]

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

send(request: PreparedRequest, **kwargs: Any) → Response[source]

Send a given PreparedRequest.

Return type:

requests.Response

should_strip_auth(old_url: str, new_url: str) → bool

Decide whether Authorization header should be removed when redirecting

stream_: bool_

Stream response content default.

trust_env_: bool_

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

verify_: _t.VerifyType_

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. If verify is set to a string, it must be the path to a CA bundle file that will be used to verify the TLS certificate.

Lower-Level Classes

class requests.Request(method: str | None = None, url: _t.UriType | None = None, headers: _t.HeadersType = None, files: _t.FilesType = None, data: _t.DataType = None, params: _t.ParamsType = None, auth: _t.AuthType = None, cookies: RequestsCookieJar | CookieJar | dict[str, str] | None = None, hooks: _t.HooksInputType | None = None, json: _t.JsonType = None)[source]

A user-created Request object.

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

Parameters:

Usage:

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

deregister_hook(event: str, hook: Callable[[Response], Any]) → bool

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

prepare() → PreparedRequest[source]

Constructs a PreparedRequest for transmission and returns it.

register_hook(event: str, hook: Iterable[Callable[[Response], Any]] | Callable[[Response], Any]) → None

Properly register a hook.

class requests.Response[source]

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

property apparent_encoding_: str | None_

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

close() → None[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_: bytes_

Content of the response, in bytes.

cookies_: RequestsCookieJar_

A CookieJar of Cookies the server sent back.

elapsed_: datetime.timedelta_

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_: str | None_

Encoding to decode with when accessing r.text.

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

history_: list[Response]_

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_redirect_: bool_

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

iter_content(chunk_size: int | None = 1, decode_unicode: Literal[False] = False) → Iterator[bytes][source]

iter_content(chunk_size: int | None = 1, *, decode_unicode: Literal[True]) → Iterator[str | bytes]

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 encoding information from the response. If no encoding information is available, bytes will be returned. This can be bypassed by manually settingencoding on the response.

iter_lines(chunk_size: int = ITER_CHUNK_SIZE, decode_unicode: Literal[False] = False, delimiter: bytes | None = None) → Iterator[bytes][source]

iter_lines(chunk_size: int = ITER_CHUNK_SIZE, *, decode_unicode: Literal[True], delimiter: str | bytes | None = None) → Iterator[str | bytes]

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.

The decode_unicode param works the same as in iter_content, with the same caveats.

Note

This method is not reentrant safe.

json(**kwargs: Any) → Any[source]

Decodes the JSON response body (if any) as a Python object.

This may return a dictionary, list, etc. depending on what is in the response.

Parameters:

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

Raises:

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

property links_: dict[str, dict[str, str]]_

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

property next_: PreparedRequest | None_

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

property ok_: bool_

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() → None[source]

Raises HTTPError, if one occurred.

raw_: Any_

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_: str_

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

request_: PreparedRequest_

The PreparedRequest object to which this is a response.

status_code_: int_

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

property text_: str_

Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed usingcharset_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_: str_

Final URL location of Response.

Lower-Lower-Level Classes

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_: _t.BodyType_

request body to send to the server.

deregister_hook(event: str, hook: Callable[[Response], Any]) → bool

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

dictionary of HTTP headers.

hooks_: dict[str, list[_t.HookType]]_

dictionary of callback hooks, for internal usage.

method_: str | None_

HTTP verb to send to the server.

property path_url_: str_

Build the path URL to use.

prepare(method: str | None = None, url: _t.UriType | None = None, headers: Mapping[str, str | bytes] | None = None, files: _t.FilesType = None, data: _t.DataType = None, params: _t.ParamsType = None, auth: _t.AuthType = None, cookies: RequestsCookieJar | CookieJar | dict[str, str] | None = None, hooks: _t.HooksInputType | None = None, json: _t.JsonType = None) → None[source]

Prepares the entire request with the given parameters.

prepare_auth(auth: _t.AuthType, url: _t.UriType = '') → None[source]

Prepares the given HTTP auth data.

prepare_body(data: _t.DataType, files: _t.FilesType, json: _t.JsonType = None) → None[source]

Prepares the given HTTP body data.

prepare_content_length(body: _t.BodyType) → None[source]

Prepare Content-Length header based on request method and body

prepare_cookies(cookies: RequestsCookieJar | CookieJar | dict[str, str] | None) → None[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 thePreparedRequest object. Any subsequent calls to prepare_cookies will have no actual effect, unless the “Cookie” header is removed beforehand.

Prepares the given HTTP headers.

prepare_hooks(hooks: Mapping[str, Iterable[Callable[[Response], Any]] | Callable[[Response], Any]] | None) → None[source]

Prepares the given hooks.

prepare_method(method: str | None) → None[source]

Prepares the given HTTP method.

prepare_url(url: _t.UriType, params: _t.ParamsType) → None[source]

Prepares the given HTTP URL.

register_hook(event: str, hook: Iterable[Callable[[Response], Any]] | Callable[[Response], Any]) → None

Properly register a hook.

url_: str | None_

HTTP URL to send the request to.

class requests.adapters.BaseAdapter[source]

The Base Transport Adapter

close() → None[source]

Cleans up adapter specific items.

send(request: PreparedRequest, stream: bool = False, timeout: _t.TimeoutType = None, verify: _t.VerifyType = True, cert: _t.CertType = None, proxies: dict[str, str] | None = None) → Response[source]

Sends PreparedRequest object. Returns Response object.

Parameters:

class requests.adapters.HTTPAdapter(pool_connections: int = 10, pool_maxsize: int = 10, max_retries: int | Retry = 0, pool_block: bool = False)[source]

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.

Parameters:

Usage:

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

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.

Parameters:

build_connection_pool_key_attributes(request: PreparedRequest, verify: _t.VerifyType, cert: _t.CertType = None) → tuple[dict[str, Any], dict[str, Any]][source]

Build the PoolKey attributes used by urllib3 to return a connection.

This looks at the PreparedRequest, the user-specified verify value, and the value of the cert parameter to determine what PoolKey values to use to select a connection from a given urllib3 Connection Pool.

The SSL related pool key arguments are not consistently set. As of this writing, use the following to determine what keys may be in that dictionary:

To override these settings, one may subclass this class, call this method and use the above logic to change parameters as desired. For example, if one wishes to use a custom ssl.SSLContext one must both set "ssl_context" and based on what else they require, alter the other keys to ensure the desired behaviour.

Parameters:

Returns:

A tuple of two dictionaries. The first is the “host parameters” portion of the Pool Key including scheme, hostname, and port. The second is a dictionary of SSLContext related parameters.

build_response(req: PreparedRequest, resp: Any) → Response[source]

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

Parameters:

Return type:

requests.Response

cert_verify(conn: Any, url: str, verify: _t.VerifyType, cert: _t.CertType) → None[source]

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

Parameters:

close() → None[source]

Disposes of any internal state.

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

get_connection(url: str, proxies: dict[str, str] | None = None) → HTTPConnectionPool[source]

DEPRECATED: Users should move to get_connection_with_tls_contextfor all subclasses of HTTPAdapter using Requests>=2.32.2.

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

Parameters:

Return type:

urllib3.HTTPConnectionPool

get_connection_with_tls_context(request: PreparedRequest, verify: _t.VerifyType, proxies: dict[str, str] | None = None, cert: _t.CertType = None) → HTTPConnectionPool[source]

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

Parameters:

Return type:

urllib3.HTTPConnectionPool

init_poolmanager(connections: int, maxsize: int, block: bool = False, **pool_kwargs: Any) → None[source]

Initializes a urllib3 PoolManager.

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

Parameters:

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.

Parameters:

proxy – The url of the proxy being used for this request.

Return type:

dict

proxy_manager_for(proxy: str, **proxy_kwargs: Any) → Any[source]

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.

Parameters:

Returns:

ProxyManager

Return type:

urllib3.ProxyManager

request_url(request: PreparedRequest, proxies: dict[str, str] | None) → str[source]

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.

Parameters:

Return type:

str

send(request: PreparedRequest, stream: bool = False, timeout: _t.TimeoutType = None, verify: _t.VerifyType = True, cert: _t.CertType = None, proxies: dict[str, str] | None = None) → Response[source]

Sends PreparedRequest object. Returns Response object.

Parameters:

Return type:

requests.Response

Authentication

class requests.auth.AuthBase[source]

Base class that all auth implementations derive from

class requests.auth.HTTPBasicAuth(username: str, password: str)[source]

class requests.auth.HTTPBasicAuth(username: bytes, password: bytes)

Attaches HTTP Basic Authentication to the given Request object.

class requests.auth.HTTPProxyAuth(username: str, password: str)[source]

class requests.auth.HTTPProxyAuth(username: bytes, password: bytes)

Attaches HTTP Proxy Authentication to a given Request object.

class requests.auth.HTTPDigestAuth(username: str, password: str)[source]

class requests.auth.HTTPDigestAuth(username: bytes, password: bytes)

Attaches HTTP Digest Authentication to the given Request object.

Encodings

requests.utils.get_encodings_from_content(content: str) → list[str][source]

Returns encodings from given content string.

Parameters:

content – bytestring to extract encodings from.

Returns encodings from given HTTP Header Dict.

Parameters:

headers – dictionary to extract encoding from.

Return type:

str

requests.utils.get_unicode_from_response(r: Response) → str | bytes | None[source]

Returns the requested content back in unicode.

Parameters:

r – Response object to get unicode content from.

Tried:

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

Return type:

str

Cookies

requests.utils.dict_from_cookiejar(cj: CookieJar) → dict[str, str | None][source]

Returns a key/value dictionary from a CookieJar.

Parameters:

cj – CookieJar object to extract cookies from.

Return type:

dict

requests.utils.add_dict_to_cookiejar(cj: CookieJar, cookie_dict: dict[str, str]) → CookieJar[source]

Returns a CookieJar from a key/value dictionary.

Parameters:

Return type:

CookieJar

requests.cookies.cookiejar_from_dict(cookie_dict: dict[str, str] | None, cookiejar: None = None, overwrite: bool = True) → RequestsCookieJar[source]

requests.cookies.cookiejar_from_dict(cookie_dict: dict[str, str] | None, cookiejar: _CookieJarT, overwrite: bool = True) → _CookieJarT

Returns a CookieJar from a key/value dictionary.

Parameters:

Return type:

CookieJar

class requests.cookies.RequestsCookieJar(policy=None)[source]

Compatibility class; is a http.cookiejar.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.

Warning

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

Add correct Cookie: header to request (urllib.request.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() → RequestsCookieJar[source]

Return a copy of this RequestsCookieJar.

Extract cookies from response, where allowable given the request.

get(name: str, default: str | None = None, domain: str | None = None, path: str | None = None) → str | None[source]

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.

Warning

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

get_dict(domain: str | None = None, path: str | None = None) → dict[str, str | None][source]

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.

Return type:

dict

get_policy() → CookiePolicy[source]

Return the CookiePolicy instance used.

items() → list[tuple[str, str | None]][source]

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

See also

keys() and values().

iteritems() → Iterator[tuple[str, str | None]][source]

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

See also

iterkeys() and itervalues().

iterkeys() → Iterator[str][source]

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

See also

itervalues() and iteritems().

itervalues() → Iterator[str | None][source]

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

See also

iterkeys() and iteritems().

keys() → list[str][source]

Dict-like keys() that returns a list of names of cookies from the jar.

See also

values() and items().

list_domains() → list[str][source]

Utility method to list all the domains in the jar.

list_paths() → list[str][source]

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() → bool[source]

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

Return type:

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: str, value: str | Morsel[dict[str, str]] | None, **kwargs: Any) → Cookie | None[source]

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(cookie: Cookie, *args: Any, **kwargs: Any) → None[source]

Set a cookie, without checking whether or not it should be set.

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: CookieJar | SupportsKeysAndGetItem[str, str]) → None[source]

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

values() → list[str | None][source]

Dict-like values() that returns a list of values of cookies from the jar.

See also

keys() and items().

class requests.cookies.CookieConflictError[source]

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.

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

Status Code Lookup

requests.codes

alias of {}

The codes object defines a mapping from common names for HTTP statuses to their numerical codes, accessible either as attributes or as dictionary items.

Example:

import requests requests.codes['temporary_redirect'] 307 requests.codes.teapot 418 requests.codes['\o/'] 200

Some codes have multiple names, and both upper- and lower-case versions of the names are allowed. For example, codes.ok, codes.OK, andcodes.okay all correspond to the HTTP status code 200.

Migrating to 1.x

This section details the main differences between 0.x and 1.x and is meant to ease the pain of upgrading.

API Changes

in 0.x, passing prefetch=False would accomplish the same thing

r = requests.get('https://api.github.com/events', stream=True)
for chunk in r.iter_content(8192):
...

Enabling debugging at http.client level (requests->urllib3->http.client)

you will see the REQUEST, including HEADERS and DATA, and RESPONSE with HEADERS but without DATA.

the only thing missing will be the response.body which is not logged.

try: # for Python 3
from http.client import HTTPConnection
except ImportError:
from httplib import HTTPConnection
HTTPConnection.debuglevel = 1
logging.basicConfig() # you need to initialize logging, otherwise you will not see anything from requests
logging.getLogger().setLevel(logging.DEBUG)
requests_log = logging.getLogger("urllib3")
requests_log.setLevel(logging.DEBUG)
requests_log.propagate = True
requests.get('https://httpbin.org/headers')

Licensing

One key difference that has nothing to do with the API is a change in the license from the ISC license to the Apache 2.0 license. The Apache 2.0 license ensures that contributions to Requests are also covered by the Apache 2.0 license.

Migrating to 2.x

Compared with the 1.0 release, there were relatively few backwards incompatible changes, but there are still a few issues to be aware of with this major release.

For more details on the changes in this release including new APIs, links to the relevant GitHub issues and some of the bug fixes, read Cory’s blogon the subject.

API Changes

In requests 1.x, this was legal, in requests 2.x,

this raises requests.exceptions.MissingSchema

requests.get("http://example.org", proxies=proxies)

Behavioural Changes