C++扩展python modules

函数详情

#<Python.h>

C语言扩展python

PyObject 所有的python扩展类型对象

描述所有python对象再C中的对象

PyMethodDef 描述扩展type方法的struct

自定义Python 方法

域 C 类型含义

ml_name char * name of the method

ml_meth PyCFunction pointer to the C implementation

ml_flags 整型 flag bits indicating how the call should be constructed

ml_doc char * points to the contents of the docstring

ml_flags: 可选值有 METH_VARARGS 、 METH_VARARGS | METH_KEYWORDS，如果单独使用 METH_VARARGS ，函数会接受Python tuple格式的参数，并使用 PyArg_ParseTuple() 解析。METH_KEYWORDS 表示接受关键字参数，这种情况下C函数需要接受第三个 PyObject * 对象，表示字典参数，使用 PyArg_ParseTupleAndKeywords() 解析参数。

PyMODINIT_FUNC 定义返回值为void的python moudle

声明函数的返回值为void，在python3中返回PyObject * ，声明为python module

PyArg_ParseTuple

int PyArg_ParseTuple(PyObject *arg, char *format, ...)
arg：元组，代表python的参数列表
format：格式化字符串
 解析一个函数的参数，表达式中的参数按参数位置顺序存入局部变量中。成功返回true；失败返回false并且引发相应的异常 

示例：
 int ok;
 int i, j;
 long k, l;
 char *s;
 int size;
 ok = PyArg_ParseTuple(args, "");/* No arguments */
 /* Python call: f() */
 ok = PyArg_ParseTuple(args, "s",&s); /* A string */
 /* Possible Python call: f('whoops!')*/
 ok = PyArg_ParseTuple(args,"lls", &k, &l, &s); /* Two longs and a string */
 /* Possible Python call: f(1, 2,'three') */
 ok = PyArg_ParseTuple(args,"(ii)s#", &i, &j, &s, &size);
 /* A pair of ints and a string, whosesize is also returned */
 /* Possible Python call: f((1, 2),'three') */
 {
 char *file;
 char *mode = "r";
 int bufsize = 0;
 ok = PyArg_ParseTuple(args,"s|si", &file, &mode, &bufsize);
 /* A string, and optionally anotherstring and an integer */
 /* Possible Python calls:
 f('spam')
 f('spam', 'w')
 f('spam', 'wb', 100000) */
 }

 {
 int left, top, right, bottom, h, v;
 ok = PyArg_ParseTuple(args,"((ii)(ii))(ii)",
 &left, &top,&right, &bottom, &h, &v);
 /* A rectangle and a point */
 /* Possible Python call:
 f(((0, 0), (400, 300)), (10, 10)) */
 }

 {
 Py_complex c;
 ok = PyArg_ParseTuple(args,"D:myfunction", &c);
 /* a complex, also providing a functionname for errors */
 /* Possible Python call:myfunction(1+2j) */

 }
Py_BuildValue 创建python对象为C对象
PyObject* Py_BuildValue( const char *format, ...)
format：格式化字符串

PyInit_sample 模块初始化函数

该模块第一次被导入时执行

Py_InitModule (python3, PyModule_Create) 创建python modlue
PyObject* Py_InitModule(char *name, PyMethodDef *methods)
name：module的名称
methods：module的方法

根据给定的name和function，创建新的python modlue

PyLong_FromLong 转化C long为python 对象
PyObject* PyLong_FromLong(long v)
v：C long

PyLong_AsLong 转化python的long对象为C long
long PyLong_AsLong(PyObject *pylong)
pylong：python long对象

Py_None Python None 对象

 Python None 对象，表示缺乏值。 

C语言调用python

PyImport_AppendInittab 增加一个python build-in module
int PyImport_AppendInittab(const char *name, void (*initfunc)(void))
name：模块名称
initfunc：模块init dunction

 调用python sys.module，添加一个自定module

Py_Initialize 初始化python模块
void Py_Initialize()

初始化python解释器，须在调用所有Python/C API之前调用 

Py_Finalize 释放模块
void Py_Finalize()

释放所有初始化和调用的Python/C API的资源 

PyImport_ImportModule 加载python模块
PyObject* PyImport_ImportModule(const char *name)
name：需要导入modlue name

PyObject_GetAttrString 获取对象值
PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name)
o：python对象
attr_name：调用对象name

获取o的attr_name的值，o.attr_name

PyEval_CallObject 调用函数

PyObject* PyEval_CallObject(PyObject* pfunc, PyObject*pargs)
pfunc：调用函数
pargs：函数参数列表

PyObject_CallObject() 返回Python对象指针，这也是Python函数的返回值。 PyObject_CallObject() 是一个对其参数 “引用计数无关” 的函数。例子中新的元组创建用于参数列表，并且在 PyObject_CallObject() 之后立即使用了 Py_DECREF() 。

PyEval_CallObject() 的返回值总是“新”的：要么是一个新建的对象；要么是已有对象，但增加了引用计数。所以除非你想把结果保存在全局变量中，你需要对这个值使用 Py_DECREF()，即使你对里面的内容（特别！）不感兴趣。

PyList_New 创建python列表的C对象
PyObject* PyList_New( Py_ssize_t len)
len： 列表长度

PyList_SetItem 给列表添加元素
int PyList_SetItem( PyObject *list, Py_ssize_t index, PyObject *item)
list： python list的C对象
index： 索引位置
item： 列表值

PyList_GetItem 获取列表的值
PyObject* PyList_GetItem( PyObject *list, Py_ssize_t index)
list：python list的C对象
index：索引位置

Py_CLEAR & Py_DECREF 释放资源
void Py_CLEAR( PyObject *o)
void Py_DECREF( PyObject *o)
o： Python的C对象

Py_CLEAR的参数可以为NULL

PyObject_CallObject 调用python函数
PyObject* PyObject_CallObject( PyObject *callable_object, PyObject *args)
callable_object： python的函数对象
args： 参数列表(元组)

PyObject_CallFunction 调用python函数
PyObject* PyObject_CallFunction( PyObject *callable, char *format, ...)
callable：python的函数对象
format：参数类型(格式化字符串)

PyObject_CallMethod 调用python函数

PyObject* PyObject_CallMethod(PyObject o*, char method, char **format, ...)
o：python module的C对象
method：函数名
format：格式化字符串，函数参数
PyArg_ParseTuple 获取扩展函数参数
int PyArg_ParseTuple(PyObject *arg, char *format, ...)
args： python的函数对象
format： 参数列表(元组)

解析一个函数的参数，表达式中的参数按参数位置顺序存入局部变量中 

PyRun_SimpleString 调用python源码code

int PyRun_SimpleString(const char **command*)
command：python 调用源码code

Format格式化字符串

s (string or Unicode) [const char *]

转化python的字符串或者Unicode对象为C的char指针

s# (string, Unicode or any read buffer compatible object) [const char *, int (or Py_ssize_t, see below)

 转化python的字符串或者Unicode对象为两个C变量，一个是字符指针，另一个是字符串长度

s* (string, Unicode, or any buffer compatible object) [Py_buffer]

同s#

z (string, Unicode or None) [const char *]

和s类似，字符串可以为None

z# (string, Unicode, None or any read buffer compatible object) [const char *, int]

 同s#

z* (string, Unicode, None or any buffer compatible object) [Py_buffer]

同s* 

u (Unicode) [Py_UNICODE *]

转化python Unicode为C 16-bit Unicode指针

u# (Unicode) [Py_UNICODE *, int]

转化python Unicode为两个C对象，一个为C 16-bit Unicode指针，另一个是长度

es (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer]

转化python encoding Unicode为C encoding指针，只对encoded的数据生效

et (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer]

与es类似，只适用于8-bits字符串

es# (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer, int *buffer_length]

类似s#，输出字符串长度

et# (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer, int *buffer_length]

同es#

b (integer) [unsigned char]

 转化非负的Python整型为无符号的微整型，存储在一个C unsigned char 类型中 

B (integer) [unsigned char]

 将一个Python整型转化成一个微整型并不检查溢出问题，存储在一个C unsigned char 类型中 

h (integer) [short int]

 将一个Python整型转化成一个C short int 短整型 

H (integer) [unsigned short int]

 将一个Python整型转化成一个C unsigned short int 无符号短整型，并不检查溢出问题

i (integer) [int]

 将一个Python整型转化成一个C int 整型

I (integer) [unsigned int]

 将一个Python整型转化成一个C unsigned int 无符号整型，并不检查溢出问题 

l (integer) [long int]

 将一个Python整型转化成一个C long int 长整型 

k (integer) [unsigned long]

转化python的int为一个C unsigned long 

L (integer) [PY_LONG_LONG]

转化python的int为一个C long long

K (integer) [unsigned PY_LONG_LONG]

转化python的int为一个C unsigned long long

n (integer) [Py_ssize_t]

转化python的int为一个C Py_ssize_t 

c (string of length 1) [char]

转化python的长度为1的字符串为C char

f (float) [float]

转化python的float为一个C float

d (float) [double]

 将一个Python浮点数转化成一个C double 双精度浮点数 

D (complex) [Py_complex]

将一个Python复数类型转化成一个C Py_complex Python复数类型

O (object) [PyObject *]

>将一个Python对象存入一个C指针

O! (object) [typeobject, PyObject *]

将一个Python对象存入一个C指针。和 O 类似，但是需要两个C参数：第一个是Python类型对象的地址，第二个是存储对象指针的C变量( PyObject* 变量)的地址。如果Python对象类型不对，会抛出 TypeError 异常

O& (object) [converter, anything]

转化一个python对象，通过一个converter函数转化C对象

S (string) [PyStringObject *]

和O类似，但是必须是python的string对象

U (Unicode string) [PyUnicodeObject *]

和O类似，但是必须是python的 Unicode string对象

t# (read-only character buffer) [char *, int]

和s#类似，但是必须是python的只读buffer

w (read-write character buffer) [char *]

和s类似，但是必须是所有python 读写buffer接口

w# (read-write character buffer) [char *, Py_ssize_t]

和s#类似，但是必须是所有python 读写buffer接口

w* (read-write byte-oriented buffer) [Py_buffer]

和s*类似

(items) (tuple) [matching-items]

 对象必须是Python序列，它的长度是 items 中格式单元的数量。C参数必须对应 items 中每一个独立的格式单元。序列中的格式单元可能有嵌套 

|

参数可选

:

格式单元的列表结束标志；冒号后的字符串被用来作为错误消息中的函数名(PyArg_ParseTuple() 函数引发的“关联值”异常)

;

格式单元的列表结束标志；分号后的字符串被用来作为错误消息取代默认的错误消息。 : 和 ; 相互排斥

域	C 类型	含义
`ml_name`	char *	name of the method
`ml_meth`	PyCFunction	pointer to the C implementation
`ml_flags`	整型	flag bits indicating how the call should be constructed
`ml_doc`	char *	points to the contents of the docstring

扩展python示例

C++代码，great_module.c

#include <Python.h>

int great_sum(int a,int b) {
    return a + b;
}

void great_hello(){
    printf("Hello world!");
}

static PyObject * _great_sum(PyObject *self, PyObject *args)
{
    int _a,_b;
    int res;

    if (!PyArg_ParseTuple(args, "ii", &_a, &_b))
        return NULL;
    res = great_sum(_a, _b);
    return PyLong_FromLong(res);
}

static PyObject * _great_hello(PyObject *self, PyObject *args)
{
    if (!PyArg_ParseTuple(args, ""))
        return NULL;
    great_hello();
    return Py_None;
}

static PyMethodDef GreateModuleMethods[] = { 
    {"hello", _great_hello, METH_VARARGS, "Print the 'Hello World!'"},
    {"sum", _great_sum, METH_VARARGS, "sum(int a,int b)"},
    {NULL, NULL, 0, NULL}
};
PyMODINIT_FUNC initgreat_module(void) {
    (void) Py_InitModule("great_module", GreateModuleMethods);
}

python setup

#!/usr/bin/env python
#-- coding:utf-8 -*-


from setuptools import setup, Extension


hello_world = Extension('great_module', sources=["great_module.c"])
setup(name='great_module',
      version='1.0',
      description='This is a package for my first module.',    
      ext_modules=[hello_world]
      )

c++调用python， build_in_module.c

#include "great_module.c"

int main()
{
    PyImport_AppendInittab("great_module", &initgreat_module);
    Py_InitializeEx(0);        
    PyRun_SimpleString("import great_module");
    PyRun_SimpleString("great_module.hello()");
    PyRun_SimpleString("s = great_module.sum(1,2)");
    PyRun_SimpleString("print s");
    Py_Finalize();
    return 0;
}

build_in_import_module.cc

#include "great_module.c"

int main()
{
    PyObject * pModule = NULL;
    PyObject * pFunc = NULL;
    PyObject * pReturn = NULL;

    PyImport_AppendInittab("great_module", &initgreat_module);
    Py_InitializeEx(0);

    pModule =  PyImport_ImportModule("great_module");
    pFunc = PyObject_GetAttrString(pModule, "hello");
    PyObject_CallObject(pFunc,NULL);
    
    int sum;
    pFunc = PyObject_GetAttrString(pModule, "sum");
    pReturn = PyObject_CallObject(pFunc,Py_BuildValue("ii", 1, 2));
    PyArg_Parse(pReturn,"i",&sum);
    printf(": %d",sum);
    printf("\n sum:: %d",PyLong_AsLong(pReturn));

    pReturn = PyObject_CallMethod(pModule,"sum","(i,i)",10,20);
    printf("\n sum:: %d",PyLong_AsLong(pReturn));
    pReturn = PyObject_CallFunction(pFunc, "ii",3,2);
    printf("\n sum:: %d",PyLong_AsLong(pReturn));
    
    Py_DECREF(pReturn);

    Py_Finalize();
    return 0;
}

文档查询

https://docs.python.org/zh-cn/3.7/genindex-P.html

编译gcc

gcc build_in_module.c -I/usr/include/python2.7 -lpython2.7

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 212,657评论 6赞 492
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,662评论 3赞 385
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 158,143评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,732评论 1赞 284
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 65,837评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,036评论 1赞 291
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,126评论 3赞 410
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,868评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,315评论 1赞 303
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,641评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,773评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,470评论 4赞 333
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,126评论 3赞 317
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,859评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,095评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,584评论 2赞 362
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,676评论 2赞 351

C++扩展python modules

#<Python.h>

C语言扩展python

示例：

C语言调用python

Format格式化字符串

推荐阅读更多精彩内容