如何控制setuptools.Extension的后缀机制适配ctypes模块安装？

问题根源 #

setuptools默认会为Extension生成带Python ABI版本后缀的文件名（如libdicm.cp310-win_amd64.pyd），但你的cmake构建系统生成的是自定义后缀的库文件（dicm.dll或libdicm.so.0），导致poetry install时setuptools找不到预期文件而报错。

解决方案 #

通过自定义Extension类和build_ext命令，让setuptools适配cmake生成的自定义后缀库文件，同时保留cmake构建流程。

步骤1：修改CMakeLists.txt，确保生成指定后缀的库 #

在你的CMakeLists.txt中添加目标属性配置，强制生成需要的文件名：

# 假设你的库目标名为dicm
add_library(dicm SHARED [你的源文件列表])

if(WIN32)
    # Windows下生成dicm.dll
    set_target_properties(dicm PROPERTIES 
        OUTPUT_NAME dicm
        SUFFIX ".dll"
    )
else()
    # Linux下生成libdicm.so.0，同时创建libdicm.so软链接
    set_target_properties(dicm PROPERTIES 
        OUTPUT_NAME dicm
        VERSION 0
        SOVERSION 0
        SUFFIX ".so"
    )
endif()

步骤2：自定义setup.py中的Extension和build_ext类 #

修改你的setup.py，替换默认的Extension和build_ext逻辑：

import os
import platform
import subprocess
from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext

class CustomCTypesExtension(Extension):
    def get_filename(self):
        # 返回cmake生成的自定义文件名
        if platform.system() == "Windows":
            return "dicm.dll"
        elif platform.system() == "Linux":
            return "libdicm.so.0"
        # 其他系统可自行扩展
        return super().get_filename()

class CMakeBuildExt(build_ext):
    def run(self):
        # 先执行cmake构建生成目标库
        self._build_with_cmake()
        # 再调用父类完成后续安装流程
        super().run()

    def _build_with_cmake(self):
        # 创建cmake临时构建目录
        build_temp = os.path.abspath(self.build_temp)
        os.makedirs(build_temp, exist_ok=True)
        
        # 配置cmake参数，指定输出目录为setuptools的build_lib目录
        build_lib = os.path.abspath(self.build_lib)
        cmake_args = [
            "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=" + build_lib,
            "-DCMAKE_RUNTIME_OUTPUT_DIRECTORY=" + build_lib,  # Windows下DLL属于runtime输出
            # 可添加其他cmake配置参数，如-DCMAKE_BUILD_TYPE=Release
        ]

        # 执行cmake配置
        subprocess.check_call(
            ["cmake", os.path.dirname(os.path.abspath(__file__))] + cmake_args,
            cwd=build_temp
        )
        # 执行构建
        subprocess.check_call(
            ["cmake", "--build", build_temp, "--config", "Release"],  # Release模式构建
            cwd=build_temp
        )

# 配置setup
setup(
    name="你的包名",
    version="0.1.0",
    # 使用自定义Extension，sources设为空（由cmake处理编译）
    ext_modules=[CustomCTypesExtension("libdicm", sources=[])],
    cmdclass={"build_ext": CMakeBuildExt},
    # 其他setup配置（如packages、author等）
)

步骤3：验证安装 #

执行poetry install，此时setuptools会调用cmake生成指定后缀的库文件，并能正确找到该文件完成安装。安装后，你可以在Python中通过ctypes加载对应的库：

import ctypes
import os
import platform

if platform.system() == "Windows":
    lib = ctypes.CDLL(os.path.join("你的包路径", "dicm.dll"))
elif platform.system() == "Linux":
    lib = ctypes.CDLL(os.path.join("你的包路径", "libdicm.so.0"))

关键说明 #

• 自定义CustomCTypesExtension的get_filename方法，告诉setuptools要寻找的库文件名，而非默认的ABI后缀名。
• CMakeBuildExt类负责调用cmake完成构建，并将生成的库文件输出到setuptools指定的build_lib目录，确保setuptools能找到并复制该文件。
• CMakeLists.txt中的配置确保cmake生成的文件名与setuptools预期的完全一致。

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