深入浅析 C++ 调用 Python 模块

当我们需要使用Python第三方库或者调用Python脚本时，我们可以选择使用C++来完成这样的需求。本文将为您提供如何使用C++调用Python模块的完整攻略。

环境配置

首先我们需要确认系统环境中是否已经安装Python以及需要使用的Python第三方库。若没有安装，则需要前往Python官网进行下载并安装；若已经安装，可以通过pip或conda安装相应Python库。

在C++编译前也需确保已安装Boost.Python库，可前往Boost官网进行下载。

编译配置

为了能够将C++代码与Python模块连接起来，我们需要进行编译配置。可以将该操作分为两个步骤：

1. 编写Python模块的C++接口，并生成动态链接库；

2. 在C++中进行调用，连接Python模块。

下面将以具体的代码示例进行阐述：

编写Python模块的C++接口

#include <boost/python.hpp>
#include <string>

namespace py = boost::python;

// 函数
int add(int a, int b)
{
    return a + b;
}

// 类
class Person
{
public:
    std::string name;
    int age;

public:
    Person(const std::string &name, int age)
        : name(name), age(age)
    {}

    std::string greet()
    {
        return "Hello, " + name + "!";
    }

    void setAge(int newAge)
    {
        age = newAge;
    }

    int getAge()
    {
        return age;
    }
};

// 初始化Python模块
BOOST_PYTHON_MODULE(myModule)
{
    // 函数
    py::def("add", add);

    // 类
    py::class_<Person>("Person", py::init<const std::string &, int>())
        .def("greet", &Person::greet)
        .def("setAge", &Person::setAge)
        .def("getAge", &Person::getAge);
}

上述代码中，使用了Boost.Python库的相关类、模板和函数，例如：boost::python、py::def、py::class_等等。接下来将说明这些不同对象的作用：

1. Boost.Python库的命名空间定义在boost::python中，包含了所有需要用到的类和函数。

2. py::def用来定义C++中的函数或方法，在Python中可以直接作为函数使用。

3. py::class_用来定义C++中的类，可以提供不同的构造函数、方法或属性，并在Python中使用这些定义好的接口。

生成动态链接库

我们可以使用如下命令来生成动态链接库：

g++ -Wall -g -shared -fPIC \ 
    -I/usr/include/python2.7 \ 
    -lboost_python \
    myModule.cpp \
    -o myModule.so

其中：

1. -Wall和-g用来开启编译器的警告和调试开关；

2. -shared使用来生成共享库，即动态链接库；

3. -fPIC表示编译出的目标文件时位置独立的，可以被动态链接库使用；

4. -I用来指定头文件的目录，这里指定的是Python的头文件路径；

5. -l用来指定链接时使用的库文件，在此处使用Boost.Python库；

6. myModule.cpp指定我们需要编译的C++代码文件；

7. -o指定编译完成后生成的目标文件名和路径。

执行成功后，我们就可以看到生成了一个名为“myModule.so”的动态链接库文件。

连接Python模块

在C++中连接Python模块，我们可以使用以下代码：

#include <boost/python.hpp>
#include <iostream>

namespace py = boost::python;

int main()
{
    // 初始化Python解释器
    Py_Initialize();

    // 将Python模块载入
    py::object module = py::import("myModule");

    // 调用Python模块中的函数add
    int x = py::extract<int>(module.attr("add")(1, 2));
    std::cout << "1 + 2 = " << x << std::endl;

    // 实例化Python模块中的Person类
    py::object personClass = module.attr("Person");
    py::object personObj = personClass("Joe", 20);

    // 调用Python模块中Person类中的方法
    std::string greet = py::extract<std::string>(personObj.attr("greet")());
    std::cout << greet << std::endl;

    // 调用Python模块中Person类中的方法
    personObj.attr("setAge")(25);
    int age = py::extract<int>(personObj.attr("getAge")());
    std::cout << "Age: " << age << std::endl;

    // 释放Python解释器
    Py_Finalize();

    return 0;
}

以上代码中，我们使用Py_Initialize()和Py_Finalize()函数来初始化和释放Python解释器，使用py::import函数来载入Python模块。并使用py::object来接收Python模块、类和对象。

示例

下面给出两个完整的示例，以便更好地理解上述的操作。

示例1

Python代码

该示例中，Python中定义了一个可以将输入的字符串进行反转的函数reverse_string()。

# MyModule.py

def reverse_string(string):
    return string[::-1]

C++代码

#include <boost/python.hpp>
#include <iostream>

namespace py = boost::python;

int main()
{
    // 初始化Python解释器
    Py_Initialize();

    // 将Python模块载入
    py::object module = py::import("MyModule");

    // 调用Python模块中的函数
    std::string str = "Hello, World!";
    py::str pystr(str);
    py::str result = py::extract<py::str>(module.attr("reverse_string")(pystr));
    std::string reverseStr = py::extract<std::string>(result);
    std::cout << "Reverse string: " << reverseStr << std::endl;

    // 释放Python解释器
    Py_Finalize();

    return 0;
}

以上代码中，我们实现了将字符串"Hello, World!"反转，并输出结果。

示例2

Python代码

该示例中，Python中定义了一个Person类，具有name和age属性，以及greet()、setAge()、getAge()等方法。

# MyModule.py

class Person(object):
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def greet(self):
        return "Hello, " + self.name + "!"

    def setAge(self, newAge):
        self.age = newAge

    def getAge(self):
        return self.age

C++代码

#include <boost/python.hpp>
#include <iostream>

namespace py = boost::python;

int main()
{
    // 初始化Python解释器
    Py_Initialize();

    // 将Python模块载入
    py::object module = py::import("MyModule");

    // 实例化Python模块中的Person类
    py::object personClass = module.attr("Person");
    py::object personObj = personClass("Joe", 20);

    // 调用Python模块中Person类中的方法
    std::string greet = py::extract<std::string>(personObj.attr("greet")());
    std::cout << greet << std::endl;

    // 调用Python模块中Person类中的方法
    personObj.attr("setAge")(25);
    int age = py::extract<int>(personObj.attr("getAge")());
    std::cout << "Age: " << age << std::endl;

    // 释放Python解释器
    Py_Finalize();

    return 0;
}

以上代码中，我们对Python模块中的Person类进行实例化，并调用其中的方法，输出结果如下：

Hello, Joe!
Age: 25

至此，我们已经完成了C++调用Python模块的完整攻略。