如何在yaml文件中引用python函数？

Posted 2022-03-02 上海-悠悠

前言

经常看到很多同学问到，如何在 yaml 文件中引用一个 python 的函数？

问题分析

大家对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: [phone]
'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 = inspect.getmembers(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 = inspect.getmembers(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: [phone]
'name': 'yoyo', 'age': 22, 'tel': 1010421