Skip to main content

Generic interface for Python template engines

Project description

collective.templateengines is an template language backend manager for Python. It defines generic Zope interfaces for communicating with various Python template engines to achieve higher code reuse value.

This package is still much in development. All contributions and comments are welcome.

Features

collective.templateengines helps you to achieve

  • Easy, pluggable, template language switching. Write special tag code only once and use it across all template engines.

  • Clean your codebase from template language dependencies.

  • Generic error and warning reporting mechanism across template engines.

Motivation

All template engines have their shortcomings. Sooner or later you want to try yet another engine, or someone else wants to use another template engine within your project. This package is aimed to make that transition as smooth as possible.

Features

  • egg deployment and easy install support from PyPi repository

  • Interfaces defined using standard Zope interfaces package

  • Backends for Django template Language, Cheetah and Jinja2

  • Unit tests

Installation

  • Install collective.templateengines egg

  • Install any of following template engine eggs: Django, Jinja2, Cheetah

Usage

Please take a look on collective.easytemplate package how to support switching between template engines and registering tags for them.

The following example shows how one can switch between Django and Cheetah template engines with one line of change. Naturally, the templates themselves need to be refactored.

Cheetah:

from collective.templateengines.backends import cheetah

engine = cheetah.Engine()
context = DictionaryContext({"foo":"bar"})
template, syntax_errors = engine.loadString("Show variable $foo", False)
result, evaluation_errors = template.evaluate(context)

Django:

from collective.templateengines.backends import djangotemplates

engine = djangotemplates.Engine()
context = DictionaryContext({"foo":"bar"})
template, syntax_errors = engine.loadString("Show variable {{ foo }}", False)
result, evaluation_errors = template.evaluate(context)

Tags

collective.templateengine uses term tag to refer to functions which you can use in the template engine context. In the future tags are indended to be expanded to cover template language structures as well.

collective.templateengines does not come with any tags out of the box. To define tags, I recommend you to take a look on collective.easytemplate package.

  • Tags provide collective.templateengines.interfaces.ITag interface

  • Tags are registered to the template engine using Engine.addTag() function.

Problems

  • Cheetah architecture lacks separate exposed compiling and evaluating phases

  • Cheetah exposes the full Python namespace to templates by default, making it hard to secure it

  • Cheetah cannot traverse Zope functions or attributes

Examples

Python Template Engines is used in

Authors

Mikko Ohtamaa <mikko.ohtamaa@twinapex.com>

Twinapex Research, Oulu, Finland - High quality Python hackers for hire

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.templateengines-0.3.1.tar.gz (10.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page