带有Python Setuptools的后安装脚本

Question

是否可以作为setUptools setup.py文件的一部分指定后安装python脚本文件，以便用户可以运行命令：

python setup.py install

在本地项目文件存档或

pip install <name>

PYPI项目上，并且该脚本将在完成标准SetUptools安装的完成？我希望执行可以在单个Python脚本文件中编码的后安装任务（例如，向用户提供自定义的后安装消息，从其他远程源存储库中摘取其他数据文件）。

我遇到几年前解决这个主题，听起来好像当时的共识是您需要创建一个安装子命令。如果仍然如此，是否可以提供一个如何执行此操作的示例，以便用户不必输入第二个命令来运行脚本？

Answer 1

注意：下面的解决方案仅在安装源分布zip或tarball或从源树中安装可编辑模式时起作用。从二进制轮安装（.whl）时，它将无法使用 ，

---

此解决方案更透明：

您将为setup.py 并且不需要额外的文件。

另外，您需要考虑两个不同的后安装；一个用于开发/可编辑模式，另一种用于安装模式。

添加这两个类，其中包括您的后安装脚本 setup.py ：

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


class PostDevelopCommand(develop):
    """Post-installation for development mode."""
    def run(self):
        develop.run(self)
        # PUT YOUR POST-INSTALL SCRIPT HERE or CALL A FUNCTION

class PostInstallCommand(install):
    """Post-installation for installation mode."""
    def run(self):
        install.run(self)
        # PUT YOUR POST-INSTALL SCRIPT HERE or CALL A FUNCTION

并插入cmdclass参数to setup（） setup（） setup.py 中的代码>函数：

setup(
    ...

    cmdclass={
        'develop': PostDevelopCommand,
        'install': PostInstallCommand,
    },

    ...
)

您甚至可以在安装过程中调用shell命令，就像在此示例中进行预安装准备：

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


class PreDevelopCommand(develop):
    """Pre-installation for development mode."""
    def run(self):
        check_call("apt-get install this-package".split())
        develop.run(self)

class PreInstallCommand(install):
    """Pre-installation for installation mode."""
    def run(self):
        check_call("apt-get install this-package".split())
        install.run(self)


setup(
    ...

ps： ps没有任何可用的预启动输入点setuptools。阅读为什么没有。

Answer 2

注意：下面的解决方案仅在安装源分布zip或tarball或从源树中安装可编辑模式时起作用。 它将无法工作

---

从二进制轮安装（.whl）时， 已经安装了：

import atexit
from setuptools.command.install import install


def _post_install():
    print('POST INSTALL')


class new_install(install):
    def __init__(self, *args, **kwargs):
        super(new_install, self).__init__(*args, **kwargs)
        atexit.register(_post_install)


setuptools.setup(
    cmdclass={'install': new_install},

Answer 3

注意：下面的解决方案仅在安装源分布zip或tarball或从源树中安装可编辑模式时起作用。从二进制轮安装（.whl）时，它将无法使用

---

可以在post_setup.py in 设置中包含一个解决方案.py的目录。 post_setup.py将包含一个函数，该函数执行后安装，setup.py仅在适当的时间导入并启动它。

在setup.py中：

from distutils.core import setup
from distutils.command.install_data import install_data

try:
    from post_setup import main as post_install
except ImportError:
    post_install = lambda: None

class my_install(install_data):
    def run(self):
        install_data.run(self)
        post_install()

if __name__ == '__main__':
    setup(
        ...
        cmdclass={'install_data': my_install},
        ...
    )

在post_setup.py中：

def main():
    """Do here your post-install"""
    pass

if __name__ == '__main__':
    main()

具有从其目录中启动setup.py的常见想法，您将能够导入post_setup.py否则它将启动一个空功能。

在post_setup.py中，如果__name __ =='__-main __'：语句允许您从命令行手动启动后安装。

Answer 4

结合@apalala，@zulu和@mertyildiran的答案；这在Python 3.5环境中对我有用：

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

class CustomInstall(install):
    def run(self):
        def _post_install():
            def find_module_path():
                for p in sys.path:
                    if os.path.isdir(p) and my_name in os.listdir(p):
                        return os.path.join(p, my_name)
            install_path = find_module_path()

            # Add your post install code here

        atexit.register(_post_install)
        install.run(self)

setup(
    cmdclass={'install': CustomInstall},
...

这也使您可以访问install_path中的软件包的安装路径，以进行一些外壳工作。

Answer 5

我认为执行后安装并保留要求的最简单方法是装饰呼叫setup（...）：

from setup tools import setup


def _post_install(setup):
    def _post_actions():
        do_things()
    _post_actions()
    return setup

setup = _post_install(
    setup(
        name='NAME',
        install_requires=['...
    )
)

这将运行setup（）声明设置时。完成要求安装后，它将运行_POST_INSTALL（）函数，该功能将运行内部函数_post_actions（）。

Answer 6

如果使用Atexit，则无需创建新的CMDClass。您只需在设置（）调用之前立即创建ATEXIT注册即可。它做同样的事情。

另外，如果您需要首先安装依赖关系，则可以使用PIP安装 ，因为在PIP将软件包移动到位之前，请调用您的Anexit处理程序。

Answer 7

我无法通过任何提出的建议解决问题，所以这对我有帮助。

您可以在setup（） in setup.py.py之类的setup（）之后拨打函数，就像：

from setuptools import setup

def _post_install():
    <your code>

setup(...)

_post_install()