klein.app.Klein

Undocumented

Get an instance of Klein bound to instance.

Undocumented

Undocumented

Execute the named endpoint with all arguments and possibly a bound instance.

Execute the passed error handler, possibly with a bound instance.

Register an error handler. This decorator supports two syntaxes. The simpler of these can be used to register a handler for all Exception types:

    @app.handle_errors
    def error_handler(request, failure):
        request.setResponseCode(500)
        return 'Uh oh'

Alternately, a handler can be registered for one or more specific Exception types:

    @app.handle_errors(EncodingError, ValidationError):
    def error_handler(request, failure)
        request.setResponseCode(400)
        return failure.getTraceback()

The handler will be passed a twisted.web.server.Request as well as a twisted.python.failure.Failure instance. Error handlers may return a deferred, a failure or a response body.

If more than one error handler is registered, the handlers will be executed in the order in which they are defined, until a handler is encountered which completes successfully. If no handler completes successfully, twisted.web.server.Request's processingFailed() method will be called.

In addition to handling errors that occur within a KleinRouteHandler, error handlers also handle any werkzeug.exceptions.HTTPException which is raised during request routing.

In particular, werkzeug.exceptions.NotFound will be raised if no matching route is found, so to return a custom 404 users can do the following:

    @app.handle_errors(NotFound)
    def error_handler(request, failure):
        request.setResponseCode(404)
        return 'Not found'

Return an IResource which suitably wraps this app.

Add a new handler for url passing args and kwargs directly to werkzeug.routing.Rule. The handler function will be passed at least one argument an twisted.web.server.Request and any keyword arguments taken from the url pattern.

:

    @app.route("/")
    def index(request):
        return "Hello"

Run a minimal twisted.web server on the specified port, bound to the interface specified by host and logging to logFile.

This function will run the default reactor for your platform and so will block the main thread of your application. It should be the last thing your klein application does.

Within this block, @route adds rules to a werkzeug.routing.Submount.

This is implemented by tinkering with the instance's _url_map variable. A context manager allows us to gracefully use the pattern of "change a variable, do some things with the new value, then put it back to how it was before.

Named "subroute" to try and give callers a better idea of its relationship to @route.

Usage: :

    with app.subroute("/prefix") as app:
        @app.route("/foo")
        def foo_handler(request):
            return 'I respond to /prefix/foo'

Undocumented