IRIS YANG | 3121357 | 2020-08-18 13:17:02 +0000 | [diff] [blame] | 1 | Jinja |
| 2 | ===== |
| 3 | |
| 4 | Jinja is a fast, expressive, extensible templating engine. Special |
| 5 | placeholders in the template allow writing code similar to Python |
| 6 | syntax. Then the template is passed data to render the final document. |
| 7 | |
| 8 | It includes: |
| 9 | |
| 10 | - Template inheritance and inclusion. |
| 11 | - Define and import macros within templates. |
| 12 | - HTML templates can use autoescaping to prevent XSS from untrusted |
| 13 | user input. |
| 14 | - A sandboxed environment can safely render untrusted templates. |
| 15 | - AsyncIO support for generating templates and calling async |
| 16 | functions. |
| 17 | - I18N support with Babel. |
| 18 | - Templates are compiled to optimized Python code just-in-time and |
| 19 | cached, or can be compiled ahead-of-time. |
| 20 | - Exceptions point to the correct line in templates to make debugging |
| 21 | easier. |
| 22 | - Extensible filters, tests, functions, and even syntax. |
| 23 | |
| 24 | Jinja's philosophy is that while application logic belongs in Python if |
| 25 | possible, it shouldn't make the template designer's job difficult by |
| 26 | restricting functionality too much. |
| 27 | |
| 28 | |
| 29 | Installing |
| 30 | ---------- |
| 31 | |
| 32 | Install and update using `pip`_: |
| 33 | |
| 34 | .. code-block:: text |
| 35 | |
| 36 | $ pip install -U Jinja2 |
| 37 | |
| 38 | .. _pip: https://pip.pypa.io/en/stable/quickstart/ |
| 39 | |
| 40 | |
| 41 | In A Nutshell |
| 42 | ------------- |
| 43 | |
| 44 | .. code-block:: jinja |
| 45 | |
| 46 | {% extends "base.html" %} |
| 47 | {% block title %}Members{% endblock %} |
| 48 | {% block content %} |
| 49 | <ul> |
| 50 | {% for user in users %} |
| 51 | <li><a href="{{ user.url }}">{{ user.username }}</a></li> |
| 52 | {% endfor %} |
| 53 | </ul> |
| 54 | {% endblock %} |
| 55 | |
| 56 | |
| 57 | Links |
| 58 | ----- |
| 59 | |
| 60 | - Website: https://palletsprojects.com/p/jinja/ |
| 61 | - Documentation: https://jinja.palletsprojects.com/ |
| 62 | - Releases: https://pypi.org/project/Jinja2/ |
| 63 | - Code: https://github.com/pallets/jinja |
| 64 | - Issue tracker: https://github.com/pallets/jinja/issues |
| 65 | - Test status: https://dev.azure.com/pallets/jinja/_build |
| 66 | - Official chat: https://discord.gg/t6rrQZH |