如何用C代碼給Python寫擴展庫(Cython)

更新時間：2019年05月17日 10:21:25 作者：jazz_bin

這篇文章主要介紹了如何用C代碼給Python寫擴展庫(Cython)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

之前一篇文章里提到了利用Cython來編譯Python，這次來講一下如何用Cython給Python寫擴展庫。

兩種語言混合編程，其中最重要的是類型的傳遞。

我們用一個簡單的例子進行入門：這次的目標(biāo)是用C語言寫一個Numpy的加法和元素相乘模塊。在本例中，Numpy的array被傳入到C語言模塊內(nèi)，變成了二維數(shù)組。

1. 頭文件main.h：

#ifndef _MAIN_H
#define _MAIN_H
void plus(double *a, double *b, double *r, int n, int m); // 矩陣加法
void mul(double *a, double *b, double *r, int n, int m); // 矩陣按元素相乘
void main(double *a, double *b, double *r, int n, int m, int times); // 用于測試的main函數(shù)
#endif

2. 把主要代碼寫在main.c中：

#include "main.h"
 
/***********************************
* 矩陣的加法
* 利用數(shù)組是順序存儲的特性, *
* 通過降維來訪問二維數(shù)組! *
* r
***********************************/
void plus(double *a, double *b, double *r, int n, int m)
{
  int i, j;
  for(i = 0; i < n; i++)
  {
    for(j = 0; j < m; j++)
      *(r + i*m + j) = *(a + i*m + j) + *(b + i*m + j);
  }
}
 
/***********************************
* 矩陣的按元素乘法
* 利用數(shù)組是順序存儲的特性, *
* 通過降維來訪問二維數(shù)組! *
* r
***********************************/
void mul(double *a, double *b, double *r, int n, int m)
{
  int i, j;
  for(i = 0; i < n; i++)
  {
    for(j = 0; j < m; j++)
      *(r + i*m + j) = *(a + i*m + j) * *(b + i*m + j);
  }
}
 
/***********************************
* main函數(shù)
* 利用數(shù)組是順序存儲的特性, *
* 通過降維來訪問二維數(shù)組! *
* r
***********************************/
void main(double *a, double *b, double *r, int n, int m, int times)
{
  int i;
  // 循環(huán)times次
#pragma omp parallel for
  for (i = 0; i < times; i++)
  {
    // 矩陣的加法
    plus(a, b, r, n, m);
    
    // 矩陣按元素相乘
    mul(a, b, r, n, m);
  }
}

這個main.c中實現(xiàn)了矩陣的加法、矩陣按元素相乘的功能，用到的數(shù)據(jù)結(jié)構(gòu)是二維數(shù)組，但是因為C語言中給函數(shù)傳遞二維數(shù)組比較麻煩，這里用降維的方法實現(xiàn)。另外在main()函數(shù)中，采用一個循環(huán)來進行測試，以測試性能。

3. 下面編寫test.pyx文件來調(diào)用上述C函數(shù)（注意，后綴是.pyx噢）：詳細(xì)的知識點在注釋中寫出來了~

# 既要import numpy, 也要用cimport numpy
import time
import numpy as np
cimport numpy as np
 
# 使用Numpy-C-API
np.import_array()
 
# cdefine C 函數(shù)
cdef extern from "main.h":
  void plus(double *a, double *b, double *r, int n, int m)
  void mul(double *a, double *b, double *r, int n, int m)
  void main(double *a, double *b, double *r, int n, int m, int times)
 
"""
# 定義一個"包裝函數(shù)", 用于調(diào)用C語言的main函數(shù)，調(diào)用范例：plus_fun(a, b, r)
# 在這里要注意函數(shù)傳入的參數(shù)的類型聲明，double表示數(shù)組的元素是double類型的，
# ndim = 2表示數(shù)組的維度是2
# 在調(diào)用main函數(shù)時，要把python的變量強制轉(zhuǎn)化成相應(yīng)的類型（以確保無誤），比如<int>
# 當(dāng)然，基本類型如int，可以不顯式地寫出來，如下面的a.shape[0]、a.shape[1]
"""
def main_func(np.ndarray[double, ndim=2, mode="c"] a not None,
           np.ndarray[double, ndim=2, mode="c"] b not None, 
           np.ndarray[double, ndim=2, mode="c"] r not None,
           times not None):
  main(<double*> np.PyArray_DATA(a),
        <double*> np.PyArray_DATA(b),
        <double*> np.PyArray_DATA(r),
        a.shape[0],
        a.shape[1],
        <int> times)

4. 為了用Cython編譯上述代碼，我們創(chuàng)建一個setup.py文件：

import numpy
from distutils.core import setup
from distutils.extension import Extension
from Cython.Distutils import build_ext
 
filename = 'test' # 源文件名
full_filename = 'test.pyx' # 包含后綴的源文件名
 
setup(
  name = 'test',
  cmdclass = {'build_ext': build_ext},
  ext_modules=[Extension(filename,sources=[full_filename, "main.c"],
         include_dirs=[numpy.get_include()])],
)

5. 上述的main.h、main.c、test.pyx一定要放在同一個文件夾下。此時在該文件夾下按住shift鍵，然后右擊鼠標(biāo)，打開cmd或PowerShell控制臺，在控制臺中運行以下命令進行Cython編譯：

python setup.py build_ext --i

或者：

python setup.py build_ext --inplace

編譯成功的圖例：

此時在同目錄下會生成“test.cp36-win_amd64.pyd”的二進制碼文件，它是閉源的，但是可以直接用python來import。下面編寫測試代碼main.py來進行測試：

import test
import time
import numpy as np
 
start_time = time.time()
a = np.random.rand(100, 100) * 2 - 1 # 生成300*300的隨即矩陣
b = np.random.rand(100, 100) * 2 - 1
r = np.empty_like(a) # 創(chuàng)建一個空矩陣，用來存儲計算結(jié)果
test.main_func(a, b, r, 500000) # 調(diào)用main_func進行測試
end_time = time.time()
print(end_time - start_time) # 輸出時間
print(r) # 輸出運行結(jié)果

執(zhí)行結(jié)果：