调试用C编写的Python扩展名

Question

我非常熟悉编写C代码，并且在编写Python代码方面很舒服。我正在尝试学习如何在C上从Python-3.9.x拨打的C中编写模块，OSX 10.15.7。我已经获得了一些“ Hello World”示例，但是对于复杂的示例，我努力弄清楚我将如何调试我编写的C延伸。

MWE：

src/add.c

// The C function that actually does the work
static PyObject * add_c_func(PyObject *self, PyObject *args)
{
    int a=0;
    int b=0;
    int c=0;

    // This determines the number arguments used by add_c_func
    if (!PyArg_ParseTuple(args, "iii", &a, &b, &c))
    {
        return NULL;
    }

    printf("%i\n", a+b+c);

    Py_RETURN_NONE;
}

// This defines the function used by
static PyMethodDef AddMethods[] = {
    {"add_py_func", add_c_func, METH_VARARGS, "Add three numbers."},
    {NULL, NULL, 0, NULL}
};

static struct PyModuleDef addpymod =
{
    PyModuleDef_HEAD_INIT,
    "addpymod",     /* name of module */
    "",          /* module documentation, may be NULL */
    -1,          /* size of per-interpreter state of the module, or -1 if the module keeps state in global variables. */
    AddMethods
};

PyMODINIT_FUNC PyInit_addpymod(void)
{
    return PyModule_Create(&addpymod);
}

setup.py：

from setuptools import setup, Extension
setup(
    name='addpymod',
    version='1.0',
    description='Python Package with Hello World C Extension',
    ext_modules=[
        Extension(
            'addpymod',
            sources=['src/add.c'],
            py_limited_api=True)
    ],
)

编译/安装（默认情况下，它使用 clang ）：

python setup.py install

尝试调试：

(py-ext-test) local: understand-python-c-ext $ gdb
GNU gdb (GDB) 10.1
.
.
.
(gdb) b add.c : 20
No symbol table is loaded.  Use the "file" command.
Make breakpoint pending on future shared library load? (y or [n]) y
Breakpoint 1 (add.c : 20) pending.
(gdb) python
>import addpymod
>addpymod.add_py_func(10,10,10)   # Why didn't my breakpoint get hit?
>Quit
# This clearly failed, I'm not even sure where my stdout is

有多个这里的复杂性水平，我敢肯定我会被多个。

问题：

1. 如何使用 add.c 使用 gdb （首选）或可能 lldb ，因为它已编译为默认情况下使用 clang 's -g 选项？

Answer 1

使用 scikit-build-core 进行构建，但是关键是要使用调试构建构建。使用 Scikit -Build -core 可以使用：

[tool.scikit-build]
cmake.build-type = "Debug"

cmakelists.txt with：with with：

target_compile_options(my_ext PRIVATE -g -O0)

一旦您编译（例如 pip install -e。 -no-build-isolation ），仔细检查您的扩展名是否使用调试符号构建：

$objdump --syms /path/to/your/extension.so

您应该看到一张符号表。例如：

SYMBOL TABLE:
0000000000000000 l    df *ABS*  0000000000000000              crtstuff.c

然后，您将能够运行GDB并设置一个断点。例如：

$ gdb --args python test_ext.py
(gdb) b qual.cpp:4872
Make breakpoint pending on future shared library load? (y or [n]) y
Breakpoint 1 (qual.cpp:4872) pending.
(gdb) run
Thread 1 "python" hit Breakpoint 1, ComputeWeights<float> (offset=0x1fe5830, neigh=0x20432e0, 
indices=0x1bb8ec0, points=0x1d6a7a0, n_neigh=108, n_points=27, fac=-0.75, num_threads=4) at /home/user/library-path/src/qual.cpp:4872                                          
4872      T *weights = new T[n_neigh];
(gdb) 

Answer 2

@Alex Kaszynski是正确的，您缺少适当的编译标志来实现调试。由于您使用的是setUptools，因此您必须具体写作：

from setuptools import setup, Extension

compile_args = ["-g"]
setup(
    name='addpymod',
    version='1.0',
    description='Python Package with Hello World C Extension',
    ext_modules=[
        Extension(
            'addpymod',
            sources=['src/add.c'],
            py_limited_api=True,
            extra_compile_args=extra_compile_args,
        )
    ],
)

在这里我使用了-g，尽管您可以选择许多不同的调试标志如果您发现其他更适合

其价值的其他内容，我已经写了很多关于调试Python Extensions ”