IT博客汇 | 一日一技：setup.py里面的两个小技巧

一日一技：setup.py里面的两个小技巧

青南发表于 2024-04-07 13:08:02

当你要自己发布一个Python包时，下面这两个小技巧可能对你有用。

pip安装后执行代码

今天公众号粉丝群里面，有同学提问：

这个同学自己开发了一个Python包，这个包在使用pip安装时，会产生一些临时文件。他希望安装完成以后，能够自动清理这些临时文件。

要实现这个需求，可以使用Python自带的setuptools来实现。代码如下：

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

class CustomInstallCommand(install):
    """自定义安装命令，执行标准安装后跟自定义代码。"""
    def run(self):
        install.run(self)
        print("执行自定义安装后的代码...")
        os.remove('需要删除的文件1路径')
        os.remove('需要删除的文件2路径')
        print('这里可以写任意代码')

setup(
    name='your_package_name',
    version='0.1',
    packages=find_packages(),
    cmdclass={
        'install': CustomInstallCommand,
    },
)

当你把代码上传到Pypi以后，用户依然是使用pip install xxx来安装这个包。安装完成以后，就可以自动删除临时文件了。

额外依赖

大家在安装某些第三方库时，可能会看到它的安装说明里面，让你这样写：

1	pip install "xxx[yyy]"

如下图所示：

这种写法是什么意思呢？实际上这叫做可选的额外依赖(extras)。有一些功能比较强大的第三方库，他需要安装很多依赖。但是如果我只需要使用其中的特定某个功能，那么实际上只需要安装这个功能需要的依赖就可以了。根本没有必要安装所有依赖。

这种情况下，就可以使用额外依赖。在setup.py里面，添加extras_require参数：

setup(
    name='your_package_name',
    version='0.1',
    packages=find_packages(),
    install_requires=['requests']
    extras_require={
    'excel': ['pandas>=1.20.0'],
    'lxml': ['lxml'],
    'all': ['pandas>=1.20.0', 'lxml']
    },
)

那么当用户使用pip install xxx安装这个包时，默认只会安装requests一个依赖。当使用pip install "xxx[lxml]"时，会安装requests和lxml。当使用pip install "xxx[all]"时，会安装requests、lxml和pandas。