Python C扩展中如何使用PyObject* args解析参数实现带参helloworld
Python C扩展修改helloworld支持字符串入参的实现
必须调整的两个核心点
- 原helloworld绑定的方法标识
METH_NOARGS会让解释器直接拒绝任何传入的参数,即使C函数本身写了解析逻辑也收不到入参,必须将其替换为METH_VARARGS,和fib函数的入参标识保持一致 - 移除原helloworld函数中
Py_RETURN_NONE之后的冗余代码:该宏展开后会直接返回None,后续的return Py_None;是永远不会执行的死代码 - 使用
PyArg_ParseTuple完成入参解析,针对字符串类型的参数,匹配格式串s即可将Python传入的str对象转换为C端可直接使用的UTF-8字符串指针
可直接替换的代码实现
重写后的helloworld函数
static PyObject* helloworld(PyObject* self, PyObject* args) { char* user_name; // 解析单个字符串类型入参,解析失败自动抛出Python异常 if (!PyArg_ParseTuple(args, "s", &user_name)) { return NULL; } printf("Hello %s\n", user_name); Py_RETURN_NONE; }
更新后的方法注册表
找到模块初始化对应的myMethods数组,修改helloworld的方法标识:
static PyMethodDef myMethods[] = { { "helloworld", helloworld, METH_VARARGS, "Print hello message for the input name" }, { "fib", fib, METH_VARARGS, "Computes Fibonacci" }, { NULL, NULL, 0, NULL } };
编译完成后,在Python端调用helloworld("max")就会在C端输出Hello max。
常见使用场景补充
如果需要兼容原有无参调用的行为(即不传参时默认输出Hello Munir),可以通过调整参数格式串实现可选入参:
- 给接收的字符串变量设置默认值
- 把
PyArg_ParseTuple的格式串从"s"改为"|s",竖线代表后续参数为可选
static PyObject* helloworld(PyObject* self, PyObject* args) { // 设置默认名称 char* user_name = "Munir"; if (!PyArg_ParseTuple(args, "|s", &user_name)) { return NULL; } printf("Hello %s\n", user_name); Py_RETURN_NONE; }
注意事项
- 格式串
s会自动完成Python str对象到C UTF-8字符串的转换,不需要手动处理编码 - 解析得到的
char*指针指向Python字符串对象的内部内存,函数执行期间指针有效,不需要手动释放内存 - 如果用户传入非字符串类型的参数,
PyArg_ParseTuple会自动生成标准的TypeError提示,不需要手动做参数类型校验
内容的提问来源于stack exchange,提问作者Max Sattouf
相关产品推荐
相关产品推荐

