使用Cython简单封装C代码

Question

我有一些C语言的函数，想从Python中调用它们。看起来使用cython是个不错的选择，但我找不到具体怎么做的例子。我的C函数长这样：

void calculate_daily ( char *db_name, int grid_id, int year,
                       double *dtmp, double *dtmn, double *dtmx, 
                       double *dprec, double *ddtr, double *dayl, 
                       double *dpet, double *dpar ) ;

我只想指定前面三个参数（一个字符串和两个整数），然后得到8个numpy数组（或者Python列表）。所有的双精度数组都有N个元素。我的代码假设这些指针指向的是已经分配好的内存块。此外，生成的C代码还需要链接一些外部库。

Answer 1

基本上，你可以这样写你的Cython函数，让它分配数组（记得要 cimport numpy as np）：

cdef np.ndarray[np.double_t, ndim=1] rr = np.zeros((N,), dtype=np.double)

然后把每个数组的 .data 指针传给你的C函数。这样应该就可以了。如果你不需要数组一开始就是零的话，可以用 np.empty 来提高一点速度。

可以查看文档中的 Cython for NumPy Users 教程（我已经修正了链接）。

Answer 2

下面这段Cython代码来自于 http://article.gmane.org/gmane.comp.python.cython.user/5625，它不需要明确的类型转换，并且可以处理不连续的数组：

def fpy(A):
    cdef np.ndarray[np.double_t, ndim=2, mode="c"] A_c
    A_c = np.ascontiguousarray(A, dtype=np.double)
    fc(&A_c[0,0])

Answer 3

这里有一个简单但完整的例子，展示如何把numpy数组传递给一个外部的C函数，逻辑上来说是这样的。

fc( int N, double* a, double* b, double* z )  # z = a + b

我们使用Cython来实现这个功能。 这对那些熟悉它的人来说肯定不陌生。 欢迎大家留言讨论。 最后修改时间：2011年2月23日，适用于Cython 0.14版本。

首先，建议你先阅读或浏览一下 Cython构建 和 Cython与NumPy 的内容。

整个过程分为两个步骤：

• python f-setup.py build_ext --inplace
  这一步将 f.pyx 和 fc.cpp 转换成 f.so，也就是一个动态库。
• python test-f.py
import f 会加载 f.so；接着 f.fpy( ... ) 会调用C中的 fc( ... )。

python f-setup.py 使用 distutils 来运行Cython，进行编译和链接：
cython f.pyx -> f.cpp
编译 f.cpp 和 fc.cpp
链接 f.o fc.o 生成 f.so， 这是一个动态库，Python通过 import f 来加载它。

对于学生来说，我建议：画一个这些步骤的流程图， 查看下面的文件，然后下载并运行它们。

(distutils 是一个庞大而复杂的包，用于创建和分发Python包，以及安装它们。 在这里，我们只使用了它的一小部分来编译和链接到 f.so。 这一步与Cython无关，但可能会让人感到困惑； 在 .pyx 文件中的简单错误可能会导致g++编译和链接时出现一堆晦涩的错误信息。 你也可以查看 distutils文档 和/或 关于distutils的SO问题。

就像 make 一样，setup.py 会在 f.pyx 比 f.cpp 更新时重新运行 cython f.pyx 和 g++ -c ... f.cpp。
要清理，可以使用 rm -r build/。

除了 setup.py，你还可以单独运行这些步骤，放在一个脚本或Makefile中：
cython --cplus f.pyx -> f.cpp # 查看 cython -h
g++ -c ... f.cpp -> f.o
g++ -c ... fc.cpp -> fc.o
cc-lib f.o fc.o -> 动态库 f.so。
根据你的平台和安装情况修改下面的 cc-lib-mac 包装器：虽然不太美观，但很小。

想要查看Cython包装C的真实例子， 可以看看几乎任何一个 SciKit 中的.pyx文件。

还可以查看： Cython为NumPy用户提供的指南 和 关于Cython的SO问题。

---

要解压以下文件， 把所有内容剪切粘贴到一个大文件中，比如叫 cython-numpy-c-demo， 然后在Unix系统中（在一个干净的新目录下）运行 sh cython-numpy-c-demo。

#--------------------------------------------------------------------------------
cat >f.pyx <<\!
# f.pyx: numpy arrays -> extern from "fc.h"
# 3 steps:
# cython f.pyx  -> f.c
# link: python f-setup.py build_ext --inplace  -> f.so, a dynamic library
# py test-f.py: import f gets f.so, f.fpy below calls fc()

import numpy as np
cimport numpy as np

cdef extern from "fc.h": 
    int fc( int N, double* a, double* b, double* z )  # z = a + b

def fpy( N,
    np.ndarray[np.double_t,ndim=1] A,
    np.ndarray[np.double_t,ndim=1] B,
    np.ndarray[np.double_t,ndim=1] Z ):
    """ wrap np arrays to fc( a.data ... ) """
    assert N <= len(A) == len(B) == len(Z)
    fcret = fc( N, <double*> A.data, <double*> B.data, <double*> Z.data )
        # fcret = fc( N, A.data, B.data, Z.data )  grr char*
    return fcret

!

#--------------------------------------------------------------------------------
cat >fc.h <<\!
// fc.h: numpy arrays from cython , double*

int fc( int N, const double a[], const double b[], double z[] );
!

#--------------------------------------------------------------------------------
cat >fc.cpp <<\!
// fc.cpp: z = a + b, numpy arrays from cython

#include "fc.h"
#include <stdio.h>

int fc( int N, const double a[], const double b[], double z[] )
{
    printf( "fc: N=%d a[0]=%f b[0]=%f \n", N, a[0], b[0] );
    for( int j = 0;  j < N;  j ++ ){
        z[j] = a[j] + b[j];
    }
    return N;
}
!

#--------------------------------------------------------------------------------
cat >f-setup.py <<\!
# python f-setup.py build_ext --inplace
#   cython f.pyx -> f.cpp
#   g++ -c f.cpp -> f.o
#   g++ -c fc.cpp -> fc.o
#   link f.o fc.o -> f.so

# distutils uses the Makefile distutils.sysconfig.get_makefile_filename()
# for compiling and linking: a sea of options.

# http://docs.python.org/distutils/introduction.html
# http://docs.python.org/distutils/apiref.html  20 pages ...
# https://stackoverflow.com/questions/tagged/distutils+python

import numpy
from distutils.core import setup
from distutils.extension import Extension
from Cython.Distutils import build_ext
# from Cython.Build import cythonize

ext_modules = [Extension(
    name="f",
    sources=["f.pyx", "fc.cpp"],
        # extra_objects=["fc.o"],  # if you compile fc.cpp separately
    include_dirs = [numpy.get_include()],  # .../site-packages/numpy/core/include
    language="c++",
        # libraries=
        # extra_compile_args = "...".split(),
        # extra_link_args = "...".split()
    )]

setup(
    name = 'f',
    cmdclass = {'build_ext': build_ext},
    ext_modules = ext_modules,
        # ext_modules = cythonize(ext_modules)  ? not in 0.14.1
    # version=
    # description=
    # author=
    # author_email=
    )

# test: import f
!

#--------------------------------------------------------------------------------
cat >test-f.py <<\!
#!/usr/bin/env python
# test-f.py

import numpy as np
import f  # loads f.so from cc-lib: f.pyx -> f.c + fc.o -> f.so

N = 3
a = np.arange( N, dtype=np.float64 )
b = np.arange( N, dtype=np.float64 )
z = np.ones( N, dtype=np.float64 ) * np.NaN

fret = f.fpy( N, a, b, z )
print "fpy -> fc z:", z

!

#--------------------------------------------------------------------------------
cat >cc-lib-mac <<\!
#!/bin/sh
me=${0##*/}
case $1 in
"" )
    set --  f.cpp fc.cpp ;;  # default: g++ these
-h* | --h* )
    echo "
$me [g++ flags] xx.c yy.cpp zz.o ...
    compiles .c .cpp .o files to a dynamic lib xx.so
"
    exit 1
esac

# Logically this is simple, compile and link,
# but platform-dependent, layers upon layers, gloom, doom

base=${1%.c*}
base=${base%.o}
set -x

g++ -dynamic -arch ppc \
    -bundle -undefined dynamic_lookup \
    -fno-strict-aliasing -fPIC -fno-common -DNDEBUG `# -g` -fwrapv \
    -isysroot /Developer/SDKs/MacOSX10.4u.sdk \
    -I/Library/Frameworks/Python.framework/Versions/2.6/include/python2.6 \
    -I${Pysite?}/numpy/core/include \
    -O2 -Wall \
    "$@" \
    -o $base.so

# undefs: nm -gpv $base.so | egrep '^ *U _+[^P]'
!

# 23 Feb 2011 13:38