如何通过CMake判断检索到的Python库类型及跨平台链接方案

核心问题场景 #

当前开发项目的基础CMake配置如下，单平台运行正常，但跨平台适配存在差异：

find_package(Python COMPONENTS Development)
if (Python_FOUND)
    target_include_directories(${TARGET} PUBLIC ${Python_INCLUDE_DIRS})
endif()

跨平台的链接差异具体表现为：

• Windows平台：CMake检索到的Python开发库为python3x.lib格式的静态库，必须手动添加target_link_libraries(${TARGET} PUBLIC ${PYTHON_LIBRARIES}完成链接，否则会出现Python相关符号未定义的编译错误
• Ubuntu 18.04等Linux平台：CMake检索到的Python库为libpython3xm.so格式的动态共享库，若强制添加上述链接语句，当项目依赖的其他库与系统Python动态库的符号版本不匹配时，极易出现多重定义、符号冲突的问题

此前尝试通过设置set(Python_USE_STATIC_LIBS TRUE)强制检索静态库，但未达到预期效果，实测输出仍为系统路径下的动态库：

set(Python_USE_STATIC_LIBS TRUE)
find_package(Python COMPONENTS Development)
message(${PYTHON_LIBRARIES})

CMake实际输出日志：

-- Found Python: /usr/include/python3.7m (found version "3.7.5") found components: Development Development.Module Development.Embed
/usr/lib/x86_64-linux-gnu/libpython3.7m.so

可落地的适配方案 #

1. 基于库文件后缀判断是否追加链接逻辑 #

不做硬编码平台判断，直接解析检索到的Python库的文件后缀，仅当识别到静态库时手动追加链接配置：

find_package(Python COMPONENTS Development)
if(Python_FOUND)
    target_include_directories(${TARGET} PUBLIC ${Python_INCLUDE_DIRS})
    # 获取检索到的Python库的文件后缀
    get_filename_component(PYTHON_LIB_SUFFIX "${Python_LIBRARIES}" EXT)
    # 静态库的常见后缀为Windows下的.lib、Linux下的.a
    if(PYTHON_LIB_SUFFIX STREQUAL ".lib" OR PYTHON_LIB_SUFFIX STREQUAL ".a")
        target_link_libraries(${TARGET} PUBLIC ${Python_LIBRARIES})
    endif()
endif()

注意：CMake检索Python时生成的带Python_前缀的变量为当前生效的正式变量，不要误用旧版本的不带前缀的PYTHON_LIBRARIES变量，避免出现变量为空的问题。

2. 直接使用CMake官方提供的Python导入目标（推荐） #

无需手动判断库类型、拼接链接逻辑，直接引用CMake为Python生成的导入目标，CMake会自动适配不同平台的链接规则：

find_package(Python COMPONENTS Development.Module Development.Embed)
if(Python_FOUND)
    # 自动传递头文件路径、匹配对应平台的链接规则，无需手动判断库类型
    target_link_libraries(${TARGET} PUBLIC Python::Python)
endif()

该方案的优势：

• Windows平台下，Python::Python会自动关联对应的静态lib库，完成必要的符号链接
• Linux平台下，若系统Python为动态库，Python::Python会自动按动态库的链接规则处理，不会把Python相关符号强制绑定到项目目标文件中，从根源上避免多重定义的冲突
• 完全消除手写平台判断、后缀判断的冗余逻辑

为什么设置Python_USE_STATIC_LIBS TRUE在Linux下未生效 #

该变量仅会调整CMake检索Python库时的优先级，不会强制替换系统已安装的Python库。绝大多数Linux发行版的系统Python默认不会附带静态库文件，检索过程中找不到匹配的静态库时，CMake会自动回退到系统默认安装的动态库路径，因此即便设置了该变量，最终获取到的库类型仍以系统实际安装的版本为准。

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