解决 Python 嵌入式环境中 PyImport_Import 无法加载模块的问题

2024-11-07 21:59:03

PyImport_Import 无法加载当前目录模块的问题

使用 PyImport_Import 或者 PyRun_SimpleString("import module_name") 在嵌入式 Python 环境中导入模块时，经常会遇到无法从当前目录加载模块的情况，即使模块文件确实存在。本文将分析这个问题的原因并提供解决方案。

问题根源：搜索路径

Python 导入模块时，会按照 sys.path 列表中的路径依次搜索。如果当前目录不在 sys.path 中，自然就找不到模块。嵌入式 Python 环境和普通的 Python 脚本运行环境有所不同，sys.path 的初始化方式也不一样。在嵌入式环境中，sys.path 的初始化通常不包含当前目录，这就导致了开头的问题。

解决方案一：修改 sys.path

最直接的解决方案是手动将当前目录添加到 sys.path。

代码示例：

#include <Python.h>

int main() {
  Py_Initialize();

  // 将 "." (代表当前目录) 添加到 sys.path
  PyRun_SimpleString("import sys");
  PyRun_SimpleString("sys.path.insert(0, \".\")"); 

  // 现在可以导入当前目录下的模块了
  PyObject *pModule = PyImport_ImportModule("multiply"); 
  if (pModule == NULL) {
    PyErr_Print();
    return 1;
  }
  // ... 使用模块 ...

  Py_DECREF(pModule);
  Py_FinalizeEx();
  return 0;
}

操作步骤:

确保 multiply.py 文件（或你的模块文件）位于与可执行文件相同的目录。
使用上述代码编译和运行程序。

原理: sys.path.insert(0, ".") 将当前目录 "." 添加到 sys.path 的开头。 insert(0, ...) 确保当前目录具有最高优先级，避免与其他路径下的同名模块冲突。

安全建议: 如果程序运行在非预期目录下，添加 "." 到 sys.path 可能导致加载非预期的模块，带来安全风险。生产环境中，建议使用更精确的路径，例如包含模块所在目录的绝对路径。

解决方案二：使用绝对路径导入

更稳妥的做法是直接使用模块的绝对路径进行导入。

代码示例：

#include <Python.h>
#include <stdio.h>  // 用于获取当前工作目录
#include <unistd.h> // 用于 getcwd

int main() {
    Py_Initialize();

    char cwd[1024];
    if (getcwd(cwd, sizeof(cwd)) != NULL) {
        snprintf(module_path, sizeof(module_path), "%s/multiply", cwd); // 构造模块的绝对路径
        PyObject* pName = PyUnicode_DecodeFSDefault(module_path);
        PyObject* pModule = PyImport_Import(pName);

        if (pModule == NULL) {
            PyErr_Print();
            return 1;
        }
        // ... 使用模块 ...


        Py_DECREF(pName);
        Py_DECREF(pModule);

    } else {
       perror("getcwd() error");
       return 1;
    }


    Py_FinalizeEx();
    return 0;
}

操作步骤:

与方案一相同，确保模块文件和可执行文件在同一目录下.
编译运行程序.

原理: 通过 getcwd 获取当前工作目录，拼接模块文件名，构造模块的完整路径。使用PyUnicode_DecodeFSDefault 转换为 Python 字符串, 再用PyImport_Import 直接导入指定路径的模块。避免了 sys.path 的修改，更加安全可靠。

安全建议: 尽量避免在程序中动态构建路径，以防路径拼接错误引入安全漏洞. 检查 getcwd 的返回值，确保获取路径成功。