Conda环境下C++调用Python代码版本绑定异常问题排查

问题背景 #

开发中用C调用Python脚本获取版本信息，通过Conda管理Python环境。在Python3.11环境下测试正常，输出对应版本，但切换到Python3.10环境后，程序仍返回Python3.11的版本，说明C程序绑定了错误的Python解释器。

核心原因 #

1. CMake的find_package(Python3)未优先识别当前激活的Conda环境，编译时链接了旧版本的Python库
2. Python初始化时未指定当前环境的Python路径，默认加载了系统或缓存的解释器
3. C++代码中静态变量导致模块仅加载一次，环境切换后无法重新加载

解决方案 #

1. 修改CMakeLists.txt，强制识别当前Conda环境 #

在find_package(Python3)前添加配置，让CMake优先使用虚拟环境（Conda）的Python：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 强制CMake优先查找当前虚拟环境（Conda）中的Python
set(Python3_FIND_VIRTUALENV ONLY)

# Find Python
find_package(Python3 COMPONENTS Development REQUIRED)

# Include Python headers
include_directories(${Python3_INCLUDE_DIRS})

# Include the 'include' directory
include_directories(include)

# Get all the .cpp files in the src directory
file(GLOB SOURCES "src/*.cpp")

# Add an executable with the collected sources
add_executable(main_executable ${SOURCES})

# Link Python libraries
target_link_libraries(main_executable PRIVATE ${Python3_LIBRARIES})

# Copy all the files in scripts in the build folder
file(GLOB PYTHON_SCRIPTS ${CMAKE_CURRENT_SOURCE_DIR}/scripts/*.py)

foreach(PYTHON_SCRIPT ${PYTHON_SCRIPTS})
    get_filename_component(FILENAME ${PYTHON_SCRIPT} NAME)
    add_custom_command(TARGET main_executable POST_BUILD
        COMMAND ${CMAKE_COMMAND} -E copy
            ${PYTHON_SCRIPT}
            ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${FILENAME}
        COMMENT "Copying ${FILENAME} to the build directory"
    )
endforeach()

编译时需先激活目标Conda环境：

conda activate env310
cmake ..
make

2. 在C++代码中指定Python环境路径 #

初始化Python前，设置PYTHONHOME环境变量，指向当前Conda环境的Python目录：
修改src/main.cpp：

#include <iostream>
#include <Python.h>
#include <cstdlib>
#include "pysum.hpp"
#include "staticYOLO.hpp"
#include "pyconfig.hpp"

int main() {
    // 从Conda环境变量获取当前环境路径
    const char* conda_prefix = getenv("CONDA_PREFIX");
    if (conda_prefix != nullptr) {
        // 设置PYTHONHOME指向当前环境的Python库目录
        std::string python_home = std::string(conda_prefix) + "/lib/python" PY_MAJOR_VERSION "." PY_MINOR_VERSION;
        setenv("PYTHONHOME", python_home.c_str(), 1);
        // 设置PYTHONPATH，确保能加载自定义脚本和环境包
        std::string python_path = std::string(conda_prefix) + "/lib/python" PY_MAJOR_VERSION "." PY_MINOR_VERSION "/site-packages:" + std::string(getenv("PWD"));
        setenv("PYTHONPATH", python_path.c_str(), 1);
    }

    std::cout << "Init interpreter" << std::endl;

    Py_Initialize();

    if (!Py_IsInitialized()) {
        fprintf(stderr, "Failed to initialize Python interpreter\n");
        return 1;
    }

    pyconfig();
    
    Py_Finalize();

    return 0;
}

3. 修复静态变量导致的模块无法重新加载问题 #

pyconfig.cpp中的静态变量会导致模块仅在第一次调用时加载，后续环境切换后不会更新。去掉静态修饰，每次调用都重新加载模块并释放资源：

#include <Python.h>
#include <mutex>
#include "pyconfig.hpp"

void pyconfig(){
    static std::mutex mtx; // 保留互斥锁保证线程安全

    std::lock_guard<std::mutex> lock(mtx);

    PyObject *name = PyUnicode_FromString((char*)"pyConfig");
    PyObject *load_module = PyImport_Import(name);
    if (!load_module) {
        PyErr_Print();
        Py_DECREF(name);
        return;
    }

    PyObject *func = PyObject_GetAttrString(load_module,(char*)"pyConfig");
    if (!func || !PyCallable_Check(func)) {
        PyErr_Print();
        Py_DECREF(load_module);
        Py_DECREF(name);
        return;
    }

    PyObject *callfunc = PyObject_CallObject(func, NULL);
    if (!callfunc) {
        PyErr_Print();
    }

    // 释放Python对象，避免内存泄漏
    Py_XDECREF(callfunc);
    Py_DECREF(func);
    Py_DECREF(load_module);
    Py_DECREF(name);
}

4. 运行时确保加载正确的Python库 #

Linux下，运行程序前需确保LD_LIBRARY_PATH包含当前Conda环境的lib目录：

export LD_LIBRARY_PATH=$CONDA_PREFIX/lib:$LD_LIBRARY_PATH
./main_executable

Windows下，确保PATH包含Conda环境的Scripts和Lib目录。

内容的提问来源于stack exchange，提问作者Luca Gambarotto