如何在yaml⽂件中引⽤python函数？
前⾔
经常看到很多同学问到，如何在 yaml ⽂件中引⽤⼀个 python 的函数？
问题分析
yamy朋友发声⼤家对yaml⽂件还处于⽐较陌⽣的阶段，yaml 和 json ⽂件本质上是⼀样的，都是静态的⽂件，当然不能直接引⽤ python 的函数。
那这时候就有⼈问到了，那为什么 httprunner 框架可以在yaml⽂件中引⽤函数呢？
这是因为 httprunner 框架封装过对 yaml ⽂件的读取了，它是先读取⽂件内容，正则提取到${}括号⾥⾯的函数内容，再把函数的值替换过去
那么我们能不能实现这种效果呢？
当然是可以的，可以参考httprunner的实现，也可以⽤到 python 的模板 jinja2 来实现。
使⽤模板可以编写出可读性更好，更容易理解和维护的代码，并且使⽤范围⾮常⼴泛，因此怎么使⽤模板
主要取决于我们的想象⼒和创造⼒。
python的模板库jinja2 功能是⾮常强⼤的。
jinja2 模板库
先需要pip安装
pip install jinja2
render 函数实现
在yaml⽂件中，通过{{ 函数名称() }}来引⽤函数
写个 render 函数读取 yaml ⽂件内容
import os
import jinja2
import yaml
import random
def render(tpl_path, **kwargs):
path, filename = os.path.split(tpl_path)
return jinja2.Environment(loader=jinja2.FileSystemLoader(path or './')
).get_template(filename).render(**kwargs)
读取到的yaml⽂件本质上都是字符串来读取的，通过jinja2 模板来读取，会先把函数的值替换进去。最后再转成python的dict结构
import os
import jinja2
import yaml
import random
def render(tpl_path, **kwargs):
path, filename = os.path.split(tpl_path)
return jinja2.Environment(loader=jinja2.FileSystemLoader(path or './')
).get_template(filename).render(**kwargs)
# yaml ⽂件调⽤以下函数
def rand_str():
return str(random.randint(1000000, 2000000))
if __name__ == '__main__':
r = render("aa.yml", **{"rand_str": rand_str})
print(r)
print(yaml.safe_load(r))
运⾏结果
name: yoyo
age: 22
tel: 1616350
{'name': 'yoyo', 'age': 22, 'rand_str': 1616350}
上⾯读取函数是写死的，我们希望能⾃动加载类似于debugtalk.py的⽂件来⾃动加载函数⾃动加载debug.py⾥⾯的函数
写⼀个debug.py ⽂件，实现 yaml ⽂件⾥⾯定义的函数去替换值。
import random
# yaml ⽂件调⽤以下函数
def rand_str():
return str(random.randint(1000000, 2000000))
run.py⾥⾯定义⼀个函数⾃动读取debug.py⾥⾯的函数,⽣成dict 键值对格式
def all_functions():
"""加载debug.py模块"""
debug_module = importlib.import_module("debug")
all_function = bers(debug_module, inspect.isfunction)
# print(dict(all_function))
return dict(all_function)
函数返回{'rand_str': <function rand_str at 0x0000017B72EA8488>}
完整的run.py⽂件内容
import os
import jinja2
import yaml
import importlib
import inspect
def render(tpl_path, **kwargs):
"""渲染yml⽂件"""
path, filename = os.path.split(tpl_path)
return jinja2.Environment(loader=jinja2.FileSystemLoader(path or './')
).get_template(filename).render(**kwargs)
def all_functions():
"""加载debug.py模块"""
debug_module = importlib.import_module("debug")
all_function = bers(debug_module, inspect.isfunction)
print(dict(all_function))
return dict(all_function)
if __name__ == '__main__':
r = render("aa.yml", **all_functions())
print(r)
print(yaml.safe_load(r))
运⾏结果
{'rand_str': <function rand_str at 0x000001931C248488>}
name: yoyo
age: 22
tel: 1010421
{'name': 'yoyo', 'age': 22, 'tel': 1010421}