Developer Interface¶
This part of the documentation covers all the interfaces of Niquests. For parts where Niquests depends on external libraries, we document the most important right here and provide links to the canonical documentation.
Main Interface¶
All of Niquests’ functionality can be accessed by these 7 methods.
They all return an instance of the Response
object.
- requests.request(method: str, url: str, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, json: Any | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, retries: bool | int | Retry = 0) Response [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 – (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 – (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
. It is also possible to put the certificates (directly) in a string or bytes.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, or (‘cert’, ‘key’, ‘key_password’).
hooks – (optional) Register functions that should be called at very specific moment in the request lifecycle.
retries – (optional) If integer, determine the number of retry in case of a timeout or connection error. Otherwise, for fine gained retry, use directly a
Retry
instance from urllib3.
- Returns:
Response
object
Usage:
>>> import niquests >>> req = niquests.request('GET', 'https://httpbin.org/get') >>> req <Response HTTP/2 [200]>
- requests.head(url: str, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 30, allow_redirects: bool = False, proxies: Dict[str, str] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, retries: bool | int | Retry = 0) Response [source]¶
Sends a HEAD request.
- Parameters:
url – URL for the new
Request
object.params – (optional) Dictionary, list of tuples or bytes to send in the query string for the
Request
.headers – (optional) Dictionary of HTTP Headers to send with the
Request
.cookies – (optional) Dict or CookieJar object to send with the
Request
.auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout – (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 – (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
. It is also possible to put the certificates (directly) in a string or bytes.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, or (‘cert’, ‘key’, ‘key_password’).
hooks – (optional) Register functions that should be called at very specific moment in the request lifecycle.
retries – (optional) If integer, determine the number of retry in case of a timeout or connection error. Otherwise, for fine gained retry, use directly a
Retry
instance from urllib3.
- Returns:
Response
object
- requests.get(url: str, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, *, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 30, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, retries: bool | int | Retry = 0) Response [source]¶
Sends a GET request.
- Parameters:
url – URL for the new
Request
object.params – (optional) Dictionary, list of tuples or bytes to send in the query string for the
Request
.params – (optional) Dictionary, list of tuples or bytes to send in the query string for the
Request
.headers – (optional) Dictionary of HTTP Headers to send with the
Request
.cookies – (optional) Dict or CookieJar object to send with the
Request
.auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout – (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 – (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
. It is also possible to put the certificates (directly) in a string or bytes.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, or (‘cert’, ‘key’, ‘key_password’).
hooks – (optional) Register functions that should be called at very specific moment in the request lifecycle.
retries – (optional) If integer, determine the number of retry in case of a timeout or connection error. Otherwise, for fine gained retry, use directly a
Retry
instance from urllib3.
- Returns:
Response
object
- requests.post(url: str, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, json: Any | None = None, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, retries: bool | int | Retry = 0) Response [source]¶
Sends a POST request.
- Parameters:
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 – (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 – (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
. It is also possible to put the certificates (directly) in a string or bytes.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, or (‘cert’, ‘key’, ‘key_password’).
hooks – (optional) Register functions that should be called at very specific moment in the request lifecycle.
retries – (optional) If integer, determine the number of retry in case of a timeout or connection error. Otherwise, for fine gained retry, use directly a
Retry
instance from urllib3.
- Returns:
Response
object
- requests.put(url: str, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, *, json: Any | None = None, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, retries: bool | int | Retry = 0) Response [source]¶
Sends a PUT request.
- Parameters:
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 – (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 – (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
. It is also possible to put the certificates (directly) in a string or bytes.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, or (‘cert’, ‘key’, ‘key_password’).
hooks – (optional) Register functions that should be called at very specific moment in the request lifecycle.
retries – (optional) If integer, determine the number of retry in case of a timeout or connection error. Otherwise, for fine gained retry, use directly a
Retry
instance from urllib3.
- Returns:
Response
object
- requests.patch(url: str, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, *, json: Any | None = None, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, retries: bool | int | Retry = 0) Response [source]¶
Sends a PATCH request.
- Parameters:
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 – (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 – (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
. It is also possible to put the certificates (directly) in a string or bytes.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, or (‘cert’, ‘key’, ‘key_password’).
hooks – (optional) Register functions that should be called at very specific moment in the request lifecycle.
retries – (optional) If integer, determine the number of retry in case of a timeout or connection error. Otherwise, for fine gained retry, use directly a
Retry
instance from urllib3.
- Returns:
Response
object
- requests.delete(url: str, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, retries: bool | int | Retry = 0) Response [source]¶
Sends a DELETE request.
- Parameters:
url – URL for the new
Request
object.params – (optional) Dictionary, list of tuples or bytes to send in the query string for the
Request
.headers – (optional) Dictionary of HTTP Headers to send with the
Request
.cookies – (optional) Dict or CookieJar object to send with the
Request
.auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout – (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 – (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
. It is also possible to put the certificates (directly) in a string or bytes.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, or (‘cert’, ‘key’, ‘key_password’).
hooks – (optional) Register functions that should be called at very specific moment in the request lifecycle.
retries – (optional) If integer, determine the number of retry in case of a timeout or connection error. Otherwise, for fine gained retry, use directly a
Retry
instance from urllib3.
- Returns:
Response
object
Exceptions¶
- exception niquests.RequestException(*args, **kwargs)[source]¶
There was an ambiguous exception that occurred while handling your request.
- exception niquests.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.
- exception niquests.ReadTimeout(*args, **kwargs)[source]¶
The server did not send any data in the allotted amount of time.
Request Sessions¶
- class requests.Session(*, resolver: str | ResolverDescription | BaseResolver | List[str] | List[ResolverDescription] | None = None, source_address: tuple[str, int] | None = None, quic_cache_layer: MutableMapping[Tuple[str, int], Tuple[str, int] | None] | None = None, retries: bool | int | Retry = 0, multiplexed: bool = False, disable_http2: bool = False, disable_http3: bool = False, disable_ipv6: bool = False, disable_ipv4: bool = False, pool_connections: int = 10, pool_maxsize: int = 10, happy_eyeballs: bool | int = False)[source]¶
A Requests session.
Provides cookie persistence, connection-pooling, and configuration.
Basic Usage:
>>> import niquests >>> s = niquests.Session() >>> s.get('https://httpbin.org/get') <Response HTTP/2 [200]>
Or as a context manager:
>>> with niquests.Session() as s: ... s.get('https://httpbin.org/get') <Response HTTP/2 [200]>
- auth¶
Default Authentication tuple or object to attach to
Request
.
- cert: str | Tuple[str, str] | Tuple[str, str, str] | None¶
SSL client certificate default, if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- cookies: RequestsCookieJar | CookieJar¶
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: str, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None) Response [source]¶
Sends a DELETE request. Returns
Response
object.- Parameters:
url – URL for the new
Request
object.params – (optional) Dictionary or bytes to be sent in the query string for the
Request
.headers – (optional) Dictionary of HTTP Headers to send with the
Request
.cookies – (optional) Dict or CookieJar object to send with the
Request
.auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.
timeout – (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 – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- gather(*responses: Response, max_fetch: int | None = None) None [source]¶
Call this method to make sure in-flight responses are retrieved efficiently. This is a no-op if multiplexed is set to False (which is the default value). Passing a limited set of responses will wait for given promises and discard others for later.
- Parameters:
max_fetch – Maximal number of response to be fetched before exiting the loop. By default, it waits until all pending (lazy) response are resolved.
- get(url: str, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 30, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None) Response [source]¶
Sends a GET request. Returns
Response
object.- Parameters:
url – URL for the new
Request
object.params – (optional) Dictionary or bytes to be sent in the query string for the
Request
.headers – (optional) Dictionary of HTTP Headers to send with the
Request
.cookies – (optional) Dict or CookieJar object to send with the
Request
.auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.
timeout – (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 – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- get_adapter(url: str) BaseAdapter [source]¶
Returns the appropriate connection adapter for the given URL.
- get_redirect_target(resp: Response) str | None [source]¶
Receives a Response. Returns a redirect URI or
None
- head(url: str, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 30, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None) Response [source]¶
Sends a HEAD request. Returns
Response
object.- Parameters:
url – URL for the new
Request
object.params – (optional) Dictionary or bytes to be sent in the query string for the
Request
.headers – (optional) Dictionary of HTTP Headers to send with the
Request
.cookies – (optional) Dict or CookieJar object to send with the
Request
.auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.
timeout – (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 – (optional) Set to False by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- headers¶
A case-insensitive dictionary of headers to be sent on each
Request
sent from thisSession
.
- hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]]¶
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], stream: bool | None, verify: bool | str | bytes | None, cert: str | Tuple[str, str] | Tuple[str, str, str] | None) dict[str, Any] [source]¶
Check the environment and merge it with some settings.
- mount(prefix: str, adapter: BaseAdapter) None [source]¶
Registers a connection adapter to a prefix.
Adapters are sorted in descending order by prefix length.
- multiplexed¶
Toggle to leverage multiplexed connection.
- options(url: str, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 30, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None) Response [source]¶
Sends a OPTIONS request. Returns
Response
object.- Parameters:
url – URL for the new
Request
object.params – (optional) Dictionary or bytes to be sent in the query string for the
Request
.headers – (optional) Dictionary of HTTP Headers to send with the
Request
.cookies – (optional) Dict or CookieJar object to send with the
Request
.auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.
timeout – (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 – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str¶
Dictionary of querystring data to attach to each
Request
. The dictionary values may be lists for representing multivalued query parameters.
- patch(url: str, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, *, json: Any | None = None, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None) Response [source]¶
Sends a PATCH request. Returns
Response
object.- Parameters:
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 – (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 – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- post(url: str, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, json: Any | None = None, *, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None) Response [source]¶
Sends a POST request. Returns
Response
object.- Parameters:
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 – (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 – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- prepare_request(request: Request) PreparedRequest [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.
- 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: str, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, *, json: Any | None = None, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, verify: bool | str | bytes = True, stream: bool = False, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None) Response [source]¶
Sends a PUT request. Returns
Response
object.- Parameters:
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 – (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 – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- quic_cache_layer¶
A simple dict that allows us to persist which server support QUIC It is simply forwarded to urllib3.future that handle the caching logic. Can be any mutable mapping.
- rebuild_auth(prepared_request: PreparedRequest, response: Response) None [source]¶
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)[source]¶
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] [source]¶
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.
- request(method: str, url: str, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, timeout: int | float | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | Timeout | None = 120, allow_redirects: bool = True, proxies: Dict[str, str] | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, stream: bool | None = None, verify: bool | str | bytes | None = None, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, json: Any | None = None) Response [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 – (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 – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
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. It is also possible to put the certificates (directly) in a string or bytes.cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair, or (‘cert’, ‘key’, ‘key_password’).
- resolve_redirects(resp: Response, req: PreparedRequest, stream: bool = False, timeout: int | float | None = None, verify: bool | str | bytes = True, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, proxies: Dict[str, str] | None = None, yield_requests: bool = False, yield_requests_trail: bool = False, **adapter_kwargs: Any) Generator[Response | PreparedRequest, None, None] [source]¶
Receives a Response. Returns a generator of Responses or Requests.
- resolver¶
Custom DNS resolution method.
- retries¶
Configured retries for current Session
- send(request: PreparedRequest, **kwargs: Any) Response [source]¶
Send a given PreparedRequest.
- should_strip_auth(old_url: str, new_url: str) bool [source]¶
Decide whether Authorization header should be removed when redirecting
- source_address¶
Bind to address/network adapter
- stream¶
Stream response content default.
- trust_env: bool¶
Trust environment settings for proxy configuration, default authentication and similar.
- verify: bool | str | bytes¶
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.
Lower-Level Classes¶
- class niquests.Request(method: str | None = None, url: str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, hooks: Dict[str, List[Callable[[_HV], _HV | None]]] | None = None, json: Any | None = 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 niquests >>> req = niquests.Request('GET', 'https://httpbin.org/get') >>> req.prepare() <PreparedRequest [GET]>
- deregister_hook(event: str, hook: Callable[[Response | PreparedRequest], PreparedRequest | Response | None]) bool [source]¶
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: Callable[[Response | PreparedRequest], PreparedRequest | Response | None] | list[Callable[[Response | PreparedRequest], PreparedRequest | Response | None]]) None [source]¶
Properly register a hook.
- class requests.Response[source]¶
The
Response
object, which contains a server’s response to an HTTP request.- 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 conn_info: ConnectionInfo | None¶
Provide context to the established connection that was used to perform the request.
- property content: bytes | None¶
Content of the response, in bytes.
- cookies: CookieJar¶
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.
- headers: CaseInsensitiveDict¶
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 http_version: int | None¶
Shortcut to negotiated HTTP version protocol. See HttpVersion from urllib3.future. It returns an integer. It is as follows:
11 for HTTP/1.1
20 for HTTP/2
30 for HTTP/3
- property is_permanent_redirect: bool¶
True if this Response one of the permanent versions of redirect.
- 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 = -1, decode_unicode: Literal[False] = False) Generator[bytes, None, None] [source]¶
- iter_content(chunk_size: int = -1, *, decode_unicode: Literal[True]) Generator[str, None, None]
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: int = -1, decode_unicode: Literal[False] = False, delimiter: str | bytes | None = None) Generator[bytes, None, None] [source]¶
- iter_lines(chunk_size: int = -1, *, decode_unicode: Literal[True], delimiter: str | bytes | None = None) Generator[str, None, None]
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: Any) Any [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 or if content-type is not about json.
- property lazy: bool¶
Determine if response isn’t received and is actually a placeholder. Only significant if request was sent through a multiplexed connection.
- property links¶
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 ocsp_verified: bool | None¶
Marker that can inform you of the OCSP verification.
- property oheaders: Headers¶
Retrieve headers as they were objects. There is no need to parse headers yourself. A simple Mapping isn’t enough to quickly access and analyze them. Read the full documentation of object-oriented headers at https://ousret.github.io/kiss-headers/ >>> import niquests >>> r = niquests.get(”https://google.com”) >>> r.oheaders.content_type.charset ‘ISO-8859-1’ >>> r.oheaders.content_type ‘text/html; charset=ISO-8859-1’ >>> r.oheaders.content_type[0] ‘text/html’
- 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
.
- raw: BaseHTTPResponse | None¶
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: str | None¶
Textual reason of responded HTTP Status, e.g. “Not Found” or “OK”.
- request: PreparedRequest | None¶
The
PreparedRequest
object to which this is a response.
- status_code: int | None¶
Integer Code of responded HTTP Status, e.g. 404 or 200.
- property text: str | None¶
Content of the response, in unicode.
If Response.encoding is None, encoding will be guessed using
charset_normalizer
.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 | None¶
Final URL location of Response.
Lower-Lower-Level Classes¶
- class niquests.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 niquests >>> req = niquests.Request('GET', 'https://httpbin.org/get') >>> r = req.prepare() >>> r <PreparedRequest [GET]> >>> s = niquests.Session() >>> s.send(r) <Response HTTP/2 [200]>
- body: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None¶
request body to send to the server.
- conn_info: ConnectionInfo | None¶
valuable intel about the opened connection.
- deregister_hook(event: str, hook) bool [source]¶
Deregister a previously registered hook. Returns True if the hook existed, False if not.
- headers: CaseInsensitiveDict | None¶
dictionary of HTTP headers.
- hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]]¶
dictionary of callback hooks, for internal usage.
- method: str | None¶
HTTP verb to send to the server.
- ocsp_verified: bool | None¶
marker about if OCSP post-handshake verification took place.
- property path_url: str¶
Build the path URL to use.
- prepare(method: str | None = None, url: str | None = None, headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None = None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None = None, data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None = None, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None = None, auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None = None, cookies: MutableMapping[str, str] | CookieJar | None = None, hooks: Dict[str, List[Callable[[PreparedRequest | Response], PreparedRequest | Response | None]]] | None = None, json: Any | None = None) None [source]¶
Prepares the entire request with the given parameters.
- prepare_auth(auth: Tuple[str | bytes, str | bytes] | str | AuthBase | None, url: str = '') None [source]¶
Prepares the given HTTP auth data.
- prepare_body(data: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None, files: List[Tuple[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]]] | Dict[str, str | bytes | bytearray | IO | Tuple[str, str | bytes | bytearray | IO] | Tuple[str, str | bytes | bytearray | IO, str] | Tuple[str, str | bytes | bytearray | IO, str, MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers]] | None, json: Any | None = None) None [source]¶
Prepares the given HTTP body data.
- prepare_content_length(body: str | bytes | bytearray | IO | List[Tuple[str, str]] | Dict[str, str | List[str]] | Iterable[bytes] | Iterable[str] | None) None [source]¶
Prepare Content-Length header based on request method and body
- prepare_cookies(cookies: MutableMapping[str, str] | CookieJar | 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 toprepare_cookies
will have no actual effect, unless the “Cookie” header is removed beforehand.
- prepare_headers(headers: MutableMapping[str | bytes, str | bytes] | MutableMapping[str, str] | MutableMapping[bytes, bytes] | CaseInsensitiveDict | List[Tuple[str | bytes, str | bytes]] | Headers | None) None [source]¶
Prepares the given HTTP headers.
- prepare_url(url: str | None, params: List[Tuple[str, str | List[str]]] | Mapping[str, str | List[str]] | bytes | str | None) None [source]¶
Prepares the given HTTP URL.
- upload_progress: TransferProgress | None¶
upload progress if any.
- url: str | None¶
HTTP URL to send the request to.
- class niquests.adapters.BaseAdapter[source]¶
The Base Transport Adapter
- gather(*responses: Response, max_fetch: int | None = None) None [source]¶
Load responses that are still ‘lazy’. This method is meant for a multiplexed connection. Implementation is not mandatory.
- Parameters:
max_fetch – Maximal number of response to be fetched before exiting the loop. By default, it waits until all pending (lazy) response are resolved.
- send(request: PreparedRequest, stream: bool = False, timeout: int | float | None = None, verify: bool | str | bytes = True, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, proxies: Dict[str, str] | None = None, on_post_connection: Callable[[Any], None] | None = None, on_upload_body: Callable[[int, int | None, bool, bool], None] | None = None, multiplexed: bool = False) Response [source]¶
Sends PreparedRequest object. Returns Response object.
- Parameters:
request – The
PreparedRequest
being sent.stream – (optional) Whether to stream the request content.
timeout – (optional) How long to wait for the server to send data 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 verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. It is also possible to put the certificates (directly) in a string or bytes.
cert – (optional) Any user-provided SSL certificate to be trusted.
proxies – (optional) The proxies dictionary to apply to the request.
on_post_connection – (optional) A callable that should be invoked just after the pool mgr picked up a live connection. The function is expected to takes one positional argument and return nothing.
multiplexed – Determine if we should leverage multiplexed connection.
- class niquests.adapters.HTTPAdapter(pool_connections: int = 10, pool_maxsize: int = 10, max_retries: bool | int | Retry = 0, pool_block: bool = False, quic_cache_layer: MutableMapping[Tuple[str, int], Tuple[str, int] | None] | None = None, disable_http2: bool = False, disable_http3: bool = False, max_in_flight_multiplexed: int | None = None, resolver: str | ResolverDescription | BaseResolver | List[str] | List[ResolverDescription] | None = None, source_address: tuple[str, int] | None = None, disable_ipv4: bool = False, disable_ipv6: bool = False, happy_eyeballs: bool | int = False)[source]¶
The built-in HTTP Adapter for urllib3.future.
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:
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 connection should attempt. Note, this applies only to failed DNS lookups, socket connections and connection timeouts, never to requests where data has made it to the server. By default, Requests does not retry failed connections. If you need granular control over the conditions under which we retry a request, import urllib3’s
Retry
class and pass that instead.pool_block – Whether the connection pool should block for connections.
Usage:
>>> import niquests >>> s = niquests.Session() >>> a = niquests.adapters.HTTPAdapter(max_retries=3) >>> s.mount('http://', a)
- add_headers(request: PreparedRequest, **kwargs)[source]¶
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 the
HTTPAdapter
.- Parameters:
request – The
PreparedRequest
to add headers to.kwargs – The keyword arguments from the call to send().
- build_response(req: PreparedRequest, resp: HTTPResponse | ResponsePromise) 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:
req – The
PreparedRequest
used to generate the response.resp – The urllib3 response or promise object.
- cert_verify(conn: HTTPSConnectionPool, url: str, verify: bool | str | bytes | None, cert: str | Tuple[str, str] | Tuple[str, str, str] | None) None [source]¶
Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the
HTTPAdapter
.- 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 verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. It is also possible to put the certificates (directly) in a string or bytes.
cert – The SSL certificate to verify.
- close() None [source]¶
Disposes of any internal state.
Currently, this closes the PoolManager and any active ProxyManager, which closes any pooled connections.
- gather(*responses: Response, max_fetch: int | None = None) None [source]¶
Load responses that are still ‘lazy’. This method is meant for a multiplexed connection. Implementation is not mandatory.
- Parameters:
max_fetch – Maximal number of response to be fetched before exiting the loop. By default, it waits until all pending (lazy) response are resolved.
- get_connection(url: str, proxies: Dict[str, str] | None = None) HTTPConnectionPool | HTTPSConnectionPool [source]¶
Returns a urllib3 connection for the given URL. This should not be called from user code, and is only exposed for use when subclassing the
HTTPAdapter
.- Parameters:
url – The URL to connect to.
proxies – (optional) A Requests-style dictionary of proxies used on this request.
- init_poolmanager(connections: int, maxsize: int, block: bool = False, quic_cache_layer: MutableMapping[Tuple[str, int], Tuple[str, int] | None] | None = None, **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 the
HTTPAdapter
.- 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.
quic_cache_layer – Caching mutable mapping to remember QUIC capable endpoint.
pool_kwargs – Extra keyword arguments used to initialize the Pool Manager.
- proxy_headers(proxy: str) dict[str, str] [source]¶
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 the
HTTPAdapter
.- Parameters:
proxy – The url of the proxy being used for this request.
- proxy_manager_for(proxy: str, **proxy_kwargs: Any) ProxyManager [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 the
HTTPAdapter
.- Parameters:
proxy – The proxy to return a urllib3 ProxyManager for.
proxy_kwargs – Extra keyword arguments used to configure the Proxy Manager.
- Returns:
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 the
HTTPAdapter
.- Parameters:
request – The
PreparedRequest
being sent.proxies – A dictionary of schemes or schemes and hosts to proxy URLs.
- send(request: PreparedRequest, stream: bool = False, timeout: int | float | Timeout | None = None, verify: bool | str | bytes = True, cert: str | Tuple[str, str] | Tuple[str, str, str] | None = None, proxies: Dict[str, str] | None = None, on_post_connection: Callable[[Any], None] | None = None, on_upload_body: Callable[[int, int | None, bool, bool], None] | None = None, multiplexed: bool = False) Response [source]¶
Sends PreparedRequest object. Returns Response object.
- Parameters:
request – The
PreparedRequest
being sent.stream – (optional) Whether to stream the request content.
timeout – (optional) How long to wait for the server to send data 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 verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. It is also possible to put the certificates (directly) in a string or bytes.
cert – (optional) Any user-provided SSL certificate to be trusted.
proxies – (optional) The proxies dictionary to apply to the request.
on_post_connection – (optional) A callable that contain a single positional argument for newly acquired connection. Useful to check acquired connection information.
multiplexed – Determine if request shall be transmitted by leveraging the multiplexed aspect of the protocol if available. Return a lazy instance of Response pending its retrieval.
Authentication¶
- class niquests.auth.HTTPBasicAuth(username: str | bytes, password: str | bytes)[source]¶
Attaches HTTP Basic Authentication to the given Request object.
Status Code Lookup¶
- niquests.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 niquests
>>> niquests.codes['temporary_redirect']
307
>>> niquests.codes.teapot
418
>>> niquests.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
, and
codes.okay
all correspond to the HTTP status code 200.
100:
continue
101:
switching_protocols
102:
processing
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
414:
request_uri_too_large
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
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 3.x¶
Compared with the 2.0 release, there were relatively few backwards incompatible changes, but there are still a few issues to be aware of with this major release.
Removed¶
Property
apparent_encoding
in favor of a discrete internal inference.Support for the legacy
chardet
detector in case it was present in environment. Extrachardet_on_py3
is now unavailable.requests.compat no longer hold reference to _chardet_.
Deprecated
requests.packages
that was meant to avoid breakage from people importingurllib3
orchardet
within this package. They were _vendored_ in early versions of Requests. A long time ago.Deprecated function
get_encodings_from_content
from utils.Deprecated function
get_unicode_from_response
from utils.BasicAuth middleware no-longer support anything else than
bytes
orstr
for username and password.requests.compat
is stripped of every reference that no longer vary between supported interpreter version.Charset fall back ISO-8859-1 when content-type is text and no charset was specified.
Main function
get
,post
,put
,patch
,delete
, andhead
no longer accept kwargs. They have a fixed list of typed argument. It is no longer possible to specify non-supported additional keyword argument from aSession
instance or directly throughrequests.api
functions. e.g. functiondelete
no-longer acceptjson
, orfiles
arguments. as per RFCs specifications. You can still override this behavior through therequest
function.Mixin classes
RequestEncodingMixin
, andRequestHooksMixin
due to OOP violations. Now deported directly into child classes.Function
unicode_is_ascii
as it is part of the stablestr
stdlib on Python 3 or greater.Alias function
session
forSession
context manager that was kept for BC reasons since the v1.pyOpenSSL/urllib3 injection in case built-in ssl module does not have SNI support as it is not the case anymore for every supported interpreters.
Constant
DEFAULT_CA_BUNDLE_PATH
, and submodulecerts
due to droppingcertifi
.Function
extract_zipped_paths
because rendered useless as it was made to handle an edge case wherecertifi
is “zipped”.Extra
security
when installing this package. It was previously emptied in the previous major.Warning emitted when passing a file opened in text-mode instead of binary. urllib3.future can overrule the content-length if it detects an error. You should not encounter broken request being sent.
Support for
simplejson
if was present in environment.Submodule
compat
.Dependency check at runtime for
urllib3
. There’s no more check and warnings at runtime for that subject. Ever.
Behavioural Changes¶
Niquests negotiate for a HTTP/2 connection by default, fallback to HTTP/1.1 if not available.
Support for HTTP/3 can be present by default if your platform support the pre-built wheel for qh3.
Server capability for HTTP/3 is remembered automatically (in-memory) for subsequent requests.