Template engine abstraction layer for Python
Project description
collective.templateengines is an template engine abstraction layer 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 template tag code only once and use it across all template engines using abstracted tag plug-ings
Clean your codebase from template engine dependencies
Generic error and warning reporting mechanism across template engines
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
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.
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)
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
Easy Template product for Plone.
Links
Source code
Changelog
0.3.5 (2013-05-07)
first import for plone 4.3 [vangheem]
0.3.2 - 0.3.4
Fixed various problems when context or HTTP request was not available or they were “special” in Plone templates [miohtama]
Fixed compatibility issues with LinguaPlone [miohtama]
0.3.1 - 0.3.2
Fixed unicode problems with Archetypes accessors
Documentation clean ups
0.3.0 - 0.3.1
Fixed problem in plone.py with problematic Archetypes schema fields
0.1.1 - 0.3.0
Major rework
0.1 - 0.1.1
Fixing PyPi deployment problems
0.1
Initial release
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
Hashes for collective.templateengines-0.3.5.zip
Algorithm | Hash digest | |
---|---|---|
SHA256 | 126f85710bc56b7b04125308341d82077721205df8c9815010eea672b66d52d7 |
|
MD5 | 2f7a3108640c06d506cc7595d6a60e93 |
|
BLAKE2b-256 | fdfbb918f362361ffe5fd8e15c926b75e8697f6218c010d586997928ae20e2ec |