Cheetah3 Template Engine

3.4.0.post5 · active · verified Sun Apr 12

Cheetah3 is a free and open-source template engine and code-generation tool for Python. It is a fork of the original CheetahTemplate library, designed to compile templates into optimized, readable Python code. It blends Python's power and flexibility with a simple template language. The library is actively maintained and supports Python 2.7 and Python 3.4+.

Warnings

breaking Version 3.0.0 introduced significant breaking changes, including dropping support for Python versions older than 2.7 and requiring recompilation of all previously compiled Cheetah templates.
Fix: Ensure your Python environment meets the minimum requirement (2.7 or >=3.4) and recompile all templates after upgrading to Cheetah3 version 3.0.0 or later.
deprecated The standalone `cheetah-compile` command-line program is deprecated.
Fix: Use `cheetah compile` instead, which provides the same functionality.
gotcha A security issue (arbitrary code execution) was reported. Caution is advised when processing templates from untrusted sources without proper sanitization or sandboxing.
Fix: Always treat templates from untrusted sources as potentially malicious. Implement sandboxing or strict input validation if dynamic template loading is necessary.
gotcha Under Python 3, `Cheetah.ImportHooks` now correctly raises `ModuleNotFoundError` instead of `ImportError` when a module cannot be found. Code that specifically catches `ImportError` for missing template modules might need updating.
Fix: Update exception handling to catch `ModuleNotFoundError` for module-not-found scenarios, especially when dealing with dynamic template imports.

Install

pip install ct3 Install stable version

Imports

Template
```
from Cheetah.Template import Template
```

Quickstart

Demonstrates defining a template string, injecting data via a search list, and rendering the output. It also shows using Python imports and `#set` directives within the template.

from Cheetah.Template import Template
import datetime

# Define a simple template string
template_code = """
#set $current_year = datetime.date.today().year
Hello, $name!
This template was rendered in $current_year using $engine.
"""

# Create a template instance and pass data
t = Template(template_code, searchList=[
    {'name': 'Registry User', 'engine': 'Cheetah3'}
])

# Render the template
output = str(t)
print(output)

view raw JSON →