Jinja2基本知识与实操(文字版) python

[toc]
Jinja2

用jinja2来生成标准的配置模板.

文章图片

实验环境说明：

python版本：3.6.9
jinja2版本：2.11.2
python IDE：pycharm

安装

python -m pip install Jinja2

基本语法

定义变量
格式说明：左右双花括号

logging host {{ log_server }}
if条件控制
格式说明：花括号和百分号组合，if开始，endif结束。

{# 伪代码 #} {% if vendor == 'cisco' %} logging host {{ log_server }} {%elif vendor == 'huawei' %} info-center loghost {{ log_server }} {%else %} pass {% endif %}
【Jinja2基本知识与实操(文字版)】for循环
格式说明：花括号和百分号组合，for开始，endfor结束。

{# 伪代码 #} {% for log_server in server %} {% if vendor == 'cisco' %} logging host {{ log_server }} {%elif vendor == 'huawei' %} info-center loghost {{ log_server }} {%else %} pass {% endif %} {% endfor %}

还可以结合range()函数

{%- for i in range(1, 11) -%} 序号 {{ i }} {% endfor%}
空白符
格式说明：在百分号的前面或后面加-，下面举例看清楚咯，可以去除前后的空白块。

{# 去掉左边空白符 #} {%- for server in servers %}{# 去掉右边边空白符 #} {% for server in servers -%}

示例1：简单的栗子

fromjinja2 import Templatetpl = Template(source="欢迎关注-{{name}}-公众号.") print(tpl.render(name="点滴技术"))# 运行结果如下所示：欢迎关注-点滴技术-公众号.

说明：Template是一个类，将字符串作为参数传给source，source不写也行，然后通过render()渲染，render可以把参数传到template变量中去。
示例2：调用模板文件

创建新的文件夹，在文件夹里新建文件first.conf.tpl：
文件路径："templates\first.conf.tpl"

This first Jinja2 template!
创建python文件render_template.py

# 导入两个类 from jinja2 import FileSystemLoader, Environment# 加载模板文件夹 loader = FileSystemLoader(searchpath='templates') # 环境对象 enviroment = Environment(loader=loader) # 指定模板文件 tpl = enviroment.get_template('first.conf.tpl') # 渲染模板 output = tpl.render() print(output)

说明：FileSystemLoader可以支持传入列表，支持多个文件夹。
执行python 脚本:

(py376) [root@localhost Jinja2_t]# python render_template.py This first Jinja2 template!

示例3：传变量渲染

在templates目录下新建模板文件vars.conf.tpl

logging host {{ data.ip }}
新建python文件vars.py

from jinja2 import FileSystemLoader, Environmentloader = FileSystemLoader('templates') environment = Environment(loader=loader) tpl = environment.get_template('vars.conf.tpl') data = https://www.it610.com/article/{'ip': '1.1.1.1'} output = tpl.render(data=https://www.it610.com/article/data) print(output)

执行结果如下：

(py376) [root@localhost Jinja2_t]# python vars.py logging host 1.1.1.1

示例4：渲染的模板写入文件

在templates目录下新建模板文件vars.conf.tpl

logging host {{ data.ip }}
新建python文件save_to_file.py

from jinja2 import FileSystemLoader, Environmentloader = FileSystemLoader('templates') env = Environment(loader=loader) tpl = env.get_template('vars.conf.tpl') data = https://www.it610.com/article/{'ip': '1.1.1.1'} # print(tpl.render(data=https://www.it610.com/article/data))# 方法1: render() with open('cisco_logging.conf', 'w') as f: f.write(tpl.render(data=https://www.it610.com/article/data)) # 方法2:stream() # tpl.stream(data=data).dump('cicso_logging.conf')

说明：stream()返回的是一个模板流对象，通过dump()方法建流写入文件中。
执行脚本，结果如下：

(py376) [root@localhost Jinja2_t]# python save_to_file.py (py376) [root@localhost Jinja2_t]# more cisco_logging.conf logging host 1.1.1.1

示例5：生成ACL配置模板

在templates目录下新建模板文件acl.conf.tpl

{% for host in disallowed -%} access-list 20 deny host {{ host }} {% endfor -%}{% for host in allowed -%} access-list 20 permit host {{ host }} {% endfor -%}line vty 0 4 access-class 20 in
新建python文件jinja_loops.py

from jinja2 import FileSystemLoader, Environmentallowed = ['192.168.1.1', '192.168.1.2', '192.168.1.3'] disallowed = ['192.168.2.1', '192.168.2.2', '192.168.2.3']loader = FileSystemLoader('templates') env = Environment(loader=loader,trim_blocks=True) tpl = env.get_template('acl.conf.tpl') output = tpl.render(allowed=allowed, disallowed=disallowed) print(output)

说明：trim_blocks=True，可以把新行的空白块删除，默认为False，也可以结合在jinja2模板增加-删除多余空白块。
执行脚本，结果如下:

(py376) [root@localhost Jinja2_t]# python jinja_loops.py access-list 20 deny host 192.168.2.1 access-list 20 deny host 192.168.2.2 access-list 20 deny host 192.168.2.3 access-list 20 permit host 192.168.1.1 access-list 20 permit host 192.168.1.2 access-list 20 permit host 192.168.1.3 line vty 0 4 access-class 20 in

示例6：生成接口配置模板

在templates目录下新建模板文件ports.conf.tpl

{% for port in ports -%} interface {{ port['type'] }} {{ port['slot'] }}/{{ port['port_num'] }} {%- if port['intf_type'] == "access" %} switchport mode {{ port['intf_type'] }} switchport access vlan {{ port['vlan'] }} {%- endif %}{%- if port['intf_type'] == "trunk" %} switchport mode {{ port['intf_type'] }} switchport trunk allowed vlan add {{ port['vlan'] }} {%- endif %} {% endfor -%}

说明：在jinja2这里，字典取值方式port['type']和port.type都可以使用，效果是一样的.
新建python文件jinja_loops.py

from jinja2 import FileSystemLoader, Environmentports = [{ "type": "ethernet", "slot": 1, "port_num": 1, "intf_type": "access", 'vlan': 10 }, { "type": "ethernet", "slot": 1, "port_num": 2, "intf_type": "trunk", 'vlan': 20 }]loader = FileSystemLoader('templates') env = Environment(loader=loader) tpl = env.get_template('ports.conf.tpl') output = tpl.render(ports=ports) print(output)

执行脚本，结果如下:

(py376) [root@localhost Jinja2_t]# python jinja_if.py interface ethernet 1/1 switchport mode access switchport access vlan 10 interface ethernet 1/2 switchport mode trunk switchport trunk allowed vlan add 20

示例7：模块化模板

在templates目录下新建主模板文件modular.conf.tpl

{% for port in ports -%} {% with port=port -%} {% include "port_conf.sub.conf.tpl" %} {% endwith -%} {% endfor -%}

说明：with在这里其实是重新命令变量而已。
在templates目录下新建子模板文件port_conf.sub.conf.tpl

interface {{ port['type'] }} {{ port['slot'] }}/{{ port['port_num'] }} {%- if port['intf_type'] == "access" %} switchport mode {{ port['intf_type'] }} switchport access vlan {{ port['vlan'] }} {%- endif %}{%- if port['intf_type'] == "trunk" %} switchport mode {{ port['intf_type'] }} switchport trunk allowed vlan add {{ port['vlan'] }} {%- endif %}
新建python文件jinja_modular.py

from jinja2 import FileSystemLoader, Environmentports = [{ "type": "ethernet", "slot": 1, "port_num": 1, "intf_type": "access", 'vlan': 10 }, { "type": "ethernet", "slot": 1, "port_num": 2, "intf_type": "trunk", 'vlan': 20 }]loader = FileSystemLoader('templates') env = Environment(loader=loader) tpl = env.get_template('modular.conf.tpl') output = tpl.render(ports=ports) print(output)

执行脚本，结果如下所示:

(py376) [root@localhost Jinja2_t]# python jinja_modular.py interface ethernet 1/1 switchport mode access switchport access vlan 10 interface ethernet 1/2 switchport mode trunk switchport trunk allowed vlan add 20

示例8：过滤器

在templates目录下新建主模板文件filter.conf.tpl

{{ vendor_list|vendor_filter() }}
新建python文件jinja_filter.py

from jinja2 import FileSystemLoader, Environment# 自定义一个函数 def vendor_filter(vendor): new_vendor = vendor[0:3] + ['...'] return new_vendorvendor_list = ['cisco', 'huawei', 'h3c', 'ruijie', 'fortinet', 'sangfor']loader = FileSystemLoader('templates') environment = Environment(loader=loader) environment.filters["vendor_filter"] = vendor_filter tpl = environment.get_template("filter.conf.tpl") output = tpl.render(vendor_list=vendor_list) print(output)

执行脚本，结果如下所示:

(py376) [root@localhost Jinja2_t]# python jinja_filter.py ['cisco', 'huawei', 'h3c', '...']

示例9：模板继承

在templates目录下新建主模板文件base.conf.tpl

# 这个头部 {% block head -%} 欢迎来到母版的世界. {% endblock -%}hostname {% block hostname_suffix %}default{%endblock %} # 这个是尾部

说明：块的语法，起始block，结束用endblock，标识这段是一个块, block的命名需要唯一.
在templates目录下新建子模板文件child.conf.tpl

{% extends 'base.conf.tpl' %} {% block head -%} {{ super() }} 我来自子模版的世界. {% endblock -%} {% block hostname_suffix %} router-01 {% endblock %}

通过extends方法继承模板(也叫基础模板)
super()方法可以继承母版上的配置，然后自己可以增加配置(说白了就是在母版基本上追加配置).
block的好处就是可以继承或者重写内容。

新建python文件jinja_base.py

from jinja2 import FileSystemLoader, Environmentloader = FileSystemLoader('templates', encoding="gbk") environment = Environment(loader=loader) tpl = environment.get_template("child.conf.tpl")output = tpl.render() print(output)

执行脚本，结果如下所示:

(py376) [root@localhost Jinja2_t]# python jinja_base.py # 这个头部欢迎来到母版的世界.我来自子模版的世界. hostnamerouter-01 # 这个是尾部

好了，大家学到这里，应该对jinja2有更深的了解了，通过netmiko结合jinja2可以完美实现标准配置生成与下发了。

最后来一个，点赞、收藏、三连击...... 如果喜欢的我的文章，欢迎关注我的公众号：点滴技术，扫码关注，不定期分享