User Guide#

Template Manager#

You can use the Manager class to prepare templates easily, and render them easily.
So, when you use it in the backend of a web service, you should define the Manager class first.

from tempylate import Manager

manager = Manager()

Syntax#

In tempylate, the part of a template enclosed in a two-lettered hat caret is a function and is executed in Python.
This enclosed area is called a block in tempylate.
The block is replaced by the value returned by the block.
In addition, the last line of the block is automatically replaced by return even if you don’t write return.
If you don’t know, it is faster to look at an example.

Example#

html

<title>^^ title ^^</title>
<!-- The one above is equivalent to the one below.
  `<title>^^ return title ^^</title>` -->

python

manager.render_from_file("template.html", title="Hi user guide!")

Result html

<title>Hi user guide!</title>

Of course, you can also do the following: html

<ul>
  ^^ "".join(f"<li>{name}</li>" for name in members) ^^
</ul>

python

manager.render_from_file("template.html", members=("tasuren", "yuki", "kumi"))

Builtins#

A built-in is a variable that can be used from the beginning in a template block.
There are functions and so on.

Template class instance: self
Include another file: include (tempylate.builtins.include)
Python’s standard library textwrap.
Escape text: escape (html.escape)
A constant containing a two-letter cat-halet string: CS (tempylate.builtins.CS)

tempylate is still waiting for a PullRequest in the GitHub repository as there are not many yet.

Inheriting Templates#

In tempylate, you can inherit templates by using the attribute render_from_file of the instance of the Manager class that is automatically passed to the block.
(Or you can use the extends attribute of an instance of the Template class.)

Examples#

base.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>tempylate's website - ^^ title ^^</title>
</head>
<body>
  ^^ main ^^
</body>
</html>

page1.html

^^
  self.manager.render_from_file(
      "base.html", title="tempylate's first page",
      main="""
        <h1>I did it!</h1>
        I made my first webpage.
      """
  )
^^

Make alias for Inheriting Templates#

By using the extends argument and attributes of the Manager class, it is possible to create an alias for manager.render_from_file that inherits from the template.

Examples#

python

manager = Manager()

def blog(title, main, header=""):
    return manager.render_from_file("base.html", title=title, main=main, header="")

manager.builtins["blog"] = blog

html

^^
  blog(
    "title", """
    <h1>Main content</h1>
    """,
    "<script ...></script>"
  )
  # Aliase for `manager.render_from_file(title="title", ...)`
^^

Escape#

If you place the user name and description fields in the template, it is better to escape them to prevent XSS injection.
If you are going to do that escaping, you should do the following:

<div class="description">
  ^^ escape(user.description) ^^
</div>

Yes, you can use the built-in escape function.
The escape function is a function of html, the Python standard library.

Notes#

If you want to automate this escaping, you can use the adjustors argument of the constructor of the Template class.
(If you are using Manager, pass it to Manager.)

Asynchronous Support#

tempylate has good asynchronous support.
There is an aiorender method, so use it.
You can also use await in templates that render asynchronously to allow other asynchronous functions to be rendered asynchronously.

^^ self.user = await app.fetch_user(user_id) ^^

<h1>^^ escape(user.name) ^^'s profile</h1>
<div class="details">^^ escape(user.details) ^^</div>

User Guide#

Template Manager#

Syntax#

Example#

Builtins#

Inheriting Templates#

Examples#

Make alias for Inheriting Templates#

Examples#

Escape#

Notes#

Share variables with other blocks#

Asynchronous Support#