如何为pipenv从远程仓库安装的Python包配置自定义构建选项

Pipfile 不支持自定义非标准字段，你设想的直接新增custom_build_option参数的写法无法被Pipenv原生识别，可通过以下两种成熟方案实现构建参数动态传递：

方案1：环境变量传参（最灵活，推荐使用） #

无需修改Pipfile结构，仅调整mypackage的构建逻辑，通过环境变量传递参数即可。

• 第一步：修改mypackage的setup.py，读取环境变量中的自定义构建选项，传递给cmake逻辑

import os
from setuptools import setup
from setuptools.command.install import install

class CustomInstallCommand(install):
    def run(self):
        # 读取环境变量，默认值可设置为之前硬编码的选项
        custom_option = os.getenv("MYPACKAGE_BUILD_OPTION", "default_value")
        # 此处将custom_option传入你原有cmake构建流程即可
        # 示例：cmake调用时追加参数 `-DCUSTOM_BUILD_OPTION={custom_option}`
        super().run()

setup(
    # 保留你原有setup的所有配置，仅新增cmdclass字段
    name = "mypackage",
    # 其他原有配置...
    cmdclass = {"install": CustomInstallCommand}
)

• 第二步：执行安装时前置传入环境变量即可

# 传入option1参数执行全量依赖安装
MYPACKAGE_BUILD_OPTION=option1 pipenv install --dev

如果需要固定参数在项目中，可在Pipfile中新增脚本配置：

[scripts]
install-dev = "MYPACKAGE_BUILD_OPTION=option1 pipenv install --dev"

后续直接执行pipenv run install-dev即可自动带参数完成安装。

方案2：通过命令行安装选项传参 #

如果不想使用环境变量，也可以通过pip原生支持的自定义安装选项传参：

• 第一步：修改mypackage的setup.py，注册自定义安装选项

from setuptools import setup
from setuptools.command.install import install

class CustomInstallCommand(install):
    # 注册自定义参数
    user_options = install.user_options + [
        ("custom-build-option=", None, "mypackage自定义构建选项"),
    ]

    def initialize_options(self):
        super().initialize_options()
        self.custom_build_option = "default_value"

    def run(self):
        # self.custom_build_option即为传入的参数，传递给cmake即可
        super().run()

setup(
    # 保留原有配置，新增cmdclass
    name = "mypackage",
    cmdclass = {"install": CustomInstallCommand}
)

• 第二步：安装时通过--install-option传递参数

pipenv install --install-option="--custom-build-option=option1" --dev

注意事项 #

• editable安装模式下两种方案均生效，因为可编辑安装也会执行setup.py的构建流程。
• 如果你已经迁移到PEP 621标准的pyproject.toml配置，仅需调整自定义构建后端的参数读取逻辑即可，传参逻辑不变。

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