'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 httpretty, responses or requests-mock.
Installation
Requires Python 3.9+.
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`` adapter.
"""
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!'
@httpretty.activate
def test_httpretty_decorator() -> None:
"""
It is possible to use the helper with HTTPretty.
"""
add_flask_app_to_mock(
mock_obj=httpretty,
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!'
Use cases
Use requests or other Python APIs for testing Flask 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-2022.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0d2fe012fd564cb5ca8bc8a2f875e72c08fa7f4eaacead655b5f070fdd9acd0 |
|
MD5 | 6448636467ebb9c714a017bf9c8eec03 |
|
BLAKE2b-256 | 61bb8edb0fa7382a7d715d639f93dd574fedc59f89313ff3bde1259ea1c8bafa |
Close
Hashes for requests_mock_flask-2022.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f764979943ef6559e63ed6bc6dc1f2ab472f56fd3c1c80e313db60ba3c7eb70 |
|
MD5 | 29db9b0878bca2502aafd7591688aab2 |
|
BLAKE2b-256 | f05a168c3c9db5f38c18cb4f0ab97bbad8ec01957e15f99e644c36da3ca3785a |