腳本之家服務器常用軟件

快捷導航

python jinjia2的項目使用

更新時間：2023年02月19日 10:07:32 作者：浩浩學習

本文主要介紹了python jinjia2的項目使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

一：模板

要了解jinja2，那么需要先理解模板的概念。模板在Python的web開發(fā)中廣泛使用，

它能夠有效的將業(yè)務邏輯和頁面邏輯分開，使代碼可讀性增強、并且更加容易理解和維護。

模板簡單來說就是一個其中包涵占位變量表示動態(tài)的部分的文件，模板文件在經(jīng)過動態(tài)賦值后，返回給用戶。 --> 可以理解為渲染。

python中自帶一個簡單的模板，就是string提供的。

#第一種方式：${variable} 使用 ${變量名} 大括號包起來
    tempTemplate1 = Template("$My name is ${name} , i like ${fancy}")
    Parma1 = {'name': 'admin', 'fancy': 'python'}
    temp_str1 = tempTemplate1.safe_substitute(Parma1)
    print(temp_str1)
    #執(zhí)行結(jié)果
    '''
        $My name is admin , i like python
    '''

    #第二種方式：$variable 使用 $變量名 引用變量
    tempTemplate2 = Template("$Your name is $name , like $fancy")
    Parma2 = {'name': '張三', 'fancy': 'Java'}
    temp_str2 = tempTemplate2.safe_substitute(Parma2)
    print(temp_str2)
    
    #執(zhí)行結(jié)果：
    '''
        $Your name is 張三 , like Java
    '''

Python自帶的模板功能極其有限，如果我們想要在模板中使用控制語句，和表達式，以及繼承等功能的話，就無法實現(xiàn)了。

目前主流的模板系統(tǒng)，最常用的就是jinja2和mako

二：jinja2介紹

jinja2是Flask作者開發(fā)的一個模板系統(tǒng)，起初是仿django模板的一個模板引擎，為Flask提供模板支持，由于其靈活，快速和安全等優(yōu)點被廣泛使用。

2.1 jinja2的優(yōu)點

jinja2之所以被廣泛使用是因為它具有以下優(yōu)點：

相對于Template，jinja2更加靈活，它提供了控制結(jié)構(gòu)，表達式和繼承等。
相對于Mako，jinja2僅有控制結(jié)構(gòu)，不允許在模板中編寫太多的業(yè)務邏輯。
相對于Django模板，jinja2性能更好。
Jinja2模板的可讀性很棒。

2.2 jinja2安裝

由于jinja2屬于第三方模塊，首先需要對其進行安裝

pip install jinja2

測試模板是否安裝成功

python -c "import jinja2"
 
# 沒有報錯就表示安裝成功
# 必須用雙引號"

三：jinja2語法

作為一個模板系統(tǒng)，它還提供了特殊的語法，我們按照它支持的語法進行編寫之后，就能使用jinja2模塊進行渲染。

3.1 基本語法

在jinja2中，存在三種語法：

控制結(jié)構(gòu) {% %}
變量取值 {{ }}
注釋 {# #}

下面是一個簡單的jinja2例子

{# This is jinja code
 
    {% for file in filenames %}
    ...
    {% endfor %}
 
#}

可以看到，for循環(huán)的使用方式和Python比較類似，但是沒有了句尾的冒號，另外需要使用endfor最為結(jié)尾，其實在jinja2中，if也是一樣的，結(jié)尾需要使用endif。

3.2 jinja2變量

jinja2模板中使用 {{ }} 語法表示一個變量，它是一種特殊的占位符。當利用jinja2進行渲染的時候，它會把這些特殊的占位符進行填充/替換，jinja2支持python中所有的Python數(shù)據(jù)類型比如列表、字段、對象等。

<p>this is a dicectory:{{ mydict['key'] }} </p>
<p>this is a list:{{ mylist[3] }} </p>
<p>this is a object:{{ myobject.something() }} </p>

3.3 jinja2中的過濾器

變量可以通過“過濾器”進行修改，過濾器可以理解為是jinja2里面的內(nèi)置函數(shù)和字符串處理函數(shù)。

常用的過濾器有：

過濾器名稱	說明
safe	渲染時值不轉(zhuǎn)義
capitialize	把值的首字母轉(zhuǎn)換成大寫，其他子母轉(zhuǎn)換為小寫
lower	把值轉(zhuǎn)換成小寫形式
upper	把值轉(zhuǎn)換成大寫形式
title	把值中每個單詞的首字母都轉(zhuǎn)換成大寫
trim	把值的首尾空格去掉
striptags	渲染之前把值中所有的HTML標簽都刪掉
join	拼接多個值為字符串
replace	替換字符串的值
round	默認對數(shù)字進行四舍五入，也可以用參數(shù)進行控制
int	把值轉(zhuǎn)換成整型

那么如何使用這些過濾器呢？只需要在變量后面使用管道(|)分割，多個過濾器可以鏈式調(diào)用，前一個過濾器的輸出會作為后一個過濾器的輸入

{{ 'abc' | captialize  }}
# Abc
 
{{ 'abc' | upper  }}
# ABC
 
{{ 'hello world' | title  }}
# Hello World
 
{{ "hello world" | replace('world','daxin') | upper }}
# HELLO DAXIN
 
{{ 18.18 | round | int }}
# 18

3.4 jinja2的控制結(jié)構(gòu)

jinja2中的for循環(huán)用于迭代Python的數(shù)據(jù)類型，包括列表，元組和字典。在jinja2中不存在while循環(huán)。

3.4.1迭代列表

<ul>
{% for user in users %}
<li>{{ user.username|title }}</li>
{% endfor %}
</ul>

3.4.2 迭代字典

<dl>
{% for key, value in my_dict.iteritems() %}
<dt>{{ key }}</dt>
<dd>{{ value}}</dd>
{% endfor %}
</dl>

當然也可以加入else語句，在循環(huán)正確執(zhí)行完畢后，執(zhí)行

3.4.3 if語句使用

if條件判斷語句必須放在{% if statement %}中間，并且還必須有結(jié)束的標簽{% endif %}。和python中的類似，

可以使用>，<，<=，>=，==，!=來進行判斷，也可以通過and，or，not，()來進行邏輯合并操作

{% if name==1 %}                    <!--name的值是否等于1-->
<h1>恭喜，您抽中了一等獎！</h1>        <!--name的值等于1，顯示本行h1代碼-->
{% elif name==2 %}                    <!--name的值是否等于2-->
<h1>恭喜，您抽中了二等獎！</h1>
{% else %}                            <!--name的值是否等于其他-->
<h1>恭喜，您抽中了三等獎！</h1>
{% endif %}                            <!--結(jié)束if語句-->

在for循環(huán)中，jinja2還提供了一些特殊的變量，用以來獲取當前的遍歷狀態(tài)：

變量	描述
loop.index	當前迭代的索引（從1開始）
loop.index0	當前迭代的索引（從0開始）
loop.first	是否是第一次迭代，返回bool
loop.last	是否是最后一次迭代，返回bool
loop.length	序列中的項目數(shù)量
loop.revindex	到循環(huán)結(jié)束的次數(shù)（從1開始）
loop.revindex0	到循環(huán)結(jié)束的次數(shù)(從0開始）

3.5 jinja2的宏

宏類似于Python中的函數(shù)，我們在宏中定義行為，還可以進行傳遞參數(shù)，就像Python中的函數(shù)一樣一樣兒的。

在宏中定義一個宏的關(guān)鍵字是macro，后面跟其宏的名稱和參數(shù)等

{% macro input(name,age=18) %}   # 參數(shù)age的默認值為18
 
 <input type='text' name="{{ name }}" value="{{ age }}" >
 
{% endmacro %}

調(diào)用方法也和Python的類似

<p>{{ input('daxin') }} </p>
<p>{{ input('daxin',age=20) }} </p>

3.6 jinja2的繼承和Super函數(shù)

jinja2中最強大的部分就是模板繼承。模板繼承允許我們創(chuàng)建一個基本(骨架)文件，其他文件從該骨架文件繼承，然后針對自己需要的地方進行修改。

jinja2的骨架文件中，利用block關(guān)鍵字表示其包涵的內(nèi)容可以進行修改。

以下面的骨架文件base.html為例：

<!DOCTYPE html>
<html lang="en">
<head>
    {% block head %}
    <link rel="stylesheet" href="style.css" rel="external nofollow" />
    <title>{% block title %}{% endblock %} - My Webpage</title>
    {% endblock %}
</head>
<body>
<div id="content">{% block content %}{% endblock %}</div>
<div id="footer">
    {% block  footer %}
    <script>This is javascript code </script>
    {% endblock %}
</div>
</body>
</html>

這里定義了四處 block，即：head，title，content，footer。那怎么進行繼承和變量替換呢？注意看下面的文件

{% extend "base.html" %}       # 繼承base.html文件
 
{% block title %} Dachenzi {% endblock %}   # 定制title部分的內(nèi)容
 
{% block head %}
    {{  super()  }}        # 用于獲取原有的信息
    <style type='text/css'>
    .important { color: #FFFFFF }
    </style>
{% endblock %}   
 
# 其他不修改的原封不同的繼承

PS: super()函數(shù) 表示獲取block塊中定義的原來的內(nèi)容。

四：利用jinja2進行渲染

jinja2模塊中有一個名為Enviroment的類，這個類的實例用于存儲配置和全局對象，然后從文件系統(tǒng)或其他位置中加載模板。

4.1基本使用方法

大多數(shù)應用都在初始化的時候撞見一個Environment對象，并用它加載模板。Environment支持兩種加載方式：

PackageLoader：包加載器
FileSystemLoader：文件系統(tǒng)加載器

4.2 PackageLoader

使用包加載器來加載文檔的最簡單的方式如下：

from jinja2 import PackageLoader,Environment
env = Environment(loader=PackageLoader('python_project','templates'))    # 創(chuàng)建一個包加載器對象
 
template = env.get_template('bast.html')    # 獲取templates文件下的一個模板文件

#第一種方法渲染 直接傳入字典 （推薦第一種）
template.render(**{"name":"admin", "age":18})   # 渲染

#第二種方法 以key=value的方式
template.render(name='admin',age=18)   # 渲染

其中：

PackageLoader()的兩個參數(shù)為：python包的名稱，以及模板目錄名稱。
get_template()：獲取模板目錄下的某個具體文件。
render()：接受變量，對模板進行渲染

4.3 FileSystemLoader

文件系統(tǒng)加載器，不需要模板文件存在某個Python包下，可以直接訪問系統(tǒng)中的文件

import os
from jinja2 import PackageLoader, Environment, FileSystemLoader
path_dir = "/mnt/e/files" #模板文件所在的絕對路徑
loader = FileSystemLoader(searchpath=path_dir)
env = Environment(loader=loader)
template = env.get_template("index.opf") # 模板文件
buf = template.render(name="daxin", age=18)
with open(os.path.join("path_dir", "index.opf"), "w" ) as fp:
  fp.write(buf)

其中：