如何在Setuptools安装前后获取Python文件路径调用C++二进制文件

核心问题 #

你之前的尝试失败，本质是没有通过setuptools将C++二进制文件打包到安装包中，导致安装后build目录下不存在该二进制，所以importlib.resources无法找到对应的文件。

解决方案步骤 #

1. 调整项目结构（符合Python包规范） #

假设你的项目基础结构如下：

my_package/
├── __init__.py
├── script_name.py  # 可直接执行、也可被导入的脚本
└── build/
    ├── __init__.py  # 标记build为Python子包
    └── GenerateHistograms  # 你的C++二进制文件

2. 配置setuptools打包规则 #

在项目根目录创建/修改pyproject.toml，明确告诉setuptools要将二进制文件作为包资源包含进去：

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "my_package"
version = "0.1.0"
packages = ["my_package", "my_package.build"]  # 声明包含主包和build子包

[tool.setuptools.package-data]
"my_package.build" = ["GenerateHistograms"]  # 指定build子包需要打包的二进制文件

如果仍在使用旧版setup.py，可替换为如下配置：

from setuptools import setup, find_packages

setup(
    name="my_package",
    version="0.1.0",
    packages=find_packages(),
    package_data={
        "my_package.build": ["GenerateHistograms"],
    },
)

3. 正确获取二进制文件路径 #

在my_package/__init__.py中，使用importlib.resources的标准方式获取路径（兼容包被打包为zip格式的场景）：

from importlib.resources import files, as_file
from contextlib import contextmanager

@contextmanager
def get_binary():
    # as_file会自动处理zip包场景，将二进制文件提取到临时路径
    with as_file(files("my_package.build").joinpath("GenerateHistograms")) as binary_path:
        yield binary_path

在核心函数中调用示例：

from my_package import get_binary
import subprocess

def core_function():
    with get_binary() as binary_path:
        # 执行C++二进制文件
        subprocess.run([str(binary_path), "param1", "param2"])

若确定环境不会用zip打包（如开发模式pip install --editable），可简化为：

from importlib.resources import files

binary_path = files("my_package.build").joinpath("GenerateHistograms")

4. 验证安装结果 #

安装后进入Python交互环境测试：

from my_package import get_binary
with get_binary() as path:
    print(path.exists())  # 应返回True

补充说明 #

• 不要试图获取"原始文件路径"：安装后文件位置由setuptools决定，不同环境（虚拟环境、系统全局）路径不同，依赖固定路径会导致兼容性问题。
• 若二进制需要全局可执行（而非仅被包调用），可配置[tool.setuptools.scripts]将其安装到系统bin目录，但此场景更适合独立工具，而非包内部调用。

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