如何使用line_profiler(来自罗伯特·科恩)?

46 投票
6 回答
75342 浏览
提问于 2025-04-18 07:41

我尝试使用line_profiler这个模块来获取Python文件的逐行性能分析。这是我到目前为止所做的:

1) 我通过使用.exe文件从pypi安装了line_profiler(我在使用WinXP和Win7)。安装过程就像点击下一步一样简单。

2) 我写了一小段代码(类似于在另一个回答中提到的内容这里)。

from line_profiler import LineProfiler
def do_stuff(numbers):
    print numbers

numbers = 2
profile = LineProfiler(do_stuff(numbers))
profile.print_stats()

3) 我从IDLE/PyScripter运行了这段代码。结果我只得到了运行时间。

Timer unit: 4.17188e-10 s

我该如何获取我执行代码的完整逐行分析呢?我从来没有使用过像装饰器这样的高级Python特性,所以我很难理解如何使用一些帖子中提供的指导,比如这里这里的内容。

6 个回答

4

如果你在使用PyCharm这个编程工具,可以看看这个链接:https://plugins.jetbrains.com/plugin/16536-line-profiler

这是我制作的一个插件,它可以让你在PyCharm编辑器中加载和查看行分析器的结果。

6

加载 line_profiler 和 numpy

%load_ext line_profiler
import numpy as np

定义一个示例函数:

def take_sqr(array):
    sqr_ar = [np.sqrt(x) for x in array]
    return sqr_ar

使用 line_profiler 来计算时间,方法如下:

%lprun -f take_sqr take_sqr([1,2,3])

输出结果看起来像这样:

Timer unit: 1e-06 s
 
Total time: 6e-05 s File: <ipython-input-5-e50c1b05a473> Function:
take_sqr at line 1

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     1                                           def take_sqr(array):
     2         4         59.0     14.8     98.3      sqr_ar = [np.sqrt(x) for x in array]
     3         1          1.0      1.0      1.7      return sqr_ar
8

我找到了一种很好的方法来使用 line_profiler,通过装饰器,也就是 @profile,这个方法对我很有效:

def profile(func):
    from functools import wraps

    @wraps(func)
    def wrapper(*args, **kwargs):
        from line_profiler import LineProfiler
        prof = LineProfiler()
        try:
            return prof(func)(*args, **kwargs)
        finally:
            prof.print_stats()

    return wrapper

感谢: pavelpatrin

88

这个回答是我在这里给出的,讲的是如何在Python脚本中获取line_profiler的统计信息(不需要在命令行使用kernprof,也不需要在函数和类方法上加@profile装饰器)。我看到的关于类似line_profiler的问题的回答,基本上都是在讲怎么用kernprof


line_profiler的测试案例中(可以在GitHub找到),有一个示例展示了如何在Python脚本中生成性能分析数据。你需要把想要分析的函数包裹起来,然后调用这个包裹的函数,并传入你想要的参数。

from line_profiler import LineProfiler
import random

def do_stuff(numbers):
    s = sum(numbers)
    l = [numbers[i]/43 for i in range(len(numbers))]
    m = ['hello'+str(numbers[i]) for i in range(len(numbers))]

numbers = [random.randint(1,100) for i in range(1000)]
lp = LineProfiler()
lp_wrapper = lp(do_stuff)
lp_wrapper(numbers)
lp.print_stats()

输出:

Timer unit: 1e-06 s

Total time: 0.000649 s
File: <ipython-input-2-2e060b054fea>
Function: do_stuff at line 4

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     4                                           def do_stuff(numbers):
     5         1           10     10.0      1.5      s = sum(numbers)
     6         1          186    186.0     28.7      l = [numbers[i]/43 for i in range(len(numbers))]
     7         1          453    453.0     69.8      m = ['hello'+str(numbers[i]) for i in range(len(numbers))]

添加额外的函数进行分析

此外,你还可以添加其他函数进行分析。例如,如果你有一个第二个被调用的函数,而你只包裹了调用的函数,那么你只会看到调用函数的分析结果。

from line_profiler import LineProfiler
import random

def do_other_stuff(numbers):
    s = sum(numbers)

def do_stuff(numbers):
    do_other_stuff(numbers)
    l = [numbers[i]/43 for i in range(len(numbers))]
    m = ['hello'+str(numbers[i]) for i in range(len(numbers))]

numbers = [random.randint(1,100) for i in range(1000)]
lp = LineProfiler()
lp_wrapper = lp(do_stuff)
lp_wrapper(numbers)
lp.print_stats()

上面的代码只会为调用函数生成以下的分析输出:

Timer unit: 1e-06 s

Total time: 0.000773 s
File: <ipython-input-3-ec0394d0a501>
Function: do_stuff at line 7

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     7                                           def do_stuff(numbers):
     8         1           11     11.0      1.4      do_other_stuff(numbers)
     9         1          236    236.0     30.5      l = [numbers[i]/43 for i in range(len(numbers))]
    10         1          526    526.0     68.0      m = ['hello'+str(numbers[i]) for i in range(len(numbers))]

在这种情况下,你可以像这样添加额外的被调用函数进行分析:

from line_profiler import LineProfiler
import random

def do_other_stuff(numbers):
    s = sum(numbers)

def do_stuff(numbers):
    do_other_stuff(numbers)
    l = [numbers[i]/43 for i in range(len(numbers))]
    m = ['hello'+str(numbers[i]) for i in range(len(numbers))]

numbers = [random.randint(1,100) for i in range(1000)]
lp = LineProfiler()
lp.add_function(do_other_stuff)   # add additional function to profile
lp_wrapper = lp(do_stuff)
lp_wrapper(numbers)
lp.print_stats()

输出:

Timer unit: 1e-06 s

Total time: 9e-06 s
File: <ipython-input-4-dae73707787c>
Function: do_other_stuff at line 4

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     4                                           def do_other_stuff(numbers):
     5         1            9      9.0    100.0      s = sum(numbers)

Total time: 0.000694 s
File: <ipython-input-4-dae73707787c>
Function: do_stuff at line 7

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     7                                           def do_stuff(numbers):
     8         1           12     12.0      1.7      do_other_stuff(numbers)
     9         1          208    208.0     30.0      l = [numbers[i]/43 for i in range(len(numbers))]
    10         1          474    474.0     68.3      m = ['hello'+str(numbers[i]) for i in range(len(numbers))]

注意:以这种方式添加函数进行分析,不需要对被分析的代码进行任何修改(也就是说,不需要添加@profile装饰器)。

21

只需按照Dan Riti在第一个链接中的示例,但用你自己的代码。安装好line_profiler模块后,你只需在每个想要逐行分析的函数前面加上@profile这个装饰器,并确保这些函数在代码的其他地方至少被调用一次。对于你简单的示例代码,可能看起来像这样:

example.py文件:

@profile
def do_stuff(numbers):
    print numbers

numbers = 2
do_stuff(numbers)

完成这些后,通过在你的C:\Python27\Scripts目录中安装的kernprof.py来运行你的脚本。以下是你在Windows 7命令行中运行时(其实不太有趣)的实际输出:

> python "C:\Python27\Scripts\kernprof.py" -l -v example.py
2
Wrote profile results to example.py.lprof
Timer unit: 3.2079e-07 s

File: example.py
Function: do_stuff at line 2
Total time: 0.00185256 s

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     1                                           @profile
     2                                           def do_stuff(numbers):
     3         1         5775   5775.0    100.0      print numbers

你可能需要调整最后一步——用kernprof.py来运行你的测试脚本,而不是直接用Python解释器——以便在IDLE或PyScripter中实现相同的效果。

更新

看起来在line_profiler v1.0中,kernprof工具现在是作为可执行文件分发的,而不是我之前写的那种.py脚本文件。这意味着现在需要用以下方式从命令行调用它:

> "C:\Python27\Scripts\kernprof.exe" -l -v example.py

撰写回答