Main Interface¶

All of Requests’ functionality can be accessed by these 7 methods.They all return an instance of theResponse object.

requests.request(method,url,**kwargs)[source]¶

Constructs and sends aRequest.

Parameters:

• method – method for the newRequest object:GET,OPTIONS,HEAD,POST,PUT,PATCH, orDELETE.

• url – URL for the newRequest object.

• params – (optional) Dictionary, list of tuples or bytes to sendin the query string for theRequest.

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

• json – (optional) A JSON serializable Python object to send in the body of theRequest.

• headers – (optional) Dictionary of HTTP Headers to send with theRequest.

• cookies – (optional) Dict or CookieJar object to send with theRequest.

• 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 stringdefining the content type of the given file andcustom_headers a dict-like object containing additional headersto add for the file.

• auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.

• timeout (float ortuple) – (optional) How many seconds to wait for the server to send databefore giving up, as a float, or a(connect timeout, readtimeout) tuple.

• allow_redirects (bool) – (optional) Boolean. Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults toTrue.

• proxies – (optional) Dictionary mapping protocol to the URL of the proxy.

• verify – (optional) Either a boolean, in which case it controls whether we verifythe server’s TLS certificate, or a string, in which case it must be a pathto a CA bundle to use. Defaults toTrue.

• stream – (optional) ifFalse, 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:

requests.Response

Usage:

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

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

Sends a HEAD request.

Parameters:

• url – URL for the newRequest object.

• **kwargs – Optional arguments thatrequest takes. Ifallow_redirects is not provided, it will be set toFalse (asopposed to the defaultrequest behavior).

Returns:

Response object

Return type:

requests.Response

requests.get(url,params=None,**kwargs)[source]¶

Sends a GET request.

Parameters:

• url – URL for the newRequest object.

• params – (optional) Dictionary, list of tuples or bytes to sendin the query string for theRequest.

• **kwargs – Optional arguments thatrequest takes.

Returns:

Response object

Return type:

requests.Response

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

Sends a POST request.

Parameters:

• url – URL for the newRequest object.

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

• json – (optional) A JSON serializable Python object to send in the body of theRequest.

• **kwargs – Optional arguments thatrequest takes.

Returns:

Response object

Return type:

requests.Response

requests.put(url,data=None,**kwargs)[source]¶

Sends a PUT request.

Parameters:

• url – URL for the newRequest object.

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

• json – (optional) A JSON serializable Python object to send in the body of theRequest.

• **kwargs – Optional arguments thatrequest takes.

Returns:

Response object

Return type:

requests.Response

requests.patch(url,data=None,**kwargs)[source]¶

Sends a PATCH request.

Parameters:

• url – URL for the newRequest object.

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

• json – (optional) A JSON serializable Python object to send in the body of theRequest.

• **kwargs – Optional arguments thatrequest takes.

Returns:

Response object

Return type:

requests.Response

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

Sends a DELETE request.

Parameters:

• url – URL for the newRequest object.

• **kwargs – Optional arguments thatrequest takes.

Returns:

Response object

Return type:

requests.Response

Exceptions¶

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

There was an ambiguous exception that occurred while handling yourrequest.

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

A Connection error occurred.

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

An HTTP error occurred.

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

Too many redirects.

exceptionrequests.ConnectTimeout(*args,**kwargs)[source]¶

The request timed out while trying to connect to the remote server.

Requests that produced this error are safe to retry.

exceptionrequests.ReadTimeout(*args,**kwargs)[source]¶

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

exceptionrequests.Timeout(*args,**kwargs)[source]¶

The request timed out.

Catching this error will catch bothConnectTimeout andReadTimeout errors.

exceptionrequests.JSONDecodeError(*args,**kwargs)[source]¶

Couldn’t decode the text into json

Request Sessions¶

classrequests.Session[source]¶

A Requests session.

Provides cookie persistence, connection-pooling, and configuration.

Basic Usage:

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

Or as a context manager:

>>>withrequests.Session()ass:...s.get('https://httpbin.org/get')<Response [200]>

auth¶

Default Authentication tuple or object to attach toRequest.

cert¶

SSL client certificate default, if String, path to ssl clientcert 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 thissession. By default it is aRequestsCookieJar, butmay be any othercookielib.CookieJar compatible object.

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

Sends a DELETE request. ReturnsResponse object.

Parameters:

• url – URL for the newRequest object.

• **kwargs – Optional arguments thatrequest takes.

Return type:

requests.Response

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

Sends a GET request. ReturnsResponse object.

Parameters:

• url – URL for the newRequest object.

• **kwargs – Optional arguments thatrequest 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 orNone

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

Sends a HEAD request. ReturnsResponse object.

Parameters:

• url – URL for the newRequest object.

• **kwargs – Optional arguments thatrequest takes.

Return type:

requests.Response

headers¶

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

hooks¶

Event-handling hooks.

max_redirects¶

Maximum number of redirects allowed. If the request exceeds thislimit, aTooManyRedirects exception is raised.This defaults to requests.models.DEFAULT_REDIRECT_LIMIT, which is30.

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. ReturnsResponse object.

Parameters:

• url – URL for the newRequest object.

• **kwargs – Optional arguments thatrequest takes.

Return type:

requests.Response

params¶

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

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

Sends a PATCH request. ReturnsResponse object.

Parameters:

• url – URL for the newRequest object.

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

• **kwargs – Optional arguments thatrequest takes.

Return type:

requests.Response

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

Sends a POST request. ReturnsResponse object.

Parameters:

• url – URL for the newRequest object.

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

• json – (optional) json to send in the body of theRequest.

• **kwargs – Optional arguments thatrequest takes.

Return type:

requests.Response

prepare_request(request)[source]¶

Constructs aPreparedRequest fortransmission and returns it. ThePreparedRequest has settingsmerged from theRequest instance and those of theSession.

Parameters:

request –Request instance to prepare with thissession’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’}) tobe used on eachRequest.

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

Sends a PUT request. ReturnsResponse object.

Parameters:

• url – URL for the newRequest object.

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

• **kwargs – Optional arguments thatrequest takes.

Return type:

requests.Response

rebuild_auth(prepared_request,response)¶

When being redirected we may want to strip authentication from therequest to avoid leaking credentials. This method intelligently removesand 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 requestbased on certain specs or browser behavior.

rebuild_proxies(prepared_request,proxies)¶

This method re-evaluates the proxy configuration by considering theenvironment variables. If we are redirected to a URL covered byNO_PROXY, we strip the proxy configuration. Otherwise, we set missingproxy keys for this URL (in case they were stripped by a previousredirect).

This method also replaces the Proxy-Authorization header wherenecessary.

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 aRequest, prepares it and sends it.ReturnsResponse object.

Parameters:

• method – method for the newRequest object.

• url – URL for the newRequest object.

• params – (optional) Dictionary or bytes to be sent in the querystring for theRequest.

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

• json – (optional) json to send in the body of theRequest.

• headers – (optional) Dictionary of HTTP Headers to send with theRequest.

• cookies – (optional) Dict or CookieJar object to send with theRequest.

• files – (optional) Dictionary of'filename':file-like-objectsfor multipart encoding upload.

• auth – (optional) Auth tuple or callable to enableBasic/Digest/Custom HTTP Auth.

• timeout (float ortuple) – (optional) How many seconds to wait for the server to senddata 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 andhostname to the URL of the proxy.

• hooks – (optional) Dictionary mapping hook name to one event orlist of events, event must be callable.

• stream – (optional) whether to immediately download the responsecontent. Defaults toFalse.

• verify – (optional) Either a boolean, in which case it controls whether we verifythe server’s TLS certificate, or a string, in which case it must be a pathto a CA bundle to use. Defaults toTrue. When set toFalse, requests will accept any TLS certificate presented bythe server, and will ignore hostname mismatches and/or expiredcertificates, which will make your application vulnerable toman-in-the-middle (MitM) attacks. Setting verify toFalsemay 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, defaultauthentication and similar.

verify¶

SSL Verification default.Defaults toTrue, requiring requests to verify the TLS certificate at theremote end.If verify is set toFalse, requests will accept any TLS certificatepresented by the server, and will ignore hostname mismatches and/orexpired certificates, which will make your application vulnerable toman-in-the-middle (MitM) attacks.Only set this toFalse for testing.

Lower-Level Classes¶

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

A user-createdRequest object.

Used to prepare aPreparedRequest, 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 orlist of tuples[(key,value)] is provided, form-encoding willtake 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 orlist of tuples[(key,value)] is provided, form-encoding willtake 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:

>>>importrequests>>>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 aPreparedRequest for transmission and returns it.

register_hook(event,hook)¶

Properly register a hook.

classrequests.Response[source]¶

TheResponse object, which contains aserver’s response to an HTTP request.

propertyapparent_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 beencalled the underlyingraw object must not be accessed again.

Note: Should not normally need to be called explicitly.

propertycontent¶

Content of the response, in bytes.

cookies¶

A CookieJar of Cookies the server sent back.

elapsed¶

The amount of time elapsed between sending the requestand the arrival of the response (as a timedelta).This property specifically measures the time taken between sendingthe first byte of the request and finishing parsing the headers. Itis therefore unaffected by consuming the response content or thevalue of thestream 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 thevalue of a'Content-Encoding' response header.

history¶

A list ofResponse objects fromthe history of the Request. Any redirect responses will endup here. The list is sorted from the oldest to the most recent request.

propertyis_permanent_redirect¶

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

propertyis_redirect¶

True if this Response is a well-formed HTTP redirect that could havebeen processed automatically (bySession.resolve_redirects).

iter_content(chunk_size=1,decode_unicode=False)[source]¶

Iterates over the response data. When stream=True is set on therequest, this avoids reading the content at once into memory forlarge responses. The chunk size is the number of bytes it shouldread into memory. This is not necessarily the length of each itemreturned as decoding can take place.

chunk_size must be of type int or None. A value of None willfunction differently depending on the value ofstream.stream=True will read data as it arrives in whatever size thechunks are received. If stream=False, data is returned asa single chunk.

If decode_unicode is True, content will be decoded using the bestavailable 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. Whenstream=True is set on the request, this avoids reading thecontent at once into memory for large responses.

Note

This method is not reentrant safe.

json(**kwargs)[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 thatjson.loads takes.

Raises:

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

propertylinks¶

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

propertynext¶

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

propertyok¶

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

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

raise_for_status()[source]¶

RaisesHTTPError, if one occurred.

raw¶

File-like object representation of response (for advanced usage).Use ofraw 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¶

ThePreparedRequest object to which thisis a response.

status_code¶

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

propertytext¶

Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed usingcharset_normalizer orchardet.

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

url¶

Final URL location of Response.

Lower-Lower-Level Classes¶

classrequests.PreparedRequest[source]¶

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

Instances are generated from aRequest object, andshould not be instantiated manually; doing so may produce undesirableeffects.

Usage:

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

propertypath_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 aCookie header from thegiven cookies using cookielib. Due to cookielib’s design, the headerwill not be regenerated if it already exists, meaning this functioncan only be called once for the life of thePreparedRequest object. Any subsequent callstoprepare_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.

classrequests.adapters.BaseAdapter[source]¶

The Base Transport Adapter

close()[source]¶

Cleans up adapter specific items.

send(request,stream=False,timeout=None,verify=True,cert=None,proxies=None)[source]¶

Sends PreparedRequest object. Returns Response object.

Parameters:

• request – ThePreparedRequest being sent.

• stream – (optional) Whether to stream the request content.

• timeout (float ortuple) – (optional) How long to wait for the server to senddata before giving up, as a float, or a(connect timeout,read timeout) tuple.

• verify – (optional) Either a boolean, in which case it controls whether we verifythe server’s TLS certificate, or a string, in which case it must be a pathto a CA bundle to use

• cert – (optional) Any user-provided SSL certificate to be trusted.

• proxies – (optional) The proxies dictionary to apply to the request.

classrequests.adapters.HTTPAdapter(pool_connections=10,pool_maxsize=10,max_retries=0,pool_block=False)[source]¶

The built-in HTTP Adapter for urllib3.

Provides a general-case interface for Requests sessions to contact HTTP andHTTPS urls by implementing the Transport Adapter interface. This class willusually be created by theSession class under thecovers.

Parameters:

• 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 connectionshould attempt. Note, this applies only to failed DNS lookups, socketconnections and connection timeouts, never to requests where data hasmade it to the server. By default, Requests does not retry failedconnections. If you need granular control over the conditions underwhich we retry a request, import urllib3’sRetry class and passthat instead.

• pool_block – Whether the connection pool should block for connections.

Usage:

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

add_headers(request,**kwargs)[source]¶

Add any headers needed by the connection. As of v2.0 this doesnothing by default, but is left for overriding by users that subclasstheHTTPAdapter.

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

Parameters:

• request – ThePreparedRequest to add headers to.

• kwargs – The keyword arguments from the call to send().

build_connection_pool_key_attributes(request,verify,cert=None)[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 valuesto use to select a connection from a given urllib3 Connection Pool.

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

• Ifverify isTrue,"ssl_context" will be set and will be thedefault Requests SSL Context

• Ifverify isFalse,"ssl_context" will not be set but"cert_reqs" will be set

• Ifverify is a string, (i.e., it is a user-specified trust bundle)"ca_certs" will be set if the string is not a directory recognizedbyos.path.isdir, otherwise"ca_cert_dir" will beset.

• If"cert" is specified,"cert_file" will always be set. If"cert" is a tuple with a second item,"key_file" will alsobe present

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

Parameters:

• request (PreparedRequest) – The PreparedReqest being sent over the connection.

• verify – Either a boolean, in which case it controls whetherwe verify the server’s TLS certificate, or a string, in which case itmust be a path to a CA bundle to use.

• cert – (optional) Any user-provided SSL certificate for clientauthentication (a.k.a., mTLS). This may be a string (i.e., justthe path to a file which holds both certificate and key) or atuple of length 2 with the certificate file path and key filepath.

Returns:

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

build_response(req,resp)[source]¶

Builds aResponse object from a urllib3response. This should not be called from user code, and is only exposedfor use when subclassing theHTTPAdapter

Parameters:

• req – ThePreparedRequest used to generate the response.

• resp – The urllib3 response object.

Return type:

requests.Response

cert_verify(conn,url,verify,cert)[source]¶

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

Parameters:

• conn – The urllib3 connection object associated with the cert.

• url – The requested URL.

• verify – Either a boolean, in which case it controls whether we verifythe server’s TLS certificate, or a string, in which case it must be a pathto a CA bundle to use

• cert – The SSL certificate to verify.

close()[source]¶

Disposes of any internal state.

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

get_connection(url,proxies=None)[source]¶

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

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

Parameters:

• url – The URL to connect to.

• proxies – (optional) A Requests-style dictionary of proxies used on this request.

Return type:

urllib3.ConnectionPool

get_connection_with_tls_context(request,verify,proxies=None,cert=None)[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 usewhen subclassing theHTTPAdapter.

Parameters:

• request – ThePreparedRequest object to be sentover the connection.

• verify – Either a boolean, in which case it controls whether we verify theserver’s TLS certificate, or a string, in which case it must be apath to a CA bundle to use.

• proxies – (optional) The proxies dictionary to apply to the request.

• cert – (optional) Any user-provided SSL certificate to be used for clientauthentication (a.k.a., mTLS).

Return type:

urllib3.ConnectionPool

init_poolmanager(connections,maxsize,block=False,**pool_kwargs)[source]¶

Initializes a urllib3 PoolManager.

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

Parameters:

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

Returns a dictionary of the headers to add to any request sentthrough a proxy. This works with urllib3 magic to ensure that they arecorrectly sent to the proxy, rather than in a tunnelled request ifCONNECT is being used.

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

Parameters:

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

Return type:

dict

proxy_manager_for(proxy,**proxy_kwargs)[source]¶

Return urllib3 ProxyManager for the given proxy.

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

Parameters:

• proxy – The proxy to return a urllib3 ProxyManager for.

• proxy_kwargs – Extra keyword arguments used to configure the Proxy Manager.

Returns:

ProxyManager

Return type:

urllib3.ProxyManager

request_url(request,proxies)[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 tobe 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 usewhen subclassing theHTTPAdapter.

Parameters:

• request – ThePreparedRequest being sent.

• proxies – A dictionary of schemes or schemes and hosts to proxy URLs.

Return type:

str

send(request,stream=False,timeout=None,verify=True,cert=None,proxies=None)[source]¶

Sends PreparedRequest object. Returns Response object.

Parameters:

• request – ThePreparedRequest being sent.

• stream – (optional) Whether to stream the request content.

• timeout (float ortuple orurllib3 Timeout object) – (optional) How long to wait for the server to senddata before giving up, as a float, or a(connect timeout,read timeout) tuple.

• verify – (optional) Either a boolean, in which case it controls whetherwe verify the server’s TLS certificate, or a string, in which case itmust be a path to a CA bundle to use

• cert – (optional) Any user-provided SSL certificate to be trusted.

• proxies – (optional) The proxies dictionary to apply to the request.

Return type:

requests.Response

Authentication¶

classrequests.auth.AuthBase[source]¶

Base class that all auth implementations derive from

classrequests.auth.HTTPBasicAuth(username,password)[source]¶

Attaches HTTP Basic Authentication to the given Request object.

classrequests.auth.HTTPProxyAuth(username,password)[source]¶

Attaches HTTP Proxy Authentication to a given Request object.

classrequests.auth.HTTPDigestAuth(username,password)[source]¶

Attaches HTTP Digest Authentication to the given Request object.

Encodings¶

requests.utils.get_encodings_from_content(content)[source]¶

Returns encodings from given content string.

Parameters:

content – bytestring to extract encodings from.

requests.utils.get_encoding_from_headers(headers)[source]¶

Returns encodings from given HTTP Header Dict.

Parameters:

headers – dictionary to extract encoding from.

Return type:

str

requests.utils.get_unicode_from_response(r)[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)[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,cookie_dict)[source]¶

Returns a CookieJar from a key/value dictionary.

Parameters:

• cj – CookieJar to insert cookies into.

• cookie_dict – Dict of key/values to insert into CookieJar.

Return type:

CookieJar

requests.cookies.cookiejar_from_dict(cookie_dict,cookiejar=None,overwrite=True)[source]¶

Returns a CookieJar from a key/value dictionary.

Parameters:

• 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 cookiesalready in the jar with new ones.

Return type:

CookieJar

classrequests.cookies.RequestsCookieJar(policy=None)[source]¶

Compatibility class; is a http.cookiejar.CookieJar, but exposes a dictinterface.

This is the CookieJar we create by default for requests and sessions thatdon’t specify one, since some clients may expect response.cookies andsession.cookies to support dict operations.

Requests does not use the dict interface internally; it’s just forcompatibility with external client code. All requests code should workout of the box with externally provided instances ofCookieJar, e.g.LWPCookieJar andFileCookieJar.

Unlike a regular CookieJar, this class is pickleable.

Warning

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

add_cookie_header(request)¶

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. Ifgiven a single argument, only cookies belonging to that domain will beremoved. If given two arguments, cookies belonging to the specifiedpath within that domain are removed. If given three arguments, thenthe 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 neversent 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 askotherwise 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, unlessyou ask otherwise by passing a true ignore_discard argument.

copy()[source]¶

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

Dict-like get() that also supports optional domain and path args inorder to resolve naming collisions from using one cookie jar overmultiple domains.

Warning

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

get_dict(domain=None,path=None)[source]¶

Takes as an argument an optional domain and path and returns a plainold Python dict of name-value pairs of cookies that meet therequirements.

Return type:

dict

get_policy()[source]¶

Return the CookiePolicy instance used.

items()[source]¶

Dict-like items() that returns a list of name-value tuples from thejar. Allows client-code to calldict(RequestsCookieJar) and get avanilla python dict of key value pairs.

See also

keys() and values().

iteritems()[source]¶

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

See also

iterkeys() and itervalues().

iterkeys()[source]¶

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

See also

itervalues() and iteritems().

itervalues()[source]¶

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

See also

iterkeys() and iteritems().

keys()[source]¶

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

See also

values() and items().

list_domains()[source]¶

Utility method to list all the domains in the jar.

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

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

Return type:

bool

pop(k[,d])→v,removespecifiedkeyandreturnthecorrespondingvalue.¶

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem()→(k,v),removeandreturnsome(key,value)pair¶

as a 2-tuple; but raise KeyError if D is empty.

set(name,value,**kwargs)[source]¶

Dict-like set() that also supports optional domain and path args inorder to resolve naming collisions from using one cookie jar overmultiple domains.

set_cookie(cookie,*args,**kwargs)[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),alsosetD[k]=difknotinD¶

update(other)[source]¶

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

values()[source]¶

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

See also

keys() and items().

classrequests.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 {}

Thecodes object defines a mapping from common names for HTTP statusesto their numerical codes, accessible either as attributes or as dictionaryitems.

Example:

>>>importrequests>>>requests.codes['temporary_redirect']307>>>requests.codes.teapot418>>>requests.codes['\o/']200

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

• 100:continue

• 101:switching_protocols

• 102:processing,early-hints

• 103:checkpoint

• 122:uri_too_long,request_uri_too_long

• 200:ok,okay,all_ok,all_okay,all_good,\o/,✓

• 201:created

• 202:accepted

• 203:non_authoritative_info,non_authoritative_information

• 204:no_content

• 205:reset_content,reset

• 206:partial_content,partial

• 207:multi_status,multiple_status,multi_stati,multiple_stati

• 208:already_reported

• 226:im_used

• 300:multiple_choices

• 301:moved_permanently,moved,\o-

• 302:found

• 303:see_other,other

• 304:not_modified

• 305:use_proxy

• 306:switch_proxy

• 307:temporary_redirect,temporary_moved,temporary

• 308:permanent_redirect,resume_incomplete,resume

• 400:bad_request,bad

• 401:unauthorized

• 402:payment_required,payment

• 403:forbidden

• 404:not_found,-o-

• 405:method_not_allowed,not_allowed

• 406:not_acceptable

• 407:proxy_authentication_required,proxy_auth,proxy_authentication

• 408:request_timeout,timeout

• 409:conflict

• 410:gone

• 411:length_required

• 412:precondition_failed,precondition

• 413:request_entity_too_large,content_too_large

• 414:request_uri_too_large,uri_too_long

• 415:unsupported_media_type,unsupported_media,media_type

• 416:requested_range_not_satisfiable,requested_range,range_not_satisfiable

• 417:expectation_failed

• 418:im_a_teapot,teapot,i_am_a_teapot

• 421:misdirected_request

• 422:unprocessable_entity,unprocessable,unprocessable_content

• 423:locked

• 424:failed_dependency,dependency

• 425:unordered_collection,unordered,too_early

• 426:upgrade_required,upgrade

• 428:precondition_required,precondition

• 429:too_many_requests,too_many

• 431:header_fields_too_large,fields_too_large

• 444:no_response,none

• 449:retry_with,retry

• 450:blocked_by_windows_parental_controls,parental_controls

• 451:unavailable_for_legal_reasons,legal_reasons

• 499:client_closed_request

• 500:internal_server_error,server_error,/o\,✗

• 501:not_implemented

• 502:bad_gateway

• 503:service_unavailable,unavailable

• 504:gateway_timeout

• 505:http_version_not_supported,http_version

• 506:variant_also_negotiates

• 507:insufficient_storage

• 509:bandwidth_limit_exceeded,bandwidth

• 510:not_extended

• 511:network_authentication_required,network_auth,network_authentication

Migrating to 1.x¶

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

Migrating to 2.x¶

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

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