Skip to main content

Library for faking HTTP requests using flask applications without actual network operations

Project description

Build Status   Version

Overview

Flask-Loopback enables you to use written Flask applications in your code to mock actual web services. This is useful if you are writing a client that will use an existing web service and would like to know how well it will interact with the real thing.

Flask-Loopback does this without actually sending HTTP requests over the network, but rather through stubbing the requests package so that only requests directed at your mock will arrive at their destination.

Doing this is very simple. You probably already have a flask application somewhere that you'd like to use

# myapp.py
>>> import flask

>>> app = flask.Flask(__name__)

>>> @app.route("/some/path")
... def hello():
...     return "hello!"

When you want to actually use it, you activate the loopback on a specified address:

>>> import requests
>>> from flask_loopback import FlaskLoopback

>>> loopback = FlaskLoopback(app)

>>> with loopback.on(("some-address.com", 80)):
...    print(requests.get("http://some-address.com/some/path").content.decode("utf-8"))
hello!

To help you perform more actions before and after requests, you can register request context functions to be called around actual requests (this is in addition to the default handlers provided by Flask):

>>> from contextlib import contextmanager

>>> @loopback.register_request_context_handler
... @contextmanager
... def request_handler(request):
...     # do something before request handling
...     yield
...     # do something after request handling

SSL

SSL is disabled by default, but you can easily activate it:

>>> with loopback.on(("some-address.localdomain", 443)):
...    requests.get("https://some-address.localdomain/some/path") # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
	...
SSLError
>>> with loopback.on(("some-address.localdomain", 443), ssl=True):
...    requests.get("https://some-address.localdomain/some/path") # doctest: +IGNORE_EXCEPTION_DETAIL
<Response [200]>

Licence

BSD3 (See LICENSE)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_loopback-1.6.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

Flask_Loopback-1.6.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file flask_loopback-1.6.0.tar.gz.

File metadata

  • Download URL: flask_loopback-1.6.0.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for flask_loopback-1.6.0.tar.gz
Algorithm Hash digest
SHA256 44eedbedf60ef4fc933a506e10a0b0bf70e670fcf1cb11936813c66b4b1fcc2d
MD5 859b4187c8cdfd275f76f59b4f044dcb
BLAKE2b-256 63fff4d30d28df6d2c6fd9ad370eaed516c31b55a3973456e749bec48b34b4f6

See more details on using hashes here.

File details

Details for the file Flask_Loopback-1.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Loopback-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ac1a2d763ceb302b99c3ebbfbc73c4d0781e11498e11f8262b390ab01154553
MD5 b57e8a9b41ee3d699af124969460508a
BLAKE2b-256 73724f25c57911bc5df8e89d029a1681a7c2b05731f963079d57d041d5390915

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page