requests-mock-flask

|Build Status| |codecov| |PyPI| |Documentation Status|

requests-mock-flask

requests-mock-flask helps with testing Flask_ applications with httpretty, responses or requests-mock_.

.. contents:: :local:

Installation

Requires Python 3.12+.

.. code:: sh

pip install requests-mock-flask

Usage example

.. code:: python

import flask import httpretty import requests import responses import requests_mock

from requests_mock_flask import add_flask_app_to_mock

app = flask.Flask("test_app")

@app.route('/') def _() -> str: """Return a simple message.""" 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!'

def test_httpretty_context_manager() -> None: """ It is possible to use the helper with a httpretty context manager. """ with httpretty.core.httprettized(): 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!'

.. -> test_src

.. invisible-code-block: python

import pathlib import subprocess import tempfile

import pytest

with tempfile.TemporaryDirectory() as tmp_dir: test_file = pathlib.Path(tmp_dir) / 'test_src.py' test_file.write_text(test_src) subprocess.check_output(["python", "-m", "pytest", test_file, "--basetemp", test_file.parent])

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 <https://requests-mock-flask.readthedocs.io/en/latest>__ for more information including how to contribute.

.. _Flask: https://flask.palletsprojects.com/ .. _requests-mock: https://requests-mock.readthedocs.io/en/latest/ .. _responses: https://github.com/getsentry/responses .. _httpretty: https://httpretty.readthedocs.io

.. |Build Status| image:: https://github.com/adamtheturtle/requests-mock-flask/workflows/CI/badge.svg :target: https://github.com/adamtheturtle/requests-mock-flask/actions .. |codecov| image:: https://codecov.io/gh/adamtheturtle/requests-mock-flask/branch/main/graph/badge.svg :target: https://codecov.io/gh/adamtheturtle/requests-mock-flask .. |Documentation Status| image:: https://readthedocs.org/projects/requests-mock-flask/badge/?version=latest :target: https://requests-mock-flask.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. |PyPI| image:: https://badge.fury.io/py/requests-mock-flask.svg :target: https://badge.fury.io/py/requests-mock-flask