pyramid_controllers 0.3.19

A pyramid plugin that provides de-centralized hierarchical object dispatch.

System Message: ERROR/3 (<string>, line 16)

Unknown directive type "code-block".

.. code-block:: bash

  $ pip install pyramid-controllers

System Message: ERROR/3 (<string>, line 22)

Unknown directive type "code-block".

.. code-block:: python

  # the following application serves these URLs:
  #   /
  #   /about/team
  #   /about/mission
  #   /resource/{RESOURCE_ID}   (RESTful: GET and PUT)

  # standard pyramid-controller imports
  from pyramid_controllers import \
    Controller, RestController, \
    expose, expose_defaults, index, default, lookup, fiddle

  # create a controller for "/about/team" and "/about/mission"
  class AboutController(Controller):
    @expose(renderer='mymodule:path/to/template.mako')
    def team(self, request): return dict(team=get_team_members())
    @expose
    def mission(self, request): return 'Our mission: rock the world.'

  # create a RESTful (GET, PUT) controller for "/resource/{RESOURCE_ID}"
  class ResourceController(RestController):
    @expose
    def get(self, request): return 'Name: ' + request.res.name
    @expose
    def put(self, request):
      request.res.name = request.params.get('name')
      return self.get(request)

  # create the dispatcher that will lookup resources by ID
  class ResourceDispatcher(Controller):
    RESOURCE_ID = ResourceController(expose=False)
    @lookup
    def lookup(self, request, res_id, *rem):
      request.res = get_resource_by_id(res_id)
      return (self.RESOURCE_ID, rem)

  # the root controller with support for "/" and sub-controllers
  class RootController(Controller):
    about = AboutController()
    resource = ResourceDispatcher()
    @index
    def index(self, request):
      return HTTPFound('/about/mission')

  # and hook it all into pyramid in the app's main()
  def main(global_config, **settings):
    # ... (the usual pyramid startup calls) ...
    config.include('pyramid_controllers')
    config.add_controller('root', '/', RootController())

System Message: ERROR/3 (<string>, line 79)

Unknown directive type "code-block".

.. code-block:: bash

  $ pip install pyramid-controllers

System Message: ERROR/3 (<string>, line 90)

Unknown directive type "code-block".

.. code-block:: text

  pyramid.includes = pyramid_controllers

System Message: ERROR/3 (<string>, line 96)

Unknown directive type "code-block".

.. code-block:: python

  def main(global_config, **settings):
    # ...
    config.include('pyramid_controllers')
    # ...

System Message: ERROR/3 (<string>, line 113)

Unknown directive type "code-block".

.. code-block:: python

  def main(global_config, **settings):
    # ...
    config.include('pyramid_controllers')
    # ...
    config.add_controller('rootController', '/root', '.controllers.RootController')
    # ...

System Message: ERROR/3 (<string>, line 137)

Unknown directive type "code-block".

.. code-block:: python

  from pyramid_controllers import Controller, expose

  # NOTE: These classes are defined in order of semantic use. For this
  #       to actually work, the controllers would need to be defined
  #       before they are invoked (so in opposite order), of course.

  class RootController(Controller):
    how = HowController()

  class HowController(Controller):
    are = AreController()

  class AreController(Controller):
    @expose
    def you(self, request):
      return 'A-OK!'

System Message: ERROR/3 (<string>, line 192)

Unknown directive type "code-block".

.. code-block:: python

  from pyramid_controllers import Controller, RestController

  class RootController(Controller):
    hello = ReflectController()

  class ReflectController(RestController):
    @expose
    def get(self, request):
      return 'I am *not* a dog, go GET it yourself!'
    @expose
    def put(self, request):
      return 'Apparently you golf. PUTting is just part of the game.'
    @expose
    def post(self, request):
      return 'People use email today, silly. Stop using the POST!'
    @expose
    def delete(self, request):
      return 'Hey! This is not the CIA, you cannot just DELETE me!'

System Message: ERROR/3 (<string>, line 263)

Unknown directive type "code-block".

.. code-block:: python

  from pyramid.httpexceptions import HTTPForbidden, HTTPNotFound

  # import the controller base classes
  from pyramid_controllers import Controller, RestController

  # import the decorators
  from pyramid_controllers import expose, index, lookup, default, fiddle

  class RootController(Controller):
    public = PublicController()
    admin  = AdminController()
    member = MemberDispatchController()

  class PublicController(Controller):
    login = AuthController()
    @expose
    def about(self, request):
      return 'We are a snazy company!'

  class AuthController(RestController):
    @expose
    def get(self, request):
      return '<html><form><input name="u"/><input name="p"/></form></html>'
    @expose
    def post(self, request):
      # todo: perform authentication...

  class AdminController(Controller):
    @fiddle
    def checkAuth(self, request):
      if userHasAdminAccess(request): return
      raise HTTPForbidden()
    @index
    def index(self, request):
      return 'View the list of <a href="users">active users</a>.'
    @expose
    def users(self, request):
      return '<ul><li>you</li></ul>'

  class MemberDispatchController(Controller):
    @fiddle
    def checkAuth(self, request):
      if userHasMemberAccess(request): return
      raise HTTPForbidden()
    @lookup
    def _lookup(self, username, *rem):
      user = findUserByUsername(username)
      if not user:
        raise HTTPNotFound()
      return (MemberController(user), rem)

  class MemberController(Controller):
    def __init__(self, user):
      self.user = user
    @index
    def index(self, request):
      return 'Hi, my name is ' + self.user.name
    @expose
    def age(self, request):
      return 'I am %d years old.' % (self.user.age,)
    @default
    def _default(self, request, attribute, *rem):
      return 'My "%s" is "%r".' % (attribute, getattr(self.user, attribute))