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

How can I manually compile Cython code that uses C++?

本文关键字:Cython 代码 C++ 何手动 编译      更新时间:2023-10-16

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

  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. 使用命令行Cython编译器生成.c代码

    $ 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代码的正确过程是什么?

这里的问题是,您说过在某个地方您将提供一个名为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。因此,让我们尝试使用您的模块运行一个程序。

运行.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的代码比它需要的要大,特别是如果您生成依赖于同一代码的多个库。您可以动态链接矩形代码,使其成为一个库。

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矩形库所在的位置。在运行python之前,请输入

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

您可以使用shell脚本来确保每次运行程序之前都能完成这项工作,但这会使事情变得更加混乱。最好只使用静态链接矩形。