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

```

SSL
===

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

```python
>>> 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.4.3.tar.gz (6.9 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for Flask-Loopback-1.4.3.tar.gz
Algorithm Hash digest
SHA256 8fa8ecf42687b5efe5154fff2544186e4a0932ef38b939710cd9e58e2bf536a9
MD5 58df9354e5eec7682b48a7f92f616090
BLAKE2b-256 c1a8730300e21625631f0226f8ba34d9f38a44bfe9746f913aac1f4b2d964506

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