如何使用“--install-option”从 pip 获取传递给 setup.py 的参数？

Question

我正在使用 pip 1.4.1，尝试从本地路径安装包，例如：

pip install /path/to/my/local/package

这就是我想要的，这或多或少相当于运行python /path/to/my/local/package/setup.py install，但我想将一些额外的选项/参数传递给我的包的 setup.py 安装。

我了解from the pip documentation 可以使用--install-option 选项，例如：

pip install --install-option="--some-option" /path/to/my/local/package

python-virtualenv Google Group 的This post 建议这是可能的。

我不明白的是如何从 setup.py 中获取传入的“--some-option”。我尝试查看sys.argv，但无论我为“--install-option =”添加什么，sys.argv 总是这样：

['-c', 'egg_info', '--egg-base', 'pip-egg-info']

如何从 pip install 获取作为“--install-option”传入的东西的值？

Answer 1

我在安装 pyside 时遇到了这个问题。

我需要指定--qmake 选项。

这是您需要的表格：

pip install --install-option="--qmake=/usr/lib64/qt4/bin/qmake" PySide

Answer 2

您需要使用自己的自定义命令扩展安装命令。在run 方法中，您可以将选项的值公开给setup.py（在我的示例中，我使用全局变量）。

from setuptools.command.install import install


class InstallCommand(install):
    user_options = install.user_options + [
        ('someopt', None, None), # a 'flag' option
        #('someval=', None, None) # an option that takes a value
    ]

    def initialize_options(self):
        install.initialize_options(self)
        self.someopt = None
        #self.someval = None

    def finalize_options(self):
        #print("value of someopt is", self.someopt)
        install.finalize_options(self)

    def run(self):
        global someopt
        someopt = self.someopt # will be 1 or None
        install.run(self)

使用setup 函数注册自定义安装命令。

setup(
    cmdclass={
        'install': InstallCommand,
    },
    :

看来你的论点顺序不对

pip install /path/to/my/local/package --install-option="--someopt"

Answer 3

效果很好，documented.

from setuptools.command.install import install

class InstallCommand(install):             
    user_options = install.user_options + [
        ('engine=', None, '<description for this custom option>'),
    ]                                      

    def initialize_options(self):          
        install.initialize_options(self)   
        self.engine = None  

    def finalize_options(self):                   
        print("value of engine is", self.engine)
        install.finalize_options(self)            

    def run(self):                                
        print(self.engine)                       
        install.run(self)                         

setup(
...
cmdclass={'install': InstallCommand}
...
)

一个常见的错误是将setup 选项传递给pip，就像你将它直接传递给setup 一样。 像这样使用 pip 中的选项：

pip install . --install-option="--engine=rabbitmq"

但是这种方式是错误的方式：

pip install . --install-option="--engine rabbitmq"

没有等号会导致众所周知的错误：

错误：选项 --engines rabbitmq 无法识别

Answer 4

为了保持一致性，您可以为 setup.py install 和 setup.py develop（又名 pip install -e）添加一个选项：（基于 Ronen Botzer 的回答）

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


class CommandMixin(object):
    user_options = [
        ('someopt', None, 'a flag option'),
        ('someval=', None, 'an option that takes a value')
    ]

    def initialize_options(self):
        super().initialize_options()
        # Initialize options
        self.someopt = None
        self.someval = 0

    def finalize_options(self):
        # Validate options
        if self.someval < 0:
            raise ValueError("Illegal someval!")
        super().finalize_options()

    def run(self):
        # Use options
        global someopt
        someopt = self.someopt # will be 1 or None

        super().run()

class InstallCommand(CommandMixin, install):
    user_options = getattr(install, 'user_options', []) + CommandMixin.user_options

class DevelopCommand(CommandMixin, develop):
    user_options = getattr(develop, 'user_options', []) + CommandMixin.user_options

setup(
    ...,
    cmdclass={
        'install': InstallCommand,
        'develop': DevelopCommand,
    }

然后您可以将选项传递给 pip，例如：

pip install --install-option="--someval=1" --install-option="--someopt" .

或处于开发模式：

pip install -e --install-option="--someval=1" .

Answer 5

在此great anwser 之上。 还有一点需要注意的是--install-options 不是work with wheel

从 7.0 版开始，pip 支持通过需求文件控制提供给 setup.py 的命令行选项。这会禁用该软件包的轮子（缓存或其他方式），因为轮子不存在 setup.py。

但是，当你使用setup.py 构建轮子时，你可以使用

python setup.py bdist_wheel install -your-options

自定义安装阶段，这会影响到wheel包的.dist-info。