Python 性能分析的几个方法,找到你代码中的那个她!
我们在编写了一个脚本在笔记本上处理一些数据,然后去喝杯咖啡或者上了个厕所,15 分钟后回来时发现进度才完成不到 10%。
我们的脑袋里面就会发问:为什么这么慢?究竟是在哪个部分是慢的?是读取数据、处理数据还是保存数据?如何让它变快?它真的很慢吗?
有了这个疑问我们尝试去解决这个问题,下面我们介绍几个 python 性能分析的工具。
什么是性能分析
分析器是一种工具,它接收代码,运行它,并收集关于每个函数调用花费了多少时间、被执行了多少次以及函数调用的层次结构等信息。
通过分析其输出,我们可以找出代码中哪部分执行时间最长(称为瓶颈),甚至可能想出解决方法。希望识别和解决瓶颈问题,从而实现整体速度上的最大改进。
问题示例:
假设我们有一个大文本文件,想要在其中找到某个特定模式的多个出现。首先,让我们生成一个由随机字母数字字符组成的大文件(逐行生成):
接下来,让我们定义基准函数——它逐行读取文件,然后计算以数字为前缀的单词 bob 和 rob 在其中出现的次数:
例如,一行 abc1robdef02bob 中有两个出现。
我们运行 baseline 函数,计算出现次数(在我的情况下为 10861),并测量运行时间 — 在我的机器上为 32 秒。
我们如何加快速度?
改进目标
代码中有四个潜在部分导致运行速度变慢。
使用原始字符串而不是编译后的正则表达式对象。
使用两个单独的搜索,而不是一个联合的正则表达式。
将每一行转换为小写,而不是使用不区分大小写标志。
逐行读取文件,而不是较大的块。
我们如何知道哪一个是瓶颈?我们可以使用性能分析工具。
Python 性能分析工具
我们不必自己实现任何功能代码。Python 已经有两个内置的性能分析模块 — cProfile 和 profile。它们执行相同的功能,但 cProfile 是用 C 编写的,而 profile 则是纯 Python 编写的。你可以直接使用它们,不过我们使用一些外部工具,这将大大提升我们的工作效率。
我们需要一种快速便捷的方式来对代码的一部分(例如一个函数)进行性能分析,并将结果保存到文件中。profilehooks 模块提供了一个简单装饰器,我们可以像这样使用到我们需要检测的函数:
可以通过简单的 pip install profilehooks 命令进行安装。
我们需要以人类可读的方式来展示这个文件。我使用以下两种工具进行操作。
SnakeViz — 简单快速
Snakeviz 是 Python 分析结果的交互式可视化工具,可以在浏览器中使用。
安装非常简单(pip install snakeviz),使用也很方便(snakeviz <path-to-profiling-output>)。
让我们看看我们的 baseline 函数的分析结果如何。
Snakeviz 交互式结果 — icicle(左侧)和 sunburst(右侧,可能不太易读)图表。我们可以悬停并单击每个函数调用以查看其详细信息。从上到下是调用的嵌套层次结构,线条的长度表示代码执行该部分所花费的相对时间。
Snakeviz 还显示了一个交互式表格,其中包含函数执行时间的统计信息。
我们可以看到大部分执行时间都花费在 findall 函数内部,也就是进行正则表达式搜索。这意味着,如果我们想加快代码运行速度,需要专注于加快该函数的速度,因为它是瓶颈所在,并非代码的其他部分。
让我们用第二个工具来确认结果。
gprof2dot — 可读性强且灵活
Gprof2dot 提供更易读的可视化,以流程图的形式保存为图片文件,因此很容易分享(并在必要时自动化)结果。然而它不是交互式的,并且需要系统中安装 Graphviz。
要安装 gprof2dot,只需使用 pip install gprof2dot 命令。
要生成带有性能分析结果的输出图像,请使用以下命令:
我们首先将函数调用的层次结构表示为 dot 格式的图形,然后生成一幅图像 — 显示该图形。dot 命令支持不同的输出格式,包括.jpg 和.svg,而且 gprof2dot 的输出也具有高度可定制性。
我们代码中函数执行层次结构的图形表示。百分比显示了在函数内部花费的总执行时间比例. 但这些仅包括自身函数的代码。最后一个值是该函数在代码中被调用的次数。
可以说现在更易读了,图表告诉我们正则表达式搜索占据了总执行时间的 88%,因此我们需要专注于让它变得更快。
如果无法访问 Graphviz(dot 命令),您可以使用对应的 Graphviz Python 包(pip install graphviz)和一个简单的 Python 脚本来生成结果。
我们将把 gprof2dot 的输出保存到一个 .dot 文件中: python -m gprof2dot -f pstats file.prof > file.dot
我们将使用以下代码从这个.dot 文件生成图片:
代码改进
让我们通过将两个正则表达式合并为一个来加快代码速度:
现在我们可以达到 15 秒,速度提高了约 2 倍!
新代码的性能分析结果。请注意 findall 函数所占用时间的百分比下降了(从 88% -> 81.5%)。
对新代码进行性能分析证实这是正确的选择 — 主要 findall 函数所占用时间比例下降,而其他所有函数所占用时间增加(大约增加了 2 倍)。
多进程处理
findall 函数仍然是瓶颈。然而,在这个示例中,我们只能做一件直接的事情来进一步改进它:并行执行我们的代码。
不同字符串中的匹配是相互独立的,因此我们可以并行搜索它们。我们该如何做呢?
最简单的方法是创建一个进程池 — 一个操作多个并行 Python 进程的对象,所有进程都同时运行。
如果我们有一个值列表和要应用于每个值的函数,只需调用池的 map 方法,它将并行地在所有值上为我们运行函数。
让我们看看……6.1 秒!这是一个新纪录。比我们优化的解决方案快 2.2 倍,比原始版本快约 5 倍!让我们来看一下性能分析结果:
多进程代码的性能分析结果。请注意正则表达式搜索所占比例不断减少(绿色块)。
Snakeviz 显示多进程代码的相同图片。确认正则表达式搜索现在占据总时间的大约 2/3,比原始版本少得多。
注意事项
多进程
需要注意是,分析器不再知道子进程中进行正则表达式搜索时发生了什么。它只显示等待所有子进程完成花费了 4 秒的时间,但由于它们基本上是与我们主要的 Python 进程松散连接的独立程序,因此无法访问在子进程中执行的代码。
如果你想分析程序中子进程的运行情况,应该将 @profile 装饰器放在将由子进程执行的函数/代码内部。
多线程
通常情况下,由于全局解释器锁(Global Interpreter Lock,GIL)的限制,不必直接编写多线程 Python 代码,因为 GIL 一次只允许一个线程执行 Python 代码(在单个 Python 进程内)。
然而,如果你在使用大量非 Python 库(例如 NumPy、PyTorch、scipy)或进行大量 I/O 操作(网络通信),那么你的代码运行时大部分时间将花费在 Python 解释器之外执行用 C、C++、Fortran 等语言编写的代码上。
在这两种情况下,利用多线程可能是实际的,因此需要意识到 Python 的两个内置性能分析模块 — profile 和 cProfile — 仅对应用程序的主线程进行性能分析。如果想要对除主线程之外的其他线程执行的代码进行性能分析,可以尝试在将要执行线程的函数中运行分析器,或者使用一些第三方性能分析工具如 VizTracer。
总结
本文我们以示例演示一个存在性能问题的代码,并使用工具分析的场景。
在处理数据时遇到代码运行缓慢的问题,需要找出瓶颈所在并进行优化。通过生成大文本文件并定义基准函数来计算特定模式的出现次数,初始运行时间较长,需要加快速度。
解决方案:
使用 SnakeViz 和 gprof2dot 等性能分析工具,找出主要瓶颈为 findall 函数中的正则表达式搜索。
将两个正则表达式合并为一个,使运行速度提高约 2 倍。
采用多进程处理,创建进程池并行执行代码,使运行速度比优化后的解决方案快 2.2 倍,比原始版本快约 5 倍。
注意事项:
多进程方面,分析器无法知晓子进程中的正则表达式搜索情况,若要分析子进程,应将装饰器放在子进程执行的函数内。
多线程方面,由于全局解释器锁限制,通常不必直接编写多线程 Python 代码。若使用大量非 Python 库或大量 I/O 操作,利用多线程可能有效。Python 内置性能分析模块仅对应用程序的主线程进行性能分析,若要分析其他线程,可在相关函数中运行分析器或使用第三方工具如 VizTracer。
作者:demo007x
链接:https://juejin.cn/post/7390319395833380901
评论