Python 性能分析的几个方法,找到你代码中的那个她

简介: 我们在编写了一个脚本在笔记本上处理一些数据,然后去喝杯咖啡或者上了个厕所,15分钟后回来时发现进度才完成不到10%。我们的脑袋里面就会发问:为什么这么慢?究竟是在哪个部分是慢的?是读取数据、处理数据还是保存数据?如何让它变快?它真的很慢吗?有了这个疑问我们尝试去解决这个问题,下面我们介绍几个 python 性能分析的工具。

我们在编写了一个脚本在笔记本上处理一些数据,然后去喝杯咖啡或者上了个厕所,15分钟后回来时发现进度才完成不到10%。


我们的脑袋里面就会发问:为什么这么慢?究竟是在哪个部分是慢的?是读取数据、处理数据还是保存数据?如何让它变快?它真的很慢吗?


有了这个疑问我们尝试去解决这个问题,下面我们介绍几个 python 性能分析的工具。

什么是性能分析

分析器是一种工具,它接收代码,运行它,并收集关于每个函数调用花费了多少时间、被执行了多少次以及函数调用的层次结构等信息。


通过分析其输出,我们可以找出代码中哪部分执行时间最长(称为瓶颈),甚至可能想出解决方法。希望识别和解决瓶颈问题,从而实现整体速度上的最大改进。

问题示例:

假设我们有一个大文本文件,想要在其中找到某个特定模式的多个出现。首先,让我们生成一个由随机字母数字字符组成的大文件(逐行生成):

import random
 import string
 
 def generate_random_string(length):
     """生成一个由小写字母和数字组成的随机字符串。"""
     letters_and_digits = string.ascii_letters + string.digits
     return ''.join(random.choice(letters_and_digits) for _ in range(length))
 
 def generate_random_file(filename, num_lines, line_length):
     """生成一个指定数量和长度的随机行文件。"""
     with open(filename, 'w') as f:
         for i in range(num_lines):
             random_line = generate_random_string(line_length) + '\n'
             f.write(random_line)
 
 if __name__ == '__main__':
     #生成1000000行,每行1000个字符
     generate_random_file('random.txt', 1_000_000, 1000)

接下来,让我们定义基准函数——它逐行读取文件,然后计算以数字为前缀的单词bob和rob在其中出现的次数:

import re
 
 def baseline():
     num_total_matches = 0
     pattern1 = r"[0-9]{1}bob" # 正则表达式
     pattern2 = r"[0-9]{1}rob" # 正则表达式
     
     with open('random.txt', 'rt') as f:
         for line in f:
             line = line.lower()  # 将文本全部为小写。
             for pattern in [pattern1, pattern2]:
                 # 在字符串中找到模式的所有匹配项
                 matches = re.findall(pattern, line)
 
                 # 统计出现的次数
                 num_matches = len(matches)
                 num_total_matches += num_matches
             
     return num_total_matches

例如,一行abc1robdef02bob中有两个出现。


我们运行baseline函数,计算出现次数(在我的情况下为10861),并测量运行时间 — 在我的机器上为32秒。


我们如何加快速度?

改进目标

代码中有四个潜在部分导致运行速度变慢。

  1. 使用原始字符串而不是编译后的正则表达式对象。
  2. 使用两个单独的搜索,而不是一个联合的正则表达式。
  3. 将每一行转换为小写,而不是使用不区分大小写标志。
  4. 逐行读取文件,而不是较大的块。


我们如何知道哪一个是瓶颈?我们可以使用性能分析工具。

Python性能分析工具

我们不必自己实现任何功能代码。Python已经有两个内置的性能分析模块 — cProfile 和 profile。它们执行相同的功能,但 cProfile 是用C编写的,而 profile 则是纯Python编写的。你可以直接使用它们,不过我们使用一些外部工具,这将大大提升我们的工作效率。


我们需要一种快速便捷的方式来对代码的一部分(例如一个函数)进行性能分析,并将结果保存到文件中。profilehooks模块提供了一个简单装饰器,我们可以像这样使用到我们需要检测的函数:

from profilehooks import profile
 
 # stdout=False -> don't print anything in the terminal
 # filname -> path to the output file with profiling results
 @profile(stdout=False, filename='baseline.prof')
 def baseline():
     ...

可以通过简单的 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 命令。


要生成带有性能分析结果的输出图像,请使用以下命令:

python -m gprof2dot -f pstats <profiling-results-file> | dot -Tpng -o output.png

我们首先将函数调用的层次结构表示为dot格式的图形,然后生成一幅图像 — 显示该图形。dot命令支持不同的输出格式,包括.jpg和.svg,而且 gprof2dot 的输出也具有高度可定制性。

我们代码中函数执行层次结构的图形表示。百分比显示了在函数内部花费的总执行时间比例. 但这些仅包括自身函数的代码。最后一个值是该函数在代码中被调用的次数。

可以说现在更易读了,图表告诉我们正则表达式搜索占据了总执行时间的88%,因此我们需要专注于让它变得更快。


如果无法访问Graphviz(dot命令),您可以使用对应的Graphviz Python包(pip install graphviz)和一个简单的Python脚本来生成结果。

  1. 我们将把 gprof2dot 的输出保存到一个 .dot 文件中: python -m gprof2dot -f pstats file.prof > file.dot
  2. 我们将使用以下代码从这个.dot文件生成图片:
import graphviz
     
 def make_png(input_file_name, output_file_name):
     dot = graphviz.Source.from_file(input_file_name)
     dot.render(outfile=output_file_name)
     
 if __name__ == '__main__':
     make_png('file.dot', 'file.svg')  # 还支持 .png、.jpg 等格式。

代码改进

让我们通过将两个正则表达式合并为一个来加快代码速度:

def single_pattern():
     num_total_matches = 0
     pattern = r"[0-9][rb]ob"  # 我们现在只有一个搜索
     
     with open('random.txt', 'rt') as f:
         for line in tqdm(f, total=1_000_000):
             line = line.lower()
             # 在字符串中找到模式的所有匹配项
             matches = re.findall(pattern, line)
 
             # 计算比赛的数量
             num_matches = len(matches)
             num_total_matches += num_matches
         
     return num_total_matches

现在我们可以达到15秒,速度提高了约2倍!

新代码的性能分析结果。请注意findall函数所占用时间的百分比下降了(从88% -> 81.5%)。


对新代码进行性能分析证实这是正确的选择 — 主要findall函数所占用时间比例下降,而其他所有函数所占用时间增加(大约增加了2倍)。

def wasted_efforts():
     num_total_matches = 0
     # 我们使用编译后的正则表达式
     pattern1 = re.compile(r"[0-9]{1}rob", flags=re.IGNORECASE)
     # 我们还使用不区分大小写的情况。
     pattern2 = re.compile(r"[0-9]{1}bob", flags=re.IGNORECASE)
     
     with open('random.txt', 'rt') as f:
         # 我们将行加载到一个块中,并一次性处理。
         chunk = []
         for line in tqdm(f, total=1_000_000):
             chunk.append(line)
             
             if len(chunk) == 1000:
                 chunk_str = ''.join(chunk)
                 for pattern in [pattern1, pattern2]:
                     # 在字符串中找到模式的所有匹配项
                     matches = re.findall(pattern, chunk_str)
 
                     # 计算数量
                     num_matches = len(matches)
                     num_total_matches += num_matches
                     
                 chunk = []
 
     # 尽管我们修改了代码,但这段代码仍然和原始版本一样慢。
     return num_total_matches

多进程处理

findall 函数仍然是瓶颈。然而,在这个示例中,我们只能做一件直接的事情来进一步改进它:并行执行我们的代码。


不同字符串中的匹配是相互独立的,因此我们可以并行搜索它们。我们该如何做呢?


最简单的方法是创建一个进程池 — 一个操作多个并行 Python 进程的对象,所有进程都同时运行。


如果我们有一个值列表和要应用于每个值的函数,只需调用池的 map 方法,它将并行地在所有值上为我们运行函数。

from multiprocessing import Pool
 
 def calc_num_matches(string):
     # 我们为我们的池对象创建一个单独的函数
     # 并行应用于文件中的每一行
     pattern = r"[0-9]{1}[rb]ob"
     return len(re.findall(pattern, string))
 
 def chunks_single_pool():
     num_total_matches = 0
     
     pool = Pool(8)  # 进程数量应该小于或等于 CPU 核心数。
     
     with open('random.txt', 'rt') as f:
         chunk = []
         # 我们将行加载到列表中
         for line in tqdm(f, total=1_000_000):
             line = line.lower()
             chunk.append(line)
             
             if len(chunk) == 1000:
                 # 然后我们并行地将我们的 `calc_num_matches` 函数应用于每一行
                 num_ind_matches = pool.map(calc_num_matches, chunk)
                 # 将所有独立匹配项相加。
                 num_matches = sum(num_ind_matches)
                 num_total_matches += num_matches
 
                 chunk = []
     
     return num_total_matches

让我们看看……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。

总结

本文我们以示例演示一个存在性能问题的代码,并使用工具分析的场景。


在处理数据时遇到代码运行缓慢的问题,需要找出瓶颈所在并进行优化。通过生成大文本文件并定义基准函数来计算特定模式的出现次数,初始运行时间较长,需要加快速度。


解决方案

  1. 使用 SnakeViz 和 gprof2dot 等性能分析工具,找出主要瓶颈为 findall 函数中的正则表达式搜索。
  2. 将两个正则表达式合并为一个,使运行速度提高约 2 倍。
  3. 采用多进程处理,创建进程池并行执行代码,使运行速度比优化后的解决方案快 2.2 倍,比原始版本快约 5 倍。


注意事项

  1. 多进程方面,分析器无法知晓子进程中的正则表达式搜索情况,若要分析子进程,应将装饰器放在子进程执行的函数内。
  2. 多线程方面,由于全局解释器锁限制,通常不必直接编写多线程 Python 代码。若使用大量非 Python 库或大量 I/O 操作,利用多线程可能有效。Python 内置性能分析模块仅对应用程序的主线程进行性能分析,若要分析其他线程,可在相关函数中运行分析器或使用第三方工具如 VizTracer。
相关文章
|
2天前
|
缓存 监控 测试技术
Python中的装饰器:功能扩展与代码复用的利器###
本文深入探讨了Python中装饰器的概念、实现机制及其在实际开发中的应用价值。通过生动的实例和详尽的解释,文章展示了装饰器如何增强函数功能、提升代码可读性和维护性,并鼓励读者在项目中灵活运用这一强大的语言特性。 ###
|
5天前
|
缓存 开发者 Python
探索Python中的装饰器:简化代码,增强功能
【10月更文挑战第35天】装饰器在Python中是一种强大的工具,它允许开发者在不修改原有函数代码的情况下增加额外的功能。本文旨在通过简明的语言和实际的编码示例,带领读者理解装饰器的概念、用法及其在实际编程场景中的应用,从而提升代码的可读性和复用性。
|
2天前
|
Python
探索Python中的装饰器:简化代码,提升效率
【10月更文挑战第39天】在编程的世界中,我们总是在寻找使代码更简洁、更高效的方法。Python的装饰器提供了一种强大的工具,能够让我们做到这一点。本文将深入探讨装饰器的基本概念,展示如何通过它们来增强函数的功能,同时保持代码的整洁性。我们将从基础开始,逐步深入到装饰器的高级用法,让你了解如何利用这一特性来优化你的Python代码。准备好让你的代码变得更加优雅和强大了吗?让我们开始吧!
7 1
|
7天前
|
设计模式 缓存 监控
Python中的装饰器:代码的魔法增强剂
在Python编程中,装饰器是一种强大而灵活的工具,它允许程序员在不修改函数或方法源代码的情况下增加额外的功能。本文将探讨装饰器的定义、工作原理以及如何通过自定义和标准库中的装饰器来优化代码结构和提高开发效率。通过实例演示,我们将深入了解装饰器的应用,包括日志记录、性能测量、事务处理等常见场景。此外,我们还将讨论装饰器的高级用法,如带参数的装饰器和类装饰器,为读者提供全面的装饰器使用指南。
|
2天前
|
存储 缓存 监控
掌握Python装饰器:提升代码复用性与可读性的利器
在本文中,我们将深入探讨Python装饰器的概念、工作原理以及如何有效地应用它们来增强代码的可读性和复用性。不同于传统的函数调用,装饰器提供了一种优雅的方式来修改或扩展函数的行为,而无需直接修改原始函数代码。通过实际示例和应用场景分析,本文旨在帮助读者理解装饰器的实用性,并鼓励在日常编程实践中灵活运用这一强大特性。
|
7天前
|
存储 算法 搜索推荐
Python高手必备!揭秘图(Graph)的N种风骚表示法,让你的代码瞬间高大上
在Python中,图作为重要的数据结构,广泛应用于社交网络分析、路径查找等领域。本文介绍四种图的表示方法:邻接矩阵、邻接表、边列表和邻接集。每种方法都有其特点和适用场景,掌握它们能提升代码效率和可读性,让你在项目中脱颖而出。
18 5
|
5天前
|
机器学习/深度学习 数据采集 人工智能
探索机器学习:从理论到Python代码实践
【10月更文挑战第36天】本文将深入浅出地介绍机器学习的基本概念、主要算法及其在Python中的实现。我们将通过实际案例,展示如何使用scikit-learn库进行数据预处理、模型选择和参数调优。无论你是初学者还是有一定基础的开发者,都能从中获得启发和实践指导。
11 2
|
7天前
|
数据库 Python
异步编程不再难!Python asyncio库实战,让你的代码流畅如丝!
在编程中,随着应用复杂度的提升,对并发和异步处理的需求日益增长。Python的asyncio库通过async和await关键字,简化了异步编程,使其变得流畅高效。本文将通过实战示例,介绍异步编程的基本概念、如何使用asyncio编写异步代码以及处理多个异步任务的方法,帮助你掌握异步编程技巧,提高代码性能。
20 4
|
8天前
|
缓存 开发者 Python
探索Python中的装饰器:简化和增强你的代码
【10月更文挑战第32天】 在编程的世界中,简洁和效率是永恒的追求。Python提供了一种强大工具——装饰器,它允许我们以声明式的方式修改函数的行为。本文将深入探讨装饰器的概念、用法及其在实际应用中的优势。通过实际代码示例,我们不仅理解装饰器的工作方式,还能学会如何自定义装饰器来满足特定需求。无论你是初学者还是有经验的开发者,这篇文章都将为你揭示装饰器的神秘面纱,并展示如何利用它们简化和增强你的代码库。
|
7天前
|
API 数据处理 Python
探秘Python并发新世界:asyncio库,让你的代码并发更优雅!
在Python编程中,随着网络应用和数据处理需求的增长,并发编程变得愈发重要。asyncio库作为Python 3.4及以上版本的标准库,以其简洁的API和强大的异步编程能力,成为提升性能和优化资源利用的关键工具。本文介绍了asyncio的基本概念、异步函数的定义与使用、并发控制和资源管理等核心功能,通过具体示例展示了如何高效地编写并发代码。
16 2