Jinja (moteur de template)
Pour les articles homonymes, voir Jinja.
Cet article est une ébauche concernant un logiciel libre.
Vous pouvez partager vos connaissances en l’améliorant (comment ?) selon les recommandations des projets correspondants.
| Développé par | Armin Ronacher (en) |
|---|---|
| Dernière version | 3.1.3 ()[1] |
| Dépôt | github.com/pallets/jinja |
| Écrit en | Python |
| Type |
Bibliothèque logicielle Système de gabarit Bibliothèque logicielle Python (d) Template language (d) |
| Licence | BSD 3-clauses |
| Site web | palletsprojects.com/p/jinja |
Jinja est un moteur de template utilisé par le langage Python. Créé par Armin Ronacher et distribué sous licence BSD, il est très similaire au moteur de template Django mais fournit des expressions Python et évalue les templates dans une sandbox. C'est un langage orienté texte qui peut ainsi être utilisé pour générer n'importe quel type de fichier pouvant être balisé.
Ce moteur permet certaines personnalisations de tags[2], de filtres, de tests, et d'expressions[3]. Cependant contrairement à Django, Jinja permet au développeur d'appeler des fonctions avec des arguments sur des objets. Jinja, comme Smarty, utilise également un système de filtre qui se rapproche du Unix pipeline.
Jinja est basé sur le framework Flask[4] et utilisé par Ansible[5],[6], Trac, et Salt. Il aurait inspiré Twig, le moteur de template de PHP.
Fonctionnalités[modifier | modifier le code]
Voici quelques-unes des fonctionnalités[7] :
- exécution dans un bac à sable
- encodage et filtrage automatique des documents HTML pour se prémunir des attaques de type cross-site scripting (XSS)
- héritage de templates
- Compilation Python "Just in time"
- Pré-compilation en avance des templates (option)
- Debuggage simplifié (les exceptions pointent directement sur la ligne incriminée du template)
- Syntaxe configurable
Exemple[modifier | modifier le code]
Voici un exemple simple de template HTML dont le nommage du fichier doit être suffixé .jinja[8]:
<!DOCTYPE html>
<html>
<head>
<title>{{ variable|escape }}</title>
</head>
<body>
{%- for item in item_list %}
{{ item }}{% if not loop.last %},{% endif %}
{%- endfor %}
</body>
</html>
Le code template :
from jinja2 import Template
with open('example.html.jinja') as f:
tmpl = Template(f.read())
print(tmpl.render(
variable = 'Value with <unsafe> data',
item_list = [1, 2, 3, 4, 5, 6]
))
Le résultat produit :
<!DOCTYPE html>
<html>
<head>
<title>Value with <unsafe> data</title>
</head>
<body>
1,
2,
3,
4,
5,
6
</body>
</html>
Notes et références[modifier | modifier le code]
- « Release 3.1.3 », (consulté le )
- « Extensions », sur Jinja2 Documentation (2.8-dev) (consulté le )
- « Extensions », sur Jinja2 Documentation (2.8-dev) (consulté le )
- R. DuPlain, Instant Flask Web Development, Packt Publishing, (ISBN 978-1-78216-963-5, lire en ligne), p. 30
- (en) Robert Kimani, « Monitor remote systems with Ansible and Jinja2 templates », sur Red Hat, (consulté le )
- « Templating (Jinja2) — Ansible Documentation »
- « Welcome | Jinja2 (The Python Template Engine) », sur palletsprojects.com/p/jinja
- Armin Ronacher, « Template Designer Documentation », sur Jinja2 Documentation (consulté le ) : « A Jinja template doesn’t need to have a specific extension: .html, .xml, or any other extension is just fine. »
- (en) Saeed Mohajeryami, PhD, « Jinja: The Ultimate Tool for Customizable Python Templates », sur bootcamp.uxdesign.cc, (consulté le )
- (en) Kaustubh Gupta, « The Ultimate Guide to Master Jinja Template », sur analyticsvidhya.com, (consulté le )
- (en) Diva Dugar, « Jinja2 Explained in 5 Minutes! », sur codeburst.io, (consulté le )
- (en) Adi Chirilov - Sm0ke, « Jinja Template - Short Introduction and FREE Samples », sur codementor.io, (consulté le )
Liens externes[modifier | modifier le code]
