@MjSeven
https://linux.cn/article-15405-1.html
This commit is contained in:
Xingyu Wang 2023-01-02 17:36:04 +08:00
parent 93a7b20dc1
commit 63af546078

View File

@ -3,14 +3,16 @@
[#]: author: "Stephan Avenwedde https://opensource.com/users/hansic99"
[#]: collector: "lkxed"
[#]: translator: "MjSeven"
[#]: reviewer: " "
[#]: publisher: " "
[#]: url: " "
[#]: reviewer: "wxy"
[#]: publisher: "wxy"
[#]: url: "https://linux.cn/article-15405-1.html"
为 Python 写一个 C++ 扩展模块
======
使用 C 扩展为 Python 提供特定功能。
![][0]
> 使用 C 扩展为 Python 提供特定功能。
在前一篇文章中,我介绍了 [六个 Python 解释器][1]。在大多数系统上CPython 是默认的解释器而且根据民意调查显示它还是最流行的解释器。Cpython 的独有功能是使用扩展 API 用 C 语言编写 Python 模块。用 C 语言编写 Python 模块允许你将计算密集型代码转移到 C同时保留 Python 的易用性。
@ -20,7 +22,7 @@
和往常一样,你可以在 [GitHub][3] 上找到相关的源代码。仓库中的 C++ 文件有以下用途:
- `my_py_module.cpp`: Python 模块 _MyModule_ 的定义
- `my_py_module.cpp`: Python 模块 `MyModule` 的定义
- `my_cpp_class.h`: 一个头文件 - 只有一个暴露给 Python 的 C++ 类
- `my_class_py_type.h/cpp`: Python 形式的 C++ 类
- `pydbg.cpp`: 用于调试的单独应用程序
@ -48,7 +50,7 @@ $ cmake --build build
首先,看一下 `my_py_module.cpp` 文件,尤其是 `PyInit_MyModule` 函数:
``` cpp
```
PyMODINIT_FUNC
PyInit_MyModule(void) {
PyObject* module = PyModule_Create(&my_module);
@ -72,15 +74,15 @@ PyInit_MyModule(void) {
无论是声明还是实例,所有 Python 类型都是 [PyObject][5] 的一个指针。在此函数的第一部分中,`module` 通过 `PyModule_Create(...)` 创建的。正如你在 `module` 详述(`my_py_module`,同名文件)中看到的,它没有任何特殊的功能。
之后,调用 [PyType_FromSpec][6] 为自定义类型 MyClass 创建一个 Python [堆类型][7]定义。一个堆类型对应于一个 Python 类,然后将它赋值给 MyModule 模块。
之后,调用 [PyType_FromSpec][6] 为自定义类型 `MyClass` 创建一个 Python [堆类型][7] 定义。一个堆类型对应于一个 Python 类,然后将它赋值给 `MyModule` 模块。
_注意如果其中一个函数返回失败则必须减少以前创建的复制对象的引用计数以便解释器删除它们。_
### 指定 Python 类型
MyClass 详设在 [my_class_py_type.h][8] 中可以找到,它作为 [PyType_Spec][9] 的一个实例:
`MyClass` 详述在 [my_class_py_type.h][8] 中可以找到,它作为 [PyType_Spec][9] 的一个实例:
```cpp
```
static PyType_Spec spec_myclass = {
"MyClass", // name
sizeof(MyClassObject) + sizeof(MyClass), // basicsize
@ -92,7 +94,7 @@ static PyType_Spec spec_myclass = {
它定义了一些基本类型信息,它的大小包括 Python 表示的大小(`MyClassObject`)和普通 C++ 类的大小(`MyClass`)。`MyClassObject` 定义如下:
```cpp
```
typedef struct {
PyObject_HEAD
int m_value;
@ -104,7 +106,7 @@ Python 表示的话就是 [PyObject][5] 类型,由 `PyObject_HEAD` 宏和其
[PyType_Slot][10] 定义了一些其他功能:
```cpp
```
static PyType_Slot MyClass_slots[] = {
{Py_tp_new, (void*)MyClass_new},
{Py_tp_init, (void*)MyClass_init},
@ -119,7 +121,7 @@ static PyType_Slot MyClass_slots[] = {
要完成类型详述,还包括下面的方法和成员表:
```cpp
```
static PyMethodDef MyClass_methods[] = {
{"addOne", (PyCFunction)MyClass_addOne, METH_NOARGS, PyDoc_STR("Return an incrmented integer")},
{NULL, NULL} /* Sentinel */
@ -139,7 +141,7 @@ static struct PyMemberDef MyClass_members[] = {
`MyClass_new` 方法只为 `MyClassObject` 提供一些初始值,并为其类型分配内存:
```cpp
```
PyObject *MyClass_new(PyTypeObject *type, PyObject *args, PyObject *kwds){
std::cout << "MtClass_new() called!" << std::endl;
@ -156,7 +158,7 @@ PyObject *MyClass_new(PyTypeObject *type, PyObject *args, PyObject *kwds){
实际的初始化发生在 `MyClass_init` 中,它对应于 Python 中的 [\_\_init__()][14] 方法:
```cpp
```
int MyClass_init(PyObject *self, PyObject *args, PyObject *kwds){
((MyClassObject *)self)->m_value = 123;
@ -197,7 +199,7 @@ int MyClass_init(PyObject *self, PyObject *args, PyObject *kwds){
从 Python 类中调用相关的 C++ 类方法很简单:
```cpp
```
PyObject* MyClass_addOne(PyObject *self, PyObject *args){
assert(self);
@ -225,7 +227,7 @@ GDB 使用脚本文件 [main.py][23] 调用 CPython 解释器,它允许你轻
另一种方法是将 CPython 解释器嵌入到一个单独的 C++ 应用程序中。可以在仓库的 [pydbg.cpp][24] 文件中找到:
```cpp
```
int main(int argc, char *argv[], char *envp[])
{
Py_SetProgramName(L"DbgPythonCppExtension");
@ -281,7 +283,7 @@ via: https://opensource.com/article/22/11/extend-c-python
作者:[Stephan Avenwedde][a]
选题:[lkxed][b]
译者:[MjSeven](https://github.com/MjSeven)
校对:[校对者ID](https://github.com/校对者ID)
校对:[wxy](https://github.com/wxy)
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译,[Linux中国](https://linux.cn/) 荣誉推出
@ -318,3 +320,4 @@ via: https://opensource.com/article/22/11/extend-c-python
[29]: https://github.com/hANSIc99/PythonCppExtension/blob/main/.vscode/launch.json
[30]: https://opensource.com/sites/default/files/2022-11/vscodium_debug_session.png
[31]: https://docs.python.org/3/c-api/stable.html
[0]: https://img.linux.net.cn/data/attachment/album/202301/02/173501o26htajatlpj0lqt.jpg