使用 Cython 的 Line Profiling 内部函数

Posted 2023-03-06

【中文标题】使用 Cython 的 Line Profiling 内部函数

【英文标题】：Line Profiling inner function with Cython

【发布时间】：2016-06-28 21:14:01

【问题描述】：

我在使用this answer 分析我的 Cython 代码方面取得了相当大的成功，但它似乎不适用于嵌套函数。在this notebook 中，您可以看到在嵌套函数上使用线剖析器时配置文件不会出现。有没有办法让它工作？

【参考方案1】：

tl，博士：

这似乎是Cython 的一个问题，有一种骇人听闻的方法可以解决问题，但不可靠，您可以将其用于一次性情况，直到此问题得到解决^*支持>

更改line_profiler来源：

我不能 100% 确定这一点，但它确实有效，您需要做的是 download the source for line_profiler 并在 python_trace_callback 中摆弄。从当前执行帧（code = <object>py_frame.f_code）获取code对象后，添加以下内容：

if what == PyTrace_LINE or what == PyTrace_RETURN:
    code = <object>py_frame.f_code

    # Add entry for code object with different address if and only if it doesn't already
    # exist **but** the name of the function is in the code_map
    if code not in self.code_map and code.co_name in co.co_name for co in self.code_map:
        for co in self.code_map:
            # make condition as strict as necessary
            cond = co.co_name == code.co_name and co.co_code == code.co_code
            if cond:
                del self.code_map[co]
                self.code_map[code] = 

这会将self.code_map 中的代码对象替换为当前正在执行的与其名称和co.co_code 内容匹配的代码对象。 co.co_code 是 b'' 的 Cython，所以本质上匹配具有该名称的 Cython 函数。在这里它可以变得更加健壮并匹配code 对象的更多属性（例如，文件名）。

然后您可以继续使用python setup.py build_ext 构建它并使用sudo python setup.py install 进行安装。 我目前正在使用python setup.py build_ext --inplace 构建它，以便在本地使用它，我建议你也这样做。如果您确实使用--inplace 构建它，请确保在import 之前导航到包含line_profiler 源的文件夹。

因此，在包含为line_profiler 构建的共享库的文件夹中，我设置了一个包含您的函数的cyclosure.pyx 文件：

def outer_func(int n):
    def inner_func(int c):
        cdef int i
        for i in range(n):
             c+=i
        return c
    return inner_func

还有一个等效的 setup_cyclosure.py 脚本来构建它：

from distutils.core import setup
from distutils.extension import Extension
from Cython.Build import cythonize
from Cython.Compiler.Options import directive_defaults

directive_defaults['binding'] = True
directive_defaults['linetrace'] = True

extensions = [Extension("cyclosure", ["cyclosure.pyx"], define_macros=[('CYTHON_TRACE', '1')])]
setup(name = 'Testing', ext_modules = cythonize(extensions))

和之前一样，构建是使用python setup_cyclosure.py build_ext --inplace 执行的。

从当前文件夹启动您的解释器并发出以下命令会产生想要的结果：

>>> import line_profiler
>>> from cyclosure import outer_func
>>> f = outer_func(5)
>>> prof = line_profiler.LineProfiler(f)
>>> prof.runcall(f, 5)

15
>>> prof.print_stats()
Timer unit: 1e-06 s

Total time: 1.2e-05 s
File: cyclosure.pyx

Function: inner_func at line 2

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     2                                               def inner_func(int c):
     3                                                   cdef int i
     4         1            5      5.0     41.7          for i in range(n):
     5         5            6      1.2     50.0               c+=i
     6         1            1      1.0      8.3          return c  

IPython %%cython 的问题：

试图从IPython 运行它会导致不幸的情况。在执行时，code 对象不存储定义它的文件的路径，它只是存储文件名。由于我只是将code 对象放入self.code_map 字典中，并且由于代码对象具有只读属性，因此在使用IPython 时会丢失文件路径信息（因为它将%%cython 生成的文件存储在一个临时目录）。

因此，您确实获得了代码的分析统计信息，但您没有获得内容的内容。一个人可能能够在有问题的两个代码对象之间强制复制文件名，但这完全是另一个问题。

^*问题：

这里的问题是，由于某种原因，在处理嵌套和/或封闭函数时，代码对象在创建时和在 Python 框架之一中解释时的地址存在异常。您遇到的问题是由以下condition not being satisfied引起的：

    if code in self.code_map:

这很奇怪。在IPython 中创建函数并将其添加到LineProfiler 确实将其添加到self.code_map 字典中：

prof = line_profiler.LineProfiler(f)

prof.code_map
Out[16]: <code object inner_func at 0x7f5c65418f60, file "/home/jim/.cache/ipython/cython/_cython_magic_1b89b9cdda195f485ebb96a104617e9c.pyx", line 2>: 

到了实际测试前一个条件的时候，当前代码对象被code = <object>py_frame.f_code从当前执行帧中抢走，代码对象的地址不同：

 # this was obtained with a basic print(code) in _line_profiler.pyx
 code object inner_func at 0x7f7a54e26150

表示它已被重新创建。这只发生在Cython 以及在另一个函数中定义一个函数时。无论是这个还是我完全想念的东西。