Python自动打印被调用函数变量名及对应值

Tallulah ·

更新时间:2024-11-10

· 1621 次阅读

1.软件环境

2.问题描述

3.解决方法

4.结果预览

1.软件环境

Windows10 教育版64位
Python 3.6.3

2.问题描述

我们在定义一个函数或者是调用一个函数的时候，总是希望能够知道传入该被调用函数的具体值是多少？是否符合我们的预期？因此我们往往会将我们关心的值给打印出来（当然debug也可以，但不能每次都debug吧？），如下，我们创建了一个initial_printer示例函数：

def initial_printer(variable_a, variable_b, variable_c, variable_d, variable_e, variable_f):
    print('打印所有的变量：variable_a:{}, variable_b:{},, variable_c:{},, variable_d:{},, variable_e:{},, variable_f:{}'.format(
        variable_a,
        variable_b,
        variable_c,
        variable_d,
        variable_e,
        variable_f))
    return variable_a + variable_b + variable_c + variable_d + variable_e + variable_f
if __name__ == '__main__':
    result = initial_printer(variable_a=1, variable_b=2, variable_c=3, variable_d=4, variable_e=5, variable_f=6)

该函数将所有传入的变量使用Python自带的print函数打印了出来，运行之后确实看到打印成功了：

但这种方法有至少2个弊端：

有可能会因为你的粗心大意，在使用print格式化输出时，函数名和值错位，导致变量值打印错误，即variable_a打印的可能是其它变量的值；

如果你要新增一个变量或修改变量名称，那么又要修改print里面的变量和值；更进一步的，如果你的这个函数经常被修改，不可能每次都来修改上述用来打印变量的代码；

那这个时候是否有一种办法，在我们添加变量时，不需要修改打印的代码，让Python自动打印被调用函数的变量名及对应的值呢

3.解决方法

这个时候就需要介绍今天的主角了：Python自带的locals()函数，该函数会以字典类型返回当前位置的全部局部变量。
对于函数， 方法，lambda 函式， 类，以及实现了 __call__ 方法的类实例，它都返回 True。因此，我们只需要将之前的打印语句：

    print('打印所有的变量：variable_a:{}, variable_b:{},, variable_c:{},, variable_d:{},, variable_e:{},, variable_f:{}'.format(
        variable_a,
        variable_b,
        variable_c,
        variable_d,
        variable_e,
        variable_f))

换成locals()即可，即：

        # print('打印所有的变量：variable_a:{}, variable_b:{},, variable_c:{},, variable_d:{},, variable_e:{},, variable_f:{}'.format(
    #     variable_a,
    #     variable_b,
    #     variable_c,
    #     variable_d,
    #     variable_e,
    #     variable_f))
    print('打印所有的变量：', locals())

4.结果预览

可以看到，只需要一个locals()函数即可自动打印被调用函数的变量名和值，并且你随便怎么添加或修改变量名，它都会自动同步，简直不要太方便！！！