Flask-Holster 0.3

Rigid MVC content negotiation for Flask

This is Holster, an extension for Flask that makes RESTfulness and content negotiation easy:

from flask import Flask
from flask.ext.holster.main import init_holster

app = Flask(__name__)
init_holster(app)

@app.holster("/test")
def test():
    from math import pi

    return {
        "data": "Hello from Holster!",
        "nested": {
            "numeric": 0,
            "floating": pi,
            "unicode": u"Espa\xf1ol",
        },
        "secure": {
            "xss-sword": ';!--"<XSS>=&{()}',
        }
    }

if __name__ == "__main__":
    app.run()

This application will automatically figure out which data type to return, using a combination of user agent parameters and URL extensions. If a user agent requests “/test.html” they will get HTML, but if they request “/test.json” they will get JSON instead. No longer do you have to worry about constructing sites with separate interfaces for HTML and JSON; one holstered site can do it all!

Holster currently has default renderers for the following formats:

• HTML

• JSON

• Plaintext

• YAML (with optional PyYAML support for prettified YAML)

Users can also override renderers for any format or MIME type they would like, with with_template:

from my_sweet_website import PNGHeaderMaker
from flask.ext.holster.views import with_template

@app.holster("/customized")
@with_template("image/png", PNGHeaderMaker)
def custom():
    return {"header": "Welcome to my site!"}

Changelog

0.3

• Compatibility: Require vcversioner for version numbers.

• Compatibility: The handwritten MIME parser has been removed in favor of the one in Werkzeug. As a result, Flask-Holster is slightly smaller and should handle corner cases slightly better.

• Bugfix: Always define a YAML conversion. For pretty YAML, install PyYAML. YAML output is now always enabled, using JSON as a fallback when PyYAML is not available. PyYAML is not required and is not in the requirements.txt.

0.2.5

• Feature: init_holster() now works on Flask blueprints as well as Flask applications.

0.2.4

• Bugfix: Correctly omit trailing colons (and related recursion) on list items in the default HTML view template.

0.2.3

• Bugfix: Permit kwargs in routing decorators, including methods.

• Bugfix: Pass along premade responses as-is without any interference. Permits things like redirect() inside otherwise-rigid controllers.

0.2.2

• Bugfix: Pass along names inside lift() to correctly name reversed routes

0.2.1

• Bugfix: Specialize extended routes for “/” to avoid malformed routes

0.2

• Compatibility: Don’t use itertools, for Python 2.5

• Enhancement: Split holsterizing views into two pieces, for easier customization

• Feature: New helpers module for helping write customized views

1.1.2

• Feature: Changelog

• Feature: Documentation

• Feature: Optional HOLSTER_COMPRESS setting for automatically compressing response data

• Enhancement: Vary header is filled out

• Change: Improved names of view objects