Python優化技巧之利用ctypes提高執行速度

首先給大家分享一個個人在使用python的ctypes調用c庫的時候遇到的一個小坑

這次出問題的地方是一個C函數，返回值是malloc生成的字符串地址。平常使用也沒問題，也用了有段時間， 沒發現什么異常。

這次在測試中，發現使用這個過程會出現“段錯誤”，造成程序退出了。

經過排查， 確定問題原因是C函數的返回值問題，ctypes默認的函數返回類型是int類型。

需要在使用中設置返回類型，例如：

func.restype = c_char_p

下面我們就來詳細探討下ctypes的使用小技巧

ctypes 庫可以讓開發者借助C語言進行開發。這個引入C語言的接口可以幫助我們做很多事情,比如需要調用C代碼的來提高性能的一些小型問題。通過它你可以接入Windows系統上的 kernel32.dll 和 msvcrt.dll 動態鏈接庫,以及Linux系統上的 libc.so.6 庫。當然你也可以使用自己的編譯好的共享庫

我們先來看一個簡單的例子 我們使用 Python 求 1000000 以內素數，重復這個過程10次，并計算運行時間。    
import math
from timeit import timeit
 
 
def check_prime(x):
  values = xrange(2, int(math.sqrt(x)) + 1)
  for i in values:
    if x % i == 0:
      return False
  return True
 
 
def get_prime(n):
  return [x for x in xrange(2, n) if check_prime(x)]
 
print timeit(stmt='get_prime(1000000)', setup='from __main__ import get_prime',
       number=10)

Output

42.8259568214

下面用C語言寫一個的 check_prime 函數,然后把它當作共享庫(動態鏈接庫)導入

使用以下命令生成 .so (shared object)文件

gcc -shared -o prime.so -fPIC prime.c    
import ctypes
import math
from timeit import timeit
check_prime_in_c = ctypes.CDLL('./prime.so').check_prime
 
 
def check_prime_in_py(x):
  values = xrange(2, int(math.sqrt(x)) + 1)
  for i in values:
    if x % i == 0:
      return False
  return True
 
 
def get_prime_in_c(n):
  return [x for x in xrange(2, n) if check_prime_in_c(x)]
 
 
def get_prime_in_py(n):
  return [x for x in xrange(2, n) if check_prime_in_py(x)]
 
 
py_time = timeit(stmt='get_prime_in_py(1000000)', setup='from __main__ import get_prime_in_py',
         number=10)
c_time = timeit(stmt='get_prime_in_c(1000000)', setup='from __main__ import get_prime_in_c',
        number=10)
print "Python version: {} seconds".format(py_time)
 
print "C version: {} seconds".format(c_time)

Output    
Python version: 43.4539749622 seconds
C version: 8.56250786781 seconds

我們可以看到很明顯的性能差距 這里 有更多的方法去判斷一個數是否是素數

再來看一個復雜點的例子 快速排序

mylib.c
    
#include <stdio.h>
 
typedef struct _Range {
  int start, end;
} Range;
 
Range new_Range(int s, int e) {
  Range r;
  r.start = s;
  r.end = e;
  return r;
}
 
void swap(int *x, int *y) {
  int t = *x;
  *x = *y;
  *y = t;
}
 
void quick_sort(int arr[], const int len) {
  if (len <= 0)
    return;
  Range r[len];
  int p = 0;
  r[p++] = new_Range(0, len - 1);
  while (p) {
    Range range = r[--p];
    if (range.start >= range.end)
      continue;
    int mid = arr[range.end];
    int left = range.start, right = range.end - 1;
    while (left < right) {
      while (arr[left] < mid && left < right)
        left++;
      while (arr[right] >= mid && left < right)
        right--;
      swap(&arr[left], &arr[right]);
    }
    if (arr[left] >= arr[range.end])
      swap(&arr[left], &arr[range.end]);
    else
      left++;
    r[p++] = new_Range(range.start, left - 1);
    r[p++] = new_Range(left + 1, range.end);
  }
}

gcc -shared -o mylib.so -fPIC mylib.c

使用ctypes有一個麻煩點的地方是原生的C代碼使用的類型可能跟Python不能明確的對應上來。比如這里什么是Python中的數組？列表？還是 array 模塊中的一個數組。所以我們需要進行轉換

test.py
    
import ctypes
import time
import random
 
quick_sort = ctypes.CDLL('./mylib.so').quick_sort
nums = []
for _ in range(100):
  r = [random.randrange(1, 100000000) for x in xrange(100000)]
  arr = (ctypes.c_int * len(r))(*r)
  nums.append((arr, len(r)))
 
init = time.clock()
for i in range(100):
  quick_sort(nums[i][0], nums[i][1])
print "%s" % (time.clock() - init)

Output

1.874907

與Python list 的 sort 方法進行對比
?    
import ctypes
import time
import random
 
quick_sort = ctypes.CDLL('./mylib.so').quick_sort
nums = []
for _ in range(100):
  nums.append([random.randrange(1, 100000000) for x in xrange(100000)])
 
init = time.clock()
for i in range(100):
  nums[i].sort()
print "%s" % (time.clock() - init)

Output

2.501257

至于結構體，需要定義一個類，包含相應的字段和類型    
class Point(ctypes.Structure):
  _fields_ = [('x', ctypes.c_double),
        ('y', ctypes.c_double)]

除了導入我們自己寫的C語言擴展文件，我們還可以直接導入系統提供的庫文件，比如linux下c標準庫的實現 glibc    
import time
import random
from ctypes import cdll
libc = cdll.LoadLibrary('libc.so.6') # Linux系統
# libc = cdll.msvcrt # Windows系統
init = time.clock()
randoms = [random.randrange(1, 100) for x in xrange(1000000)]
print "Python version: %s seconds" % (time.clock() - init)
init = time.clock()
randoms = [(libc.rand() % 100) for x in xrange(1000000)]
print "C version : %s seconds" % (time.clock() - init)

Output
    
Python version: 0.850172 seconds
C version : 0.27645 seconds
以上都是ctypes的基本技巧，對普通的開發人員來說，基本夠用了