Configuration

To configure a template renderer for your application, you need to choose a backend and then specify any necessary configuration values for it. The following backends are provided out of the box:

• django
• jinja2
• mako
• tonnikala
• tornado

Other backends may be provided by other components.

Once you’ve selected a backend, see its specific documentation to find out what configuration values you need to provide, if any. Configuration values are expressed as constructor arguments for the backend class:

components:
  templating:
    backend: mako
    package_paths:
      - myapp.somepackage/templates

This configuration publishes a asphalt.templating.api.TemplateRenderer lazy resource named default using the Mako backend, accessible as ctx.mako. The renderer will look for templates in the templates subdirectory of the myapp.somepackage package.

The same can be done directly in Python code as follows:

class ApplicationComponent(ContainerComponent):
    async def start(ctx: Context):
        self.add_component('templating', backend='mako',
                           package_paths=['myapp.somepackage/templates'])
        await super().start()

Multiple renderers

If you need to configure multiple renderers, you can do so by using the renderers configuration option:

components:
  templating:
    renderers:
      django:
        package_paths:
          - myapp.somepackage/templates/django
      jinja2:
        package_name: myapp.somepackage
        package_path: templates/jinja2
      mako:
        package_paths:
          - myapp.somepackage/templates/mako
      tonnikala:
        package_paths:
          - myapp.somepackage/templates/tonnikala
      tornado:
        package_path: myapp.somepackage/templates/tornado
      foobar:
        backend: jinja2
        context_attr: foo
        package_name: myapp.somepackage
        package_path: templates/jinja2

The above configuration creates 5 lazy resources of type asphalt.templating.api.TemplateRendererProxy:

• django as ctx.django
• jinja2 as ctx.jinja2
• mako as ctx.mako
• tonnikala as ctx.tonnikala
• tornado as ctx.tornado
• foobar as ctx.foo