神器，轻松可视化 Python 程序调用流程

Posted 2022-06-22 AI科技大本营

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了神器，轻松可视化 Python 程序调用流程相关的知识，希望对你有一定的参考价值。

作者 | 周萝卜

来源 | 萝卜大杂烩

今天我们来分享一个 Python 领域的神级第三方库 -- pycallgraph，通过该库并结合 graphviz 工具，就可以非常方便的完成 Python 应用程序调用流程的可视化工作~

我们先来看下效果图：

怎么样，很是惊艳吧~

下面我们就来一起完成这个可视化过程

安装 graphviz 工具

生成图片的过程，是依赖工具 graphviz 的，我们先进行下载安装

下载地址

http://www.graphviz.org/download/

实战

接下来我们还需要安装两个 Python 依赖库

pip install pycallgraph

下面我们先写一个基础的代码

from pycallgraph import PyCallGraph
from pycallgraph.output import GraphvizOutput


class Banana:
    def eat(self):
        pass


class Person:
    def __init__(self):
        self.no_bananas()

    def no_bananas(self):
        self.bananas = []

    def add_banana(self, banana):
        self.bananas.append(banana)

    def eat_bananas(self):
        [banana.eat() for banana in self.bananas]
        self.no_bananas()


def main():
    graphviz = GraphvizOutput()
    graphviz.output_file = 'basic.png'

    with PyCallGraph(output=graphviz):
        person = Person()
        for a in range(10):
            person.add_banana(Banana())
        person.eat_bananas()


if __name__ == '__main__':
    main()

代码比较简单，定义了两个简单类，主要 pycallgraph 的核心代码在 main 函数中，在 with 代码块下，把我们定义的代码执行一遍即可

运行上面的代码，会在当前目录下生成 basic.png 图片文件

从生成的图片可以非常清晰的看出整个代码的运行过程，从 main 代码块到各个类的初始化，可以说一目了然。

我们再来一个复杂一点的例子：

import re

from pycallgraph import PyCallGraph
from pycallgraph import Config
from pycallgraph.output import GraphvizOutput


def main():
    graphviz = GraphvizOutput()
    graphviz.output_file = 'regexp.png'
    config = Config(include_stdlib=True)

    with PyCallGraph(output=graphviz, config=config):
        reo = compile()
        match(reo)


def compile():
    return re.compile('^[abetors]*$')


def match(reo):
    [reo.match(a) for a in words()]


def words():
    return [
        'abbreviation',
        'abbreviations',
        'abettor',
        'abettors',
        'abilities',
        'ability',
        'abrasion',
        'abrasions',
        'abrasive',
        'abrasives',
    ]

if __name__ == '__main__':
    main()

代码同样不负责，不过在编译器内部是调用了 re 正则的，我们来看看最终生成的图片：