pythoncythonline-profiler

Using the line-profiler (in ipython) on compiled Cython code


I read the answer to this question How to profile cython functions line-by-line, but I can't seem to get it to work with my setup.

I have a cumsum.pyx file:

# cython: profile=True
# cython: linetrace=True
# cython: binding=True
DEF CYTHON_TRACE = 1

def cumulative_sum(int n):
    cdef int s=0, i
    for i in range(n):
        s += i

    return s

I compiled it with:

cython cumsum.pyx
gcc cumsum.c $(pkg-config --cflags --libs python3) -o cumsum.so -shared -fPIC

Then I tried to profile it in ipython:

%load_ext line_profiler
from cumsum import cumulative_sum
%lprun -f cumulative_sum cumulative_sum(100)

I don't get an error message, only an empty profile:

Timer unit: 1e-06 s

Total time: 0 s
File: cumsum.pyx
Function: cumulative_sum at line 6

Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
     6                                           def cumulative_sum(int n):
     7                                               cdef int s=0, i
     8                                               for i in range(n):
     9                                                   s += i
    10                                           
    11                                               return s

How can I get this to work?

PS: I use CMake, not setup.py, so I would appreciate a build system agnostic solution


Solution

  • Turns out the issue was that DEF CYTHON_TRACE = 1 doesn't actually set the right constant.

    Workarounds include:

    1. MSeifert's answer, using distutils

    2. Changing the gcc line to

    gcc cumsum.c $(pkg-config --cflags --libs python3) -o cumsum.so -shared -fPIC -DCYTHON_TRACE=1
    

    3. Making an extra header trace.h and setting the constant there

     #define CYTHON_TRACE 1
    

    along with adding the following to cumsum.pyx

    cdef extern from "trace.h":
        pass
    

    4. With CMake, adding

    add_definitions(-DCYTHON_TRACE)