Skip to main content

A Flask extension that forces extremely skinny controllers.

Project description

flask-skinny

A Flask extension that forces extremely skinny controllers.

@app.route("/dogs/<int:dog_id>", methods=["POST"])
@skinny.responses({200: responses.greet_dog, 400: responses.bad_request})
@skinny.intent(intents.greet_dog)
def greet_dog(dog_id):
    pass

Description

This extension contains two decorators, @skinny.intent and @skinny.responses.

  • @skinny.intent(callable)
    • callable: Receives flask.request, returns status_code and outcome.
  • @skinny.responses({status_code: callable, ...})
    • callable: Receives flask.request and outcome, returns headers and body.

@skinny.responses will choose an appropriate response by status_code.

Simple Usage

from flask import Flask
from flask_skinny import skinny
from random import randint
import json


def intent(request):
    if randint(0, 1) == 0:
        status_code = 200
        outcome = "OK"
    else:
        status_code = 403
        outcome = "Forbidden"
    return status_code, outcome


def response(request, outcome):
    headers = {"content-type": "application/json"}
    body = json.dumps({"message": outcome}) + "\n"
    return headers, body


app = Flask(__name__)


@app.route("/", methods=["GET"])
@skinny.responses({200: response, 403: response})
@skinny.intent(intent)
def index():
    pass

Detailed Usage

See app.py.

Installation

$ pip install flask-skinny

Contribution

Create new Pull Request.

License

MIT

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-skinny-0.1.2.tar.gz (2.6 kB view hashes)

Uploaded Source

Built Distribution

flask_skinny-0.1.2-py3-none-any.whl (3.5 kB view hashes)

Uploaded Python 3

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