woodstove Documentation

API Reference

Woodstove.App

class woodstove.app.App(path, namespace=None, merge=False)
Example:
class MyApp(object):

wsapp = App(‘/foo’)

@wsapp.get(‘/’) def foo(self):

return “foobar”

Initialize this App instance, with the given path, and optionally the given namespace.

Parameters:
  • path – Mount point for this application.
  • namespace –
  • merge – Merge the routes from this app into the parent application.
__dict__ = dict_proxy({'logger': <logging.Logger object at 0x7f6869bbf110>, '__module__': 'woodstove.app', '_load_args': <function _load_args at 0x7f6869b8f410>, 'get': <function get at 0x7f6869b8f668>, '_do_auth': <function _do_auth at 0x7f6869b8f488>, 'route': <function route at 0x7f6869b8f5f0>, 'args': <function args at 0x7f6869b8f848>, 'request': <property object at 0x7f6869b83c58>, 'auth': <function auth at 0x7f6869b8f8c0>, 'server': None, '__dict__': <attribute '__dict__' of 'App' objects>, 'put': <function put at 0x7f6869b8f758>, 'async': <function async at 0x7f6869b8f578>, 'post': <function post at 0x7f6869b8f6e0>, '__weakref__': <attribute '__weakref__' of 'App' objects>, '__doc__': '\n \n :Example:\n\n class MyApp(object):\n wsapp = App(\'/foo\')\n\n @wsapp.get(\'/\')\n def foo(self):\n return "foobar"\n ', '__init__': <function __init__ at 0x7f6869b8f398>, 'delete': <function delete at 0x7f6869b8f7d0>})
__init__(path, namespace=None, merge=False)

Initialize this App instance, with the given path, and optionally the given namespace.

Parameters:
  • path – Mount point for this application.
  • namespace –
  • merge – Merge the routes from this app into the parent application.
__module__ = 'woodstove.app'
__weakref__

list of weak references to the object (if defined)

args(body=None, query=None)
async()

Return a job record that has been passed to a worker

auth(acl=None)
delete(path, **options)
get(path, **options)
logger = <logging.Logger object>
post(path, **options)
put(path, **options)
request
route(path, method, **options)
server = None

Indices and tables