flask-shortcut 0.3.1

Extension that provides an easy way to add dev-only shortcuts to your routes.

Project Description

This extension provides an easy and safe way to add dev-only shortcuts to routes in your flask application.

The main beneficiaries are microservices that need to be tested regularly in conjunction with their clients. If you need to assert working communication and basic integration in a sufficiently complex ecosystem, clients that can not freely chose how their requests are formed gain a lot from being able to receive predictable responses. By skipping over the details of how the microservice is implemented, which bugs and minor changes it experiences over time, testing basic API compatibility gets a lot more manageable.

Usage

You can add shortcuts to your route functions either individually with decorators, or in a single swoop once all routes have been defined. Both ways are functionally equivalent.

With decorators:

from flask import Flask
from flask_shortcut import Shortcut

app = Flask(__name__)
short = Shortcut(app)

app.route('/foo', methods=['GET'])
short.cut(('short_foo', 200))
def foo():
    return 'foo'

app.route('/bar', methods=['POST'])
short.cut({'{"name": "TestUser"}': ('short_bar', 200)})
def bar():
    return 'bar'

With a wire call

from flask import Flask
from flask_shortcut import Shortcut

app = Flask(__name__)

app.route('/foo', methods=['GET'])
def foo():
    return 'foo'

app.route('/bar', methods=['POST'])
def bar():
    return 'bar'

Shortcut(app).wire(
    {
         '/foo': ('short_foo', 200),
         '/bar': {'{"name": "TestUser"}': ('short_bar', 200)
    }
)

---

Project home on github.