关于 cmdclass 参数的 pip3 和 `python3 setup.py install` 之间的区别

2022-01-13 00:00:00 python pip setuptools package installation

问题描述

我尝试配置我的包,以便在安装过程中执行脚本.因此,我从 setuptools.command install 继承并创建了我的自定义类 ActionOnInstall 以在安装包时执行一些操作.此类通过 setuptools setup() 参数 cmdclass 调用,如 这里.

I tried to configure my package such that a script is executed on the installation process. Therefore, I inherited from setuptools.command install and created my custom class ActionOnInstall to do stuff when package is installed. This class is called via setuptools setup() argument cmdclass as described here.

这种 setup.py 文件的最小示例如下所示

A minimal example of such a setup.py file looks like

from setuptools import find_packages, setup
from setuptools.command.install import install


class ActionOnInstall(install):
    def run(self):
        print("Call install.run(self) works!")
        install.run(self)


setup(name='name',
      cmdclass={
      'install': ActionOnInstall})

通过执行构建包

pip3 install <path-to-dir-with-setup.py>

运行成功,但不执行 ActionOnInstall.run() 中指定的命令.通过

runs successfully but does not execute commands specified in ActionOnInstall.run(). More directly calling this setup.py by

python3 setup.py install 

执行 ActionOnInstall.run() 中指定的命令.

executes commands specified in ActionOnInstall.run().

然后,我发现自己在问:这两种安装包的方法的实际区别是什么.我知道,就像其他帖子告诉我们的那样,pip 让安装包的工作变得更轻松.但是没有解释这两种方法如何不同地处理 setup()cmdclass 参数.因此,我非常感谢你们的来信.

Then, I found myself asking: what is the actual difference of these both approaches to install a package. I know, like other posts tell us, pip makes life easier regarding package installation. But how these both approaches treat the cmdclass argument of setup() differently is not explained. Thus, I would highly appreciate to hear from you guys.


解决方案

pip 调用你的 setup.py 但它重定向 stdout/stderr.测试 pip 下的 setup.py 写入固定位置的文件:

pip calls your setup.py but it redirects stdout/stderr. To test setup.py under pip write to a file in a fixed location:

class ActionOnInstall(install):
    def run(self):
        print("Call install.run(self) works!", file=open('/tmp/debug.log', 'w'))
        install.run(self)

pip install .

相关文章