如何手动编译使用C++的Cython代码？

Question

我已经完全复制了Cython文档中给出的用于包装C++类的示例代码.我可以rect.so使用distutils和cythonize()方法成功构建和导入扩展,即:

1. 将以下指令放在顶部rect.pyx:

   # distutils: language = c++
   # distutils: sources = Rectangle.cpp
   

2. 编写setup.py包含以下内容的文件:

   from distutils.core import setup
   from Cython.Build import cythonize
   
   setup(
       name = "rectangleapp",
       ext_modules = cythonize('*.pyx'),
   )
   

3. 调用

   $ python setup.py build_ext --inplace
   

但是,当我在Cython中包装C代码时,我经常发现从命令行手动编译单个扩展更方便,即:

1. .c使用命令行Cython编译器生成代码

   $ cython foo.pyx
   

2. 使用gcc以下方法手动编译:

   $ gcc -shared -fPIC -O3 -I /usr/lib/python2.7 -L /usr/lib/python2.7 \
          foo.c -lpython2.7 -o foo.so
   

我尝试应用相同的过程来构建rect.so上面的示例:

$ cython --cplus rect.pyx
$ g++ -shared -fPIC -O3 -I /usr/lib/python2.7 -L /usr/lib/python2.7 \
      rect.cpp -lpython2.7 -o rect.so

Cython和g ++编译步骤似乎都成功了 - 我没有得到任何命令行输出,最后我有一个rect.so 内置.但是,当我尝试导入模块时,我收到一个undefined symbol错误:

In [1]: import rect
---------------------------------------------------------------------------
ImportError                               Traceback (most recent call last)
<ipython-input-1-ba16f97c2145> in <module>()
----> 1 import rect

ImportError: ./rect.so: undefined symbol: _ZN6shapes9Rectangle9getLengthEv

手动编译包装C++类的Cython代码的正确步骤是什么？

Answer 1

这里的问题是你说某个地方你将提供一个名为Rectangle的类的定义 - 示例代码说明了这一点

cdef extern from "Rectangle.h" namespace "shapes":
    cdef cppclass Rectangle:
        ...

但是,当您编译库时,您没有提供Rectangle的代码或包含它的库,因此rect.so不知道在哪里可以找到这个Rectangle类.

要运行代码,必须首先创建Rectangle对象文件.

gcc -c Rectangle.cpp # creates a file called Rectangle.o

现在,您可以创建一个库来动态链接或静态链接目标文件rect.so.我将首先介绍静态链接,因为它最简单.

gcc -shared -fPIC -I /usr/include/python2.7 rect.cpp Rectangle.o -o rect.so

请注意,我没有包含python库.这是因为您希望您的库由python解释器加载,因此加载库时,进程已经加载了python库.除了提供rect.cpp作为来源我还提供Rectangle.o.因此,让我们尝试使用您的模块运行程序.

run.py

import rect
print(rect.PyRectangle(0, 0, 1, 2).getLength())

不幸的是,这会产生另一个错

ImportError: /home/user/rectangle/rect.so undefined symbol: _ZTINSt8ios_base7failureE

这是因为cython需要c ++标准库,但是python没有加载它.您可以通过将c ++标准库添加到所需的库来解决此问题rect.so

gcc -shared -fPIC -I/usr/include/python2.7 rect.cpp Rectangle.o -lstdc++ \
     -o rect.so

run.py再次运行,一切都应该工作.但是,代码rect.so大于它需要的代码,特别是如果您生成依赖于相同代码的多个库.您可以动态链接Rectangle代码,也可以将其作为库.

gcc -shared -fPIC Rectangle.o -o libRectangle.so
gcc -shared -fPIC -I/usr/include/python2.7 -L. rect.cpp -lRectangle -lstdc++ \
     -o rect.so

我们将Rectangle代码编译到当前目录中的共享库中并提供,-L.以便gcc知道在当前目录中查找库,-lRectangle因此gcc知道要查找Rectangle库.最后,为了能够运行您的代码,您必须告诉python Rectangle库所在的位置.在运行python之前输入

export LD_LIBRARY_PATH="/home/user/rectangle" # where libRectangle.so lives

您可以使用shell脚本确保每次运行程序之前都执行此操作,但这会使事情变得更加混乱.最好只是坚持静态链接矩形.