Requests-Mock Utility¶
StackInABox provides support for writing tests with requests-mock.
-
class
stackinabox.util.requests_mock.RequestMockCallable(uri)¶ Requests-Mock Callable object.
Python callable object to interact with Requests-Mock
-
static
get_reason_for_status()¶ Lookup the HTTP reason text for a given status code.
Parameters: status_code – int - HTTP status code Returns: string - HTTP reason text
-
handle(request, uri)¶ Request handler interface.
Parameters: - request – Python requests Request object
- uri – URI of the request
-
static
split_status()¶ Split a HTTP Status and Reason code string into a tuple.
- :param status string containing the status and reason text or
- the integer of the status code
Returns: tuple - (int, string) containing the integer status code and reason text string
-
static
-
stackinabox.util.requests_mock.requests_mock_session_registration(*args, **kwargs)¶
-
stackinabox.util.requests_mock.requests_mock_registration(*args, **kwargs)¶
-
stackinabox.util.requests_mock.requests_request(method, url, **kwargs)¶ Requests-mock requests.request wrapper.
-
stackinabox.util.requests_mock.requests_get(url, **kwargs)¶ Requests-mock requests.get wrapper.
-
stackinabox.util.requests_mock.requests_options(url, **kwargs)¶ Requests-mock requests.options wrapper.
-
stackinabox.util.requests_mock.requests_head(url, **kwargs)¶ Requests-mock requests.head wrapper.
-
stackinabox.util.requests_mock.requests_post(url, data=None, json=None, **kwargs)¶ Requests-mock requests.post wrapper.
-
stackinabox.util.requests_mock.requests_put(url, data=None, **kwargs)¶ Requests-mock requests.put wrapper.
-
stackinabox.util.requests_mock.requests_patch(url, data=None, **kwargs)¶ Requests-mock requests.patch wrapper.
-
stackinabox.util.requests_mock.requests_delete(url, **kwargs)¶ Requests-mock requests.delete wrapper.
-
class
stackinabox.util.requests_mock.requests_session¶ Requests-mock requests.Session wrapper.
-
close(**kwargs)¶ requests.session.Session.close wrapper.
-
delete(**kwargs)¶ requests.session.Session.delete wrapper.
-
get(**kwargs)¶ requests.session.Session.get wrapper.
-
get_adapter(**kwargs)¶ requests.session.Session.get_adapter wrapper.
-
head(**kwargs)¶ requests.session.Session.head wrapper.
-
merge_environment_settings(**kwargs)¶ requests.session.Session.merge_environment_settings wrapper.
-
mount(**kwargs)¶ requests.session.Session.mount wrapper.
-
options(**kwargs)¶ requests.session.Session.options wrapper.
-
patch(**kwargs)¶ requests.session.Session.patch wrapper.
-
post(**kwargs)¶ requests.session.Session.post wrapper.
-
prepare_request(request)¶ Pyton requests.session.Session.prepare_request wrapper.
-
put(**kwargs)¶ requests.session.Session.put wrapper.
-
request(**kwargs)¶ requests.session.Session.request wrapper.
-
send(**kwargs)¶ requests.session.Session.send wrapper.
-
-
stackinabox.util.requests_mock.get_session()¶ Access the global session object.
-
class
stackinabox.util.requests_mock.activate¶ Requests-mock context object for Stack-In-A-Box.