⚙API documentation

pytest plugin

pytest_response.plugin.pytest_addoption(parser)

Pytest hook for adding cmd-line options.

Adds relevent cmd-line and ini-config options.

pytest_response.plugin.pytest_configure(config)

Pytest hook for setting up pytest_response.app.Response

pytest_response.plugin.pytest_unconfigure(config)

Pytest hook for cleaning up.

---

Response

class pytest_response.app.BaseMockResponse(status: int, data: bytes, headers: dict = {})

Bases: object

Basic response for mocking requests.

Parameters:

• status (int) – Status code of the response.

• data (bytes) – Response data.

• headers (dict, optional) – Default to {}.

close() → None

flush()

getcode() → int

info() → dict

read(*args, **kwargs) → bytes

Wrapper for _io.BytesIO.read

readinto(*args, **kwargs) → bytes

Wrapper for _io.BytesIO.readinto

readline(*args, **kwargs) → bytes

Wrapper for _io.BytesIO.readline

class pytest_response.app.Response(path: str = 'interceptors', capture: bool = False, remote: bool = False, response: bool = False, log_level: str = 'debug', database: str = 'database.db')

Bases: object

Controlling and configuration application for pytest-remote-response

Parameters:

• path (str, optional) – Path for the interceptors. Defaults to pytest_response.interceptors

• capture (bool, optional) – if True captures data and headers in the database. Defaults to False

• remote (bool, optional) – if False blocks connection requests. Defaults to False

• response (bool, optional) – if True responds with data and headers from the database. Defaults to False

• log_level (str, optional) – Log level. Defaults to debug

Examples

>>> from pytest_response import response
>>> response.setup_database({{ Path to the database}})
>>> response.post({{ Interceptor }})
>>> ...
>>> response.unpost()

activate(interceptors: str | list)

Wrapper to apply the interceptor decorator.

Parameters:

interceptor (str, list) – interceptors to apply

Examples

>>> @response.activate("urllib_quick")
>>> def test_urllib():
>>>     url = "https://www.python.org"
>>>     r = urlopen(url)
>>>     assert r.status == 200

apply(mock: str | list | None = None) → bool

Activates intercepter module provided in mock otherwise activates all.

Parameters:

mock (str, optional) – Applies the mock.

property available: List[str]

property capture: bool

configure(remote: bool = False, capture: bool = False, response: bool = False) → None

Helper method for configuring interceptors.

Parameters:

• remote (bool, optional) – If False blocks connection requests. Defaults to False.

• capture (bool, optional) – If True captures data and headers in the database. Defaults to False.

• response (bool, optional) – If True responds with data and headers from the database. Defaults to False.

get(url: str, *args, **kwargs)

Wrapper function for pytest_response.database.ResponseDB.get()

Parameters:

url (str) – URL to be queried.

Returns:

• status (int) – Status code

• data (bytes) – Response data.

• headers (dict) – Response header.

insert(url: str, response: bytes, headers: str, status: int, *args, **kwargs) → bool

Wrapper function for pytest_response.database.ResponseDB.insert()

Parameters:

• url (str) – URL of the dump.

• response (bytes) – Data captured.

• headers (str) – Headers captured.

• status (int) – Status code of the response.

• **kwargs (dict) – Any additional parameter to be dumped.

post(mock: str | list) → None

Registers and applies the mock under the same hood.

Internally uses Response.register() followed by Response.apply()

Parameters:

mock (str) – Registers and applies the mock.

register(mock: str | list) → None

Registers interceptor modules; applies using Response.apply()

Parameters:

mock (str, list) – Interceptor; check Response.available() for more info.

registered() → Dict[str, module]

Returns registered modules.

Returns:

Returns the list of registered interceptors.

Return type:

list of pathlib.Path

property remote: bool

property response: bool

setup_database(path: str) → bool

Method to setup-up database.

Parameters:

path (str) – Path for the database.

unapply(*args, **kwargs) → bool

Un-applies interceptor modules.

unpost() → bool

Unapplied and unregisters mocks under the same hood.

Internally uses Response.unapply() followed by Response.unregister()

unregister() → bool

Deactivates interceptor modules.

---

Database

class pytest_response.database.ResponseDB(path: str)

Bases: object

Wrapper class for sqlite3

Parameters:

path (str) – Path for the database

Examples

>>> db = ResponseDB("database.db")

all() → dict

Method to return all records in the database.

Return type:

Return list of all elements.

close() → None

get(url: str, **kwargs) → Tuple[int, bytes, dict]

Method for getting response and header for a perticular query url. Currently working by locating url only; multi-query to be implemented later.

Parameters:

url (str) – URL to be queried.

Returns:

• status (int) – Status code

• data (bytes) – Response data.

• headers (dict) – Response header.

index(index: str | None = 'url') → List[str]

Returns all occurances of the column index.

Parameters:

index (str) – Defaults to url.

Returns:

_occurances – All occurances of the selected column index.

Return type:

list

insert(url: str, response: bytes, headers: dict, status: int | None = 200, **kwargs) → None

Method for dumping url, headers and responses to the database. All additonal kwargs are dumped as well.

Parameters:

• url (str) – URL of the dump.

• response (bytes) – Data captured.

• headers (str) – Headers captured.

• status (int) – Status code of the response.

• kwargs (dict) – Any additional parameter to be dumped.

setup() → bool

Function to setup the database table.

today = '2024-01-17'

truncate() → bool

Method to purge all records in the database.

---

Interceptors

urllib Interceptor module

Functions

urlopen_wrapper(func)	Wrapper for urllib.request
install()	Method to monkey patch the library call with the wrapped one.
uninstall()	Method to undo all monkey patches.

Classes

MockResponse(status, data[, headers])

Class Inheritance Diagram

digraph inheritance110b50ce14 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseMockResponse" [URL="#pytest_response.app.BaseMockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Basic response for mocking requests."]; "MockResponse" [URL="../api/pytest_response.interceptors.urllib.MockResponse.html#pytest_response.interceptors.urllib.MockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseMockResponse" -> "MockResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

urllib Interceptor module (unstable)

Functions

install()
uninstall()

Classes

ResponseSocketIO(sock, mode)	Provides a method to write the value of the buffer into another var for dumping.
ResponseSocket(host, port, *args, **kwargs)	Socket implementation of Pytest-Response
Response_SSLSocket(*args, **kwargs)	SSLSocket implementation of Pytest-Response
ResponseHTTPConnection(host[, port, ...])	Wrapper for ~http.client.HTTPConnection
ResponseHTTPHandler([debuglevel])	Override the default HTTPHandler class with one that uses the ResponseHTTPConnection class to open HTTP URLs.
ResponseHTTPResponse(sock[, debuglevel, ...])	Provides a way to capture or respond with a saved response.
ResponseHTTPSConnection(host[, port, ...])	Override the default ~HTTPSConnection to use ~ResponseSocket
ResponseHTTPSHandler([debuglevel, context, ...])	Override the default HTTPSHandler class with one that uses the ResponseHTTPSConnection class to open HTTP URLs.

Class Inheritance Diagram

digraph inheritance44fd9ab886 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AbstractHTTPHandler" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "BaseHandler" -> "AbstractHTTPHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseHandler" [URL="https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BufferedIOBase" [URL="https://docs.python.org/3/library/io.html#io.BufferedIOBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for buffered IO objects."]; "_BufferedIOBase" -> "BufferedIOBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IOBase" -> "BufferedIOBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPConnection" [URL="https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "HTTPHandler" [URL="https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "AbstractHTTPHandler" -> "HTTPHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPResponse" [URL="https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BufferedIOBase" -> "HTTPResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPSConnection" [URL="https://docs.python.org/3/library/http.client.html#http.client.HTTPSConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="This class allows communication via SSL."]; "HTTPConnection" -> "HTTPSConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPSHandler" [URL="https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPSHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "AbstractHTTPHandler" -> "HTTPSHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IOBase" [URL="https://docs.python.org/3/library/io.html#io.IOBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The abstract base class for all I/O classes."]; "_IOBase" -> "IOBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RawIOBase" [URL="https://docs.python.org/3/library/io.html#io.RawIOBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for raw binary I/O."]; "_RawIOBase" -> "RawIOBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IOBase" -> "RawIOBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPConnection" [URL="../api/pytest_response.interceptors._urllib.ResponseHTTPConnection.html#pytest_response.interceptors._urllib.ResponseHTTPConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wrapper for `~http.client.HTTPConnection`"]; "HTTPConnection" -> "ResponseHTTPConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPHandler" [URL="../api/pytest_response.interceptors._urllib.ResponseHTTPHandler.html#pytest_response.interceptors._urllib.ResponseHTTPHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Override the default HTTPHandler class with one that uses the"]; "HTTPHandler" -> "ResponseHTTPHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPResponse" [URL="../api/pytest_response.interceptors._urllib.ResponseHTTPResponse.html#pytest_response.interceptors._urllib.ResponseHTTPResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Provides a way to capture or respond with a saved response."]; "HTTPResponse" -> "ResponseHTTPResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPSConnection" [URL="../api/pytest_response.interceptors._urllib.ResponseHTTPSConnection.html#pytest_response.interceptors._urllib.ResponseHTTPSConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Override the default `~HTTPSConnection` to use `~ResponseSocket`"]; "HTTPSConnection" -> "ResponseHTTPSConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPConnection" -> "ResponseHTTPSConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPSHandler" [URL="../api/pytest_response.interceptors._urllib.ResponseHTTPSHandler.html#pytest_response.interceptors._urllib.ResponseHTTPSHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Override the default HTTPSHandler class with one that uses the"]; "HTTPSHandler" -> "ResponseHTTPSHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseSocket" [URL="../api/pytest_response.interceptors._urllib.ResponseSocket.html#pytest_response.interceptors._urllib.ResponseSocket",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Socket implementation of Pytest-Response"]; "socket" -> "ResponseSocket" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseSocketIO" [URL="../api/pytest_response.interceptors._urllib.ResponseSocketIO.html#pytest_response.interceptors._urllib.ResponseSocketIO",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Provides a method to write the value of the buffer into another var for dumping."]; "SocketIO" -> "ResponseSocketIO" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response_SSLSocket" [URL="../api/pytest_response.interceptors._urllib.Response_SSLSocket.html#pytest_response.interceptors._urllib.Response_SSLSocket",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="SSLSocket implementation of Pytest-Response"]; "SSLSocket" -> "Response_SSLSocket" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SSLSocket" [URL="https://docs.python.org/3/library/ssl.html#ssl.SSLSocket",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="This class implements a subtype of socket.socket that wraps"]; "socket" -> "SSLSocket" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SocketIO" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Raw I/O implementation for stream sockets."]; "RawIOBase" -> "SocketIO" [arrowsize=0.5,style="setlinewidth(0.5)"]; "_BufferedIOBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for buffered IO objects."]; "_IOBase" -> "_BufferedIOBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "_IOBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="The abstract base class for all I/O classes."]; "_RawIOBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for raw binary I/O."]; "_IOBase" -> "_RawIOBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "socket" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="socket(family=AF_INET, type=SOCK_STREAM, proto=0) -> socket object"]; "socket" [URL="https://docs.python.org/3/library/socket.html#socket.socket",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A subclass of _socket.socket adding the makefile() method."]; "socket" -> "socket" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

---

urllib3 Interceptor module

Functions

urlopen_wrapper(func)	Wrapper for urllib3.HTTPConnectionPool.urlopen()
install()	Method to monkey patch the library call with the wrapped one.
uninstall()	Method to undo all monkey patches.

Classes

MockResponse(status, data[, headers])

Class Inheritance Diagram

digraph inheritance0860e34072 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseMockResponse" [URL="#pytest_response.app.BaseMockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Basic response for mocking requests."]; "MockResponse" [URL="../api/pytest_response.interceptors.urllib3.MockResponse.html#pytest_response.interceptors.urllib3.MockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseMockResponse" -> "MockResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

---

urllib3 Interceptor module (unstable)

Functions

install()
uninstall()

Classes

Response_HTTPU3_Intercepter(*args, **kwargs)
Response_HTTPSU3_Intercepter(*args, **kwargs)

Class Inheritance Diagram

digraph inheritance73e1d24279 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "HTTPConnection" [URL="https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "HTTPConnection" [URL="https://urllib3.readthedocs.io/en/stable/reference/urllib3.connection.html#urllib3.connection.HTTPConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Based on :class:`http.client.HTTPConnection` but provides an extra constructor"]; "HTTPConnection" -> "HTTPConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPSConnection" [URL="https://docs.python.org/3/library/http.client.html#http.client.HTTPSConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="This class allows communication via SSL."]; "HTTPConnection" -> "HTTPSConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPSConnection" [URL="https://urllib3.readthedocs.io/en/stable/reference/urllib3.connection.html#urllib3.connection.HTTPSConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Many of the parameters to this constructor are passed to the underlying SSL"]; "HTTPConnection" -> "HTTPSConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPConnection" [URL="../api/pytest_response.interceptors._urllib.ResponseHTTPConnection.html#pytest_response.interceptors._urllib.ResponseHTTPConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wrapper for `~http.client.HTTPConnection`"]; "HTTPConnection" -> "ResponseHTTPConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPSConnection" [URL="../api/pytest_response.interceptors._urllib.ResponseHTTPSConnection.html#pytest_response.interceptors._urllib.ResponseHTTPSConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Override the default `~HTTPSConnection` to use `~ResponseSocket`"]; "HTTPSConnection" -> "ResponseHTTPSConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ResponseHTTPConnection" -> "ResponseHTTPSConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response_HTTPSU3_Intercepter" [URL="../api/pytest_response.interceptors._urllib3.Response_HTTPSU3_Intercepter.html#pytest_response.interceptors._urllib3.Response_HTTPSU3_Intercepter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ResponseHTTPSConnection" -> "Response_HTTPSU3_Intercepter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPSConnection" -> "Response_HTTPSU3_Intercepter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response_HTTPU3_Intercepter" [URL="../api/pytest_response.interceptors._urllib3.Response_HTTPU3_Intercepter.html#pytest_response.interceptors._urllib3.Response_HTTPU3_Intercepter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ResponseHTTPConnection" -> "Response_HTTPU3_Intercepter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HTTPConnection" -> "Response_HTTPU3_Intercepter" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

---

requests Interceptor Module

Functions

requests_wrapper(func)	Wrapper for requests.get()
install()	Method to monkey patch the library call with the wrapped one.
uninstall()	Method to undo all monkey patches.

Classes

MockResponse(status, data[, headers])

Class Inheritance Diagram

digraph inheritance2ac8f8932a { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseMockResponse" [URL="#pytest_response.app.BaseMockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Basic response for mocking requests."]; "MockResponse" [URL="../api/pytest_response.interceptors.requests.MockResponse.html#pytest_response.interceptors.requests.MockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseMockResponse" -> "MockResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

---

aiohttp Interceptor Module

Functions

create_wrapper(func)	Wrapper for aiohttp.ClientResponse.text()
get_wrapper(func)	Wrapper for aiohttp.ClientSession.get()
install()	Method to monkey patch the library call with the wrapped one.
uninstall()	Method to undo all monkey patches.

Classes

MockResponse(status, data[, headers])

Class Inheritance Diagram

digraph inheritance63d727b541 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseMockResponse" [URL="#pytest_response.app.BaseMockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Basic response for mocking requests."]; "MockResponse" [URL="../api/pytest_response.interceptors.aiohttp.MockResponse.html#pytest_response.interceptors.aiohttp.MockResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseMockResponse" -> "MockResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

---

Exceptions

RemoteBlockedError([reason])	Exception raised when Remote connections are blocked.
ResponseNotFound([reason])	Exception raised when response is not locally available.
MalformedUrl([reason])	Exception raised when a malformed URL is encountered.
InterceptorNotFound([reason])	Exception raised when the requested interceptor is not available.
DatabaseNotFound([reason])	Exception raised when database is not initialized properly.