'Helpers to use requests_mock and responses with a Flask test client.'
Project description
requests-mock-flask
requests-mock-flask helps with testing Flask applications with responses or requests-mock.
Installation
Requires Python 3.8+.
pip install requests-mock-flask
Usage example
import flask
import requests
import responses
import requests_mock
from requests_mock_flask import add_flask_app_to_mock
app = flask.Flask(__name__)
@app.route('/')
def _() -> str:
return 'Hello, World!'
@responses.activate
def test_responses_decorator() -> None:
"""
It is possible to use the helper with a ``responses`` decorator.
"""
add_flask_app_to_mock(
mock_obj=responses,
flask_app=app,
base_url='http://www.example.com',
)
response = requests.get('http://www.example.com')
assert response.status_code == 200
assert response.text == 'Hello, World!'
def test_responses_context_manager() -> None:
"""
It is possible to use the helper with a ``responses`` context manager.
"""
with responses.RequestsMock(
assert_all_requests_are_fired=False,
) as resp_m:
add_flask_app_to_mock(
mock_obj=resp_m,
flask_app=app,
base_url='http://www.example.com',
)
response = requests.get('http://www.example.com')
assert response.status_code == 200
assert response.text == 'Hello, World!'
def test_requests_mock_context_manager() -> None:
"""
It is possible to use the helper with a ``requests_mock`` context
manager.
"""
with requests_mock.Mocker() as resp_m:
add_flask_app_to_mock(
mock_obj=resp_m,
flask_app=app,
base_url='http://www.example.com',
)
response = requests.get('http://www.example.com')
assert response.status_code == 200
assert response.text == 'Hello, World!'
def test_requests_mock_adapter() -> None:
"""
It is possible to use the helper with a ``requests_mock`` fixture.
"""
session = requests.Session()
adapter = requests_mock.Adapter()
session.mount('mock', adapter)
add_flask_app_to_mock(
mock_obj=adapter,
flask_app=app,
base_url='mock://www.example.com',
)
response = session.get('mock://www.example.com')
assert response.status_code == 200
assert response.text == 'Hello, World!'
Use cases
Use the requests API for testing applications.
Create a test suite which can test a Flask application as well as a live web application, to make a verified fake.
Test a service which calls a Flask application that you have the source code for.
Full documentation
See the full documentation for more information including how to contribute.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for requests-mock-flask-2020.9.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ad1ef0feb1f1ac9b6816d6ea223ae8f24ff63c113399b4d576097b6397763a6 |
|
MD5 | 4c479754f8eea0c1b05769423d0b9913 |
|
BLAKE2b-256 | cd1fa6ad75e5732b90ead07ad8e84398aee78507fdf76266b21bf0ad4e75de60 |
Close
Hashes for requests_mock_flask-2020.9.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9aa5ec50f02dab7c868d8b0a5ce6636b5888eccf3fb6dcff85d9671ad4829fe8 |
|
MD5 | bf176de9186cc93b2f7ceda024922f00 |
|
BLAKE2b-256 | e7f690b88b61d6c92b10cfea94adbb0415efd66c5ad41e70ddaf35242558302c |