前言
我喜欢用 python 做一些临时性数据工作,简单情况下,直接一把梭写到底。比如简单的多文件合并数据:
定义函数?一辈子都不可能。
不过,稍微复杂一些的情况,比如下面是 tableau prep 数据任务挑战中一道简单题目——寻找可能具有欺诈性的交易。
代码画风突变成这样子:
不让我定义函数?想要我命了吧!
得益于 pandas 的管道功能,我们可以更容易管理复杂的数据任务代码。关于如何以正确的思路使用 pandas 管道(pipe) ,具体可以查看我的 pandas 专栏。
数据处理是一种"重流程"的编程。但是,你会发现,上面的代码不管如何划分,你也无法容易理清楚数据流程。这才是痛点。
那如果有一种工具,可以把函数调用关系,以可视化方式展示给你,并且你可以轻松查看每一步处理结果的数据,还能直接跳转到具体代码行?看看演示:
- 自动生成函数调用图。流程图可以缩放,拖动平移
- 点击每个节点,下方出现函数处理结果的表数据。还可以通过勾选,快速筛选数据
当然,如果不能快速定位到代码,那就没有意思。
工具使用 nicegui 制作。
pandas 专栏马上开始最后关于工程化的阶段,本节介绍的可视化工具就是为了专栏而制作。工程化的章节内容,将会是大量 tableau prep 数据处理挑战任务实战。
要做到这样的可视化,必需找到一种方式,可以在 python 中,自动化识别函数调用关系。
今天,我们探讨一下,如何做到这一切。重点是分享里面涉及到的 python 知识。
目前我想到3种实现方式,本文讲解其中一种。
验证想法
要设计一个新的功能,我们需要从最简单的问题开始,验证想法是否能行。假设两个简单的函数
- 在函数 b 中,调用了 函数 a
现在我们需要的是,得到一个记录信息,能反映出,函数 b 中,使用了函数 a。
python 中可以做到吗?
这涉及 python 中一个概念——闭包。直观来说,闭包就是一个函数中,直接使用了外部定义的变量。就像上面例子中,函数 b 中并没有定义变量 a,那么代码中使用的变量 a ,就是外部定义的函数 a。
我们可以使用 inspect 模块的 getclosurevars 获取闭包变量。
- 注意, 我们没有执行函数 b
- 得到的是一个 ClosureVars 对象。其中有一个 globals 属性,可以获取函数中全局闭包变量映射表(字典)
注意字典的 value 是函数对象。有了函数对象,我们就可以获取它的一切信息。比如函数定义在哪个文件的哪一行,有什么参数等等。
现在,可以把功能封装起来,看起来像这样子:
- 行37:我们只关注函数之间的调用,所以这里做了过滤
这样子调用:
准确控制
但是,现在是通过我们手工传入函数 b ,这样子太麻烦了。在实际使用中,我们希望直接调用一个函数,就能自动检测当前环境所有的全局变量,并找出调用关系。
有小伙伴可能会想到,可以用 globals 函数获取所有的全局变量字典。但是不适合我们的情况。因为我们的功能函数是单独定义在一个模块文件中。
如果在我们定义的函数中使用 globals,只会获取到当前模块的全局变量。
此时仍然可以使用 inspect 模块的 currentframe 获取当前调用帧栈,从而获取上一层帧栈:
这里的意思就是:"谁调用我,我就拿了谁的全局变量"。
剩下就非常简单,遍历这个字典,筛选出函数对象,然后调用之前定义的 get_func_relationships :
- 行81:得到的是一个 列表中的列表
- 行80:使用 itertools 模块的 chain 给展开成一层列表
这里还存在一些问题,我们希望它不要什么函数都获取,由使用者为需要检测关系的函数打上标记。比如:
只有打上 @check 装饰器的函数,才需要获取调用关系。
只需要创建一个类即可:
装饰器知识点以前就有讲解。
我们需要把之前的功能函数中的目标类型判断修改为 TargetFn :
一切就绪:
- 行1:使用时,先导入
- 行8:需要检测的函数,打上装饰器
- 行40:只需要在最后调用 build_all_relationships 即可
有了关系信息,做功能界面就没有太大难度了。