Chevron Mustache Templating

0.14.0 · active · verified Thu Apr 09

Chevron is a lightweight, pure-Python implementation of the Mustache templating language. It provides a simple API for rendering templates using dictionaries or objects as data contexts. It adheres closely to the Mustache specification. The current version is 0.14.0, and it generally follows an as-needed release cadence for bug fixes and minor improvements, with long periods of stability.

Warnings

breaking Python 2 support was dropped in Chevron version 0.13.0. Attempts to use chevron on Python 2.x environments will result in errors.
Fix: Upgrade to Python 3.6+ to use Chevron 0.13.0 or newer. For Python 2 compatibility, you would need to pin chevron to <0.13.0, though this is not recommended due to Python 2's end-of-life.
breaking The mechanism for resolving partials changed significantly in version 0.11.0. The `path` parameter for specifying partial locations was renamed to `partials_path` and partials are now resolved via a template loader.
Fix: If upgrading from <0.11.0 and using partials, ensure you update your `render` calls to use `partials_path` and verify that your partials are correctly located and resolved by the new loader mechanism. Consult the documentation for the `partials_path` parameter.
gotcha Mustache's definition of 'falsy' for sections (e.g., `{{#section}}`) differs from Python's default behavior. In Mustache, `0` (the number zero) is considered 'truthy' for sections, while an empty list `[]` is 'falsy'. This can be counter-intuitive for Python developers used to `bool(0)` being `False`.
Fix: Be aware of Mustache's truthiness rules for sections when preparing your data context. If you need a section not to render when a value is `0`, you might need to transform your data (e.g., replace `0` with `None` or an empty string) before passing it to `chevron.render()`.

Install

pip install chevron Install stable version

Imports

render

import chevron
output = chevron.render(template=..., data=...)

Quickstart

Render a Mustache template string with provided data. Chevron handles basic variables, sections, and lists according to the Mustache specification.

import chevron

template_string = 'Hello, {{name}}! You are {{age}} years old.'
data_context = {'name': 'World', 'age': 42}

rendered_output = chevron.render(template=template_string, data=data_context)
print(rendered_output)

# Example with a list and conditional section
template_list = 'Users:\n{{#users}}- {{name}} (ID: {{id}})\n{{/users}}'
data_list = {'users': [{'name': 'Alice', 'id': 1}, {'name': 'Bob', 'id': 2}] }
rendered_list = chevron.render(template=template_list, data=data_list)
print(rendered_list)

view raw JSON →