使用官方Python方式扩展Python时引入C++库及VSCode错误解决

一、用distutils配置第三方C++依赖库 #

distutils的Extension类提供了专门参数来指定第三方库依赖，你只需要在定义模块时补充这些配置即可：

• include_dirs: 填第三方库的头文件路径列表，比如OpenCV、FFmpeg的include目录
• library_dirs: 填第三方库编译后库文件（.lib/.so/.dylib）的存放路径列表
• libraries: 填需要链接的库名称（不带前缀和后缀，比如OpenCV的opencv_core、FFmpeg的avcodec）
• extra_compile_args: 额外编译参数，比如C++版本指定-std=c++17、OpenCL的-cl-std=CL2.0
• extra_link_args: 额外链接参数，比如Windows下OpenGL需要的opengl32.lib

以下是适配多依赖的示例配置：

from distutils.core import setup, Extension

# 替换为你本地的实际路径
OPENCV_INCLUDE = "D:/opencv/build/include"  # Windows示例
OPENCV_LIB = "D:/opencv/build/x64/vc16/lib"
FFMPEG_INCLUDE = "/usr/include/ffmpeg"  # Linux示例
FFMPEG_LIB = "/usr/lib/x86_64-linux-gnu"
OPENCL_INCLUDE = "/usr/include/CL"

module1 = Extension('my_test',
                    sources=['py_extend.cpp', 'src/a_source_file.cpp'],
                    include_dirs=[OPENCV_INCLUDE, FFMPEG_INCLUDE, OPENCL_INCLUDE],
                    library_dirs=[OPENCV_LIB, FFMPEG_LIB],
                    libraries=['opencv_core', 'opencv_imgproc', 'avcodec', 'avformat', 'avutil', 'OpenCL'],
                    extra_compile_args=['-std=c++17'],
                    extra_link_args=[]  # Windows下如需OpenGL可加['opengl32.lib']
                    )

setup(name='python_test',
      version='1.0',
      description='This is a demo package with external dependencies',
      ext_modules=[module1])

注意：不同平台的库路径和名称有差异，比如Windows下OpenCV库可能带版本号（如opencv_core455.lib），需根据实际安装版本调整。

二、解决VSCode的错误提示问题 #

VSCode的C/C++插件无法自动识别distutils里的依赖路径，所以会报头文件找不到的错误，但实际编译时distutils已指定路径，因此程序能正常运行。你可以通过配置c_cpp_properties.json让VSCode识别这些路径：

1. 按下Ctrl+Shift+P（Windows/Linux）或Cmd+Shift+P（macOS），输入C/C++: Edit Configurations (JSON)打开配置文件
2. 在includePath数组中添加所有第三方库的头文件路径，和distutils里的include_dirs对应
3. 可选：在browse.path中添加相同路径，提升代码跳转体验
4. 根据本地编译器设置compilerPath，比如Windows的cl.exe路径、Linux的g++路径

示例配置：

{
    "configurations": [
        {
            "name": "Win32",  // Linux选"Linux"，macOS选"Mac"
            "includePath": [
                "${workspaceFolder}/**",
                "D:/opencv/build/include",
                "D:/ffmpeg/include",
                "C:/Program Files (x86)/Intel/OpenCL SDK/7.0/include"
            ],
            "browse": {
                "path": [
                    "${workspaceFolder}/**",
                    "D:/opencv/build/include",
                    "D:/ffmpeg/include"
                ]
            },
            "defines": ["_DEBUG", "UNICODE", "_UNICODE"],
            "compilerPath": "C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.29.30133/bin/Hostx64/x64/cl.exe",
            "cStandard": "c17",
            "cppStandard": "c++17",
            "intelliSenseMode": "windows-msvc-x64"
        }
    ],
    "version": 4
}

配置完成后，VSCode的IntelliSense会自动识别头文件，错误提示会消失，同时不影响程序正常编译运行。

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