乐趣区

关于python:Jinja2基本知识与实操文字版

jiezi

[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 %}

  • 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：简略的栗子

from  jinja2 import Template

tpl = 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, Environment

loader = FileSystemLoader('templates')
environment = Environment(loader=loader)
tpl = environment.get_template('vars.conf.tpl')
data = {'ip': '1.1.1.1'}
output = tpl.render(data=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, Environment

loader = FileSystemLoader('templates')
env = Environment(loader=loader)
tpl = env.get_template('vars.conf.tpl')
data = {'ip': '1.1.1.1'}
# print(tpl.render(data=data))

# 办法 1: render()
with open('cisco_logging.conf', 'w') as f:
    f.write(tpl.render(data=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, Environment

allowed = ['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, Environment

ports = [{
        "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, Environment

ports = [{
        "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_vendor

vendor_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, Environment


loader = 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 
# 这个头部
欢送来到母版的世界.

我来自子模版的世界.
hostname  router-01 
# 这个是尾部

    好了，大家学到这里，应该对 jinja2 有更深的理解了，通过 netmiko 联合 jinja2 能够完满实现标准配置生成与下发了。

最初来一个，点赞、珍藏、三连击 ……

如果喜爱的我的文章，欢送关注我的公众号：点滴技术，扫码关注，不定期分享

退出移动版