PythonCAPI解决模块找不到问题

知识点掌握了，还需要不断练习才能熟练运用。下面golang学习网给大家带来一个文章开发实战，手把手教大家学习《Python C API 解决 ModuleNotFound 错误》，在实现功能的过程中也带大家重新温习相关知识点，温故而知新，回头看看说不定又有不一样的感悟！

本文旨在帮助开发者解决在使用 Python C API 时遇到的 `ModuleNotFoundError` 问题。通过分析错误原因，提供修改 Python 模块搜索路径的解决方案，并展示如何在 C++ 代码中嵌入 Python 解释器并调用 Python 模块。

在使用 Python C API 时，ModuleNotFoundError 是一个常见的错误，它表明 Python 解释器无法找到指定的模块。以下将分析可能导致此错误的原因，并提供解决方案。

问题分析

当你在 C++ 代码中使用 PyImport_Import 函数导入 Python 模块时，Python 解释器会按照一定的搜索路径查找模块。如果模块不在这些路径中，就会抛出 ModuleNotFoundError 异常。

以下是一些常见的原因：

1. 模块路径不正确： 传递给 PyImport_Import 函数的模块路径不正确，或者模块文件实际不存在于指定的路径。
2. Python 搜索路径未包含模块路径： Python 解释器的搜索路径没有包含模块所在的目录。

解决方案

解决 ModuleNotFoundError 的关键在于确保 Python 解释器能够找到你的模块。以下是一些常用的解决方案：

1. 修改模块搜索路径：

   最直接的解决方案是修改 Python 的模块搜索路径，将模块所在的目录添加到搜索路径中。这可以通过以下几种方式实现：

   • 在 C++ 代码中修改 sys.path：

     可以使用 Python C API 在 C++ 代码中动态修改 sys.path。以下是一个示例：

     #define PY_SSIZE_T_CLEAN
     #include <Python.h>
     
     int main(int argc, char *argv[]) {
         Py_Initialize();
     
         // 获取 sys.path
         PyObject *sys_path = PySys_GetObject("path");
         if (sys_path == NULL) {
             PyErr_Print();
             return 1;
         }
     
         // 添加模块所在的目录到 sys.path
         PyObject *module_path = PyUnicode_FromString("/home/user_1/project/ml"); // 替换为你的模块路径
         if (module_path == NULL) {
             PyErr_Print();
             return 1;
         }
         int result = PyList_Insert(sys_path, 0, module_path); // 将路径插入到 sys.path 的开头
         Py_DECREF(module_path);
         if (result != 0) {
             PyErr_Print();
             return 1;
         }
     
         // 导入模块
         PyObject *pName, *pModule;
         pName = PyUnicode_FromString("multiply"); // 模块名，不带 .py 后缀
         pModule = PyImport_Import(pName);
         Py_DECREF(pName);
     
         if (pModule == NULL) {
             PyErr_Print();
             fprintf(stderr, "Failed to load module\n");
             return 1;
         }
     
         // ... 后续代码：调用模块中的函数 ...
     
         Py_DECREF(pModule);
         Py_FinalizeEx();
         return 0;
     }

     注意：

     • 上面的代码示例中，PyUnicode_FromString("multiply") 传入的是模块名，而不是包含路径的完整文件名，例如 "multiply.py"。PyImport_Import 函数会根据 sys.path 搜索该模块。
     • 确保替换 /home/user_1/project/ml 为你实际的模块路径。

   • 设置 PYTHONPATH 环境变量：

     可以在运行 C++ 程序之前，设置 PYTHONPATH 环境变量，将模块所在的目录添加到 Python 的搜索路径中。例如：

     export PYTHONPATH=$PYTHONPATH:/home/user_1/project/ml
     ./a multiply multiply 3 2

   • 将模块移动到 Python 搜索路径中：

     如问题解答中所示，可以将模块移动到 Python 的默认搜索路径中，例如 /usr/lib/python3.10。但这通常不推荐，因为它会污染系统目录，并且不利于模块的管理和维护。

2. 使用正确的模块路径：

   确保传递给 PyImport_Import 函数的模块路径是正确的。如果模块位于当前工作目录，可以使用相对路径或绝对路径。例如：

   pName = PyUnicode_FromString("./multiply.py"); // 相对路径
   // 或者
   pName = PyUnicode_FromString("/home/user_1/project/ml/multiply.py"); // 绝对路径

   注意： 使用相对路径时，需要确保 C++ 程序的当前工作目录是模块所在的目录。

3. 使用 PyImport_AddModule (不推荐) 虽然不推荐，但是 PyImport_AddModule 可以创建一个新的模块对象，但是它并不会实际加载任何代码。你需要手动执行模块的代码，这通常很复杂且容易出错。

示例代码

以下是一个完整的示例，演示了如何在 C++ 代码中使用 Python C API 导入 Python 模块并调用其中的函数：

#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <iostream>

int main(int argc, char *argv[]) {
    PyObject *pName, *pModule, *pFunc;
    PyObject *pArgs, *pValue;
    int i;

    if (argc < 3) {
        fprintf(stderr, "Usage: call pythonfile funcname [args]\n");
        return 1;
    }

    Py_Initialize();

    // 获取 sys.path
    PyObject *sys_path = PySys_GetObject("path");
    if (sys_path == NULL) {
        PyErr_Print();
        return 1;
    }

    // 添加模块所在的目录到 sys.path
    PyObject *module_path = PyUnicode_FromString("/home/user_1/project/ml"); // 替换为你的模块路径
    if (module_path == NULL) {
        PyErr_Print();
        return 1;
    }
    int result = PyList_Insert(sys_path, 0, module_path); // 将路径插入到 sys.path 的开头
    Py_DECREF(module_path);
    if (result != 0) {
        PyErr_Print();
        return 1;
    }


    pName = PyUnicode_FromString(argv[1]); // 模块名
    pModule = PyImport_Import(pName);
    Py_DECREF(pName);

    if (pModule != NULL) {
        pFunc = PyObject_GetAttrString(pModule, argv[2]);

        if (pFunc && PyCallable_Check(pFunc)) {
            pArgs = PyTuple_New(argc - 3);
            for (i = 0; i < argc - 3; ++i) {
                pValue = PyLong_FromLong(atoi(argv[i + 3]));
                if (!pValue) {
                    Py_DECREF(pArgs);
                    Py_DECREF(pModule);
                    fprintf(stderr, "Cannot convert argument\n");
                    return 1;
                }
                PyTuple_SetItem(pArgs, i, pValue);
            }
            pValue = PyObject_CallObject(pFunc, pArgs);
            Py_DECREF(pArgs);
            if (pValue != NULL) {
                printf("Result of call: %ld\n", PyLong_AsLong(pValue));
                Py_DECREF(pValue);
            } else {
                Py_DECREF(pFunc);
                Py_DECREF(pModule);
                PyErr_Print();
                fprintf(stderr, "Call failed\n");
                return 1;
            }
        } else {
            if (PyErr_Occurred())
                PyErr_Print();
            fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);
        }
        Py_XDECREF(pFunc);
        Py_DECREF(pModule);
    } else {
        PyErr_Print();
        fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);
        return 1;
    }
    if (Py_FinalizeEx() < 0) {
        return 120;
    }
    return 0;
}

编译命令：

g++ testcapi.cpp -I /usr/include/python3.10 -L /usr/lib/python3.10 -lpython3.10 -o a

Python 模块 (multiply.py)：

def multiply(a, b):
    print("Will compute", a, "times", b)
    c = 0
    for i in range(0, a):
        c = c + b
    return c

运行：

./a multiply multiply 3 2

注意事项

• 确保你的编译命令中包含了正确的 Python 头文件和库文件路径。
• 在使用 Python C API 时，需要小心管理 Python 对象的引用计数，避免内存泄漏。
• 在调用 Py_FinalizeEx() 之前，需要释放所有 Python 对象。

总结

解决 Python C API 中的 ModuleNotFoundError 问题的关键在于确保 Python 解释器能够找到你的模块。可以通过修改模块搜索路径、使用正确的模块路径等方式来解决此问题。在实际开发中，建议根据具体情况选择最合适的解决方案。

本篇关于《PythonCAPI解决模块找不到问题》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！