lribeiro.cherrypy.templating

Template rendering tool for cherrypy


Keywords
templating, cherrypy, mako, jinja2, pystache, cheetah, genshi
License
BSD-3-Clause
Install
pip install lribeiro.cherrypy.templating==1.0.1

Documentation

lribeiro.cherrypy.templating

Template rendering tool for cherrypy.

It does not render any template, so you must provide a renderer for your template system to do the actual rendering.

The renderer must be a callable accepting two arguments:

  • The name of the template to be rendered
  • A context object, which can be a dict or any other object that your template system can handle

The template name comes from the @template decorator argument and the context is the value return from the handler.

Renderer parameters

You can optionally pass parameters to your renderer function by just passing additional arguments to the @template decorator

class Controller:
    @cherrypy.expose
    @template('template_name', 'some arg', some='keyword arg')
    # pass your additional parameters here
    def handler():
        pass

def renderer(template_name, context, *args, **kwargs):
    # and do something with the parameters here
    pass

Developed under Python3.4 and tested against Python2.7, Python3.4 and pypy.

Usage:

from os import path

import cherrypy
import pystache

from lribeiro.cherrypy.templating import template


def _renderer(template_name, context):
    """
    Template renderer using Pystache
    """

    search_dir = path.join(path.dirname(path.abspath(__file__)), 'templates')
    renderer = pystache.Renderer(file_extension='html', search_dirs=search_dir)

    template_str = renderer.load_template(template_name)
    return renderer.render(template_str, context)


class Root:
    @cherrypy.expose
    @template('index')
    def index(self):
        return {'name': 'Lorem', 'lastname': 'Ipsum'}

    @cherrypy.expose
    @template('page')
    def page(self):
        return {'name': 'Lorem', 'lastname': 'Ipsum'}

    @cherrypy.expose
    @template('page_with_args', 'some', 'arg')
    def page_with_args(self):
        return {'name': 'Lorem', 'lastname': 'Ipsum'}

    @cherrypy.expose
    @template('page_with_kwargs', some='keyword arg')
    def page_with_kwargs(self):
        return {'name': 'Lorem', 'lastname': 'Ipsum'}


config = {
    '/': {
        'templating.renderer': _renderer,
    }
}

if __name__ == '__main__':
    cherrypy.quickstart(Root(), '/', config)