Skip to main content

Piglet templates: fast, HTML aware templating engine

Project description

Piglet is a text and HTML templating language in the kid/genshi/kajiki family.

Documentation | Bitbucket repository

The Piglet template engine offers:

  • Template inhertitance through py:extends/py:block (similar to Jinja2)

  • Compiles templates to fast python byte code.

  • HTML aware templating: output is well formed and content is escaped, preventing XSS attacks.

  • Reusable template functions, deep nesting of template inheritance, flexible translations and embedded python expressions

This is what a piglet template looks like:

<py:extends href="layout.html">

    <py:block name="content">
        <h1>This is the content block.</h1>
            Hello $user.firstnames $user.lastname!

          The following paragraph is marked for translation.

          The i18n:name attribute substitues the python code interpolation
          with a simple placeholder, so translators see this message:

            'Today is ${day}'
        <p i18n:message="">
          Today is <span i18n:name="day">${date.strftime('%a')}</span>.

        <p py:choose="today.weekday()">
            <py:when test="0">
                I don't like Mondays
            <py:when test="day == 4">
                I never could get the hang of Thursdays
            <py:otherwise>Is it the weekend yet?</py:otherwise>

        <p py:for="verse in in poem">
            <py:for each="line in verse">$line<br/></py:for>


There’s a text templating mode too:

Hello $user.firstnames $user.lastname!

{% trans %}
Today is {% transname "day" %}${date.strftime('%a')}{% end %}
{% end %}.

{% for verse in poem %}
    {% for line in verse %}$line
    {% end %}
{% end %}


To install the latest release using pip (recommended):

pip install piglet

To install the latest source:

hg clone cd piglet python install

Using Piglet templates from the Python API

A simple example of rendering a python string to a template:

from piglet import HTMLTemplate

template = HTMLTemplate('<p>$greeting</p)')
print(template.render({'greeting': 'Bonjour!'}))

Loading templates from disk:

from piglet import TemplateLoader

loader = TemplateLoader(['./templates/'])
template = loader.load('mytemplate.html')
print(template.render({'greeting': 'Hello!'})

A fully loaded example:

from piglet import TemplateLoader
import gettext

loader = TemplateLoader(
    # List of directories to search for template files

    # Auto reload templates when files are modified? Defaults to False,
    # use True for development

    # The template class to use - either HTMLTemplate or TextTemplate

    # File encoding to use by default

    # A persistent on disk cache for piglet templates

    # A factory function returning a gettext Translations instance
    # or compatible object. For example Django users could plug in
    # `lambda: django.utils.translation`. If your app isn't translated
    # omit this argument.
    translations_factory=lambda: gettext.translation(...),

template = loader.load('mytemplate.html', encoding='UTF-8')

Templates can also be rendered as a stream. This might be useful for generating long documents that you don’t want to hold in memory all at once:

template = loader.load('huge.html', encoding='UTF-8')
for s in template({'data': load_massive_dataset()}):


The layout template should be marked up with <py:block> tags to indicate customization points:

<!DOCTYPE html>
    <title py:block="title">Default title</title>
    <py:block name="content">
    Content goes here

Child templates then use <py:extends href="..."> to pull in the parent’s layout.

You can also define template functions:

<!--! File: widgets.html
<py:def function="modal(content, title='hello')">
    <div class="modal">
        <div class="modal-dialog">
            <div class="modal-content">
                <div class="modal-header">
                    <button type="button" data-dismiss="modal">X</button>
                    <h4 class="modal-title">$title</h4>
                <div class="modal-body">
                    ${content() if callable(content) else content}
                <div class="modal-footer">
                    <button type="button">Close</button>
                    <button type="button">Save changes</button>

Template functions can be imported into other templates:

<py:import href="widgets.html" alias="widgets"/>
    ${widgets.modal(content="Hello world!")}

Did you notice the ${content() if callable content else content} interpolation in the function body? That’s to support py:call, which can pass chunks of template code as keyword arguments:

<py:call function="widgets.modal(fullpage=True)">
    <py:keyword name="content">
        This is the modal content. You can include
        <a href="#">markup here</a> too!


Piglet is licensed under the Apache license version 2.0.


  • Bugfix: fixed scoping issue when a variable name was previously used in the argument list of a <py:def> directive

0.4.2 (released 2016-11-08)

  • Added <py:comment> directive

  • Exceptions are now reraised, ensuring the originating traceback is shown.

  • <py:call> Now passes its inner HTML as a positional argument, unless it is whitespace.

  • <py:call> is now an inner directive, meaning that <p py:call=”foo()”></p> will now fill the <p> element rather than replacing it.

  • The loader cache directory may be specified via the PIGLET_CACHE environment variable.

  • Added i18n:comment directive

0.4.1 (released 2016-10-17)

  • Added {% def %} and {% for %} text template directives

  • Added allow_absolute_paths option to TemplateLoader

0.4 (released 2016-10-16)

  • Bugfix: ensure py:else directives are always attached to the correct py:if

  • Added i18n:trans as an alias for i18n:translate

  • i18n:name directives now have a shorter alias (i18n:s, for substitution) and can take an optional expr attribute, eg <i18n:s name="foo" expr="calculate_foo()"/>

  • Interpolations in translated strings are now extracted using the interpolation text as a placeholder in the absence of a i18n:name directive

  • py:whitespace=”strip” no longer strips whitespace between tags on the same line.

  • Text template directives now include {% with %}, {% extends %} and {% block %}

  • <py:extend> can now be used to load a template of the same name elsewhere on the template search path.

  • The search algorithm used by TemplateLoader is improved

  • Bugfix: fix for duplicate rendering when super() is used in the middle of the inheritance chain

  • Generated code uses “yield from” where it is supported by the python version

  • The caching code has been simplified, caching .py files to disk containing the compiled python source.

  • Bugfix: py:attrs no longer raises an exception

  • Bugfix: interpolations can now contain entity references

0.3 (released 2016-10-03)

  • The translation code now normalizes whitespace in i18n:messages

  • Bugfix: fixed extraction of translations within <py:else> blocks

  • Added translation support in text templates

0.2 (released 2016-10-02)

  • Bugfix: ensure that grammar files are included in binary distributions

  • Bugfix: fix for undefined variable error when using py:with to reassign a variable

0.1 (released 2016-10-01)

  • 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

piglet-0.4.2.tar.gz (50.1 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