Skip to main content

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

Project description

![Build Status] (https://secure.travis-ci.org/vmalloc/Flask-Loopback.png )   ![Downloads] (https://pypip.in/d/Flask-Loopback/badge.png )   ![Version] (https://pypip.in/v/Flask-Loopback/badge.png )

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

```python
# 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:

```python
>>> import requests
>>> from flask.ext.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):

```python
>>> 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

```

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.1.5.tar.gz (6.6 kB view details)

Uploaded Source

File details

Details for the file Flask-Loopback-1.1.5.tar.gz.

File metadata

File hashes

Hashes for Flask-Loopback-1.1.5.tar.gz
Algorithm Hash digest
SHA256 f670e2d4d2c86a1082fee91cbd5f73d7f8734997e54ceb72853cbc315906fd47
MD5 513f191e76c755e3f2d34c5df6e8f46b
BLAKE2b-256 afcde38f418d9811cb036b6e895c6b3ff44aa812aef6a1b7de1e1303440ce46d

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