如何在Python Setuptools框架下优雅实现PIP包自动安装APT依赖？

一、让Setuptools安装过程显示打印信息 #

Setuptools安装阶段的print输出可能被pip的输出缓冲机制屏蔽，改用sys.stdout.write()直接写入标准输出，能确保信息被用户看到。也可以结合内置的logging模块配置控制台输出，提升信息的可见性。

示例代码：

import sys
from setuptools import setup, Command

class CustomInstall(Command):
    description = "自定义安装逻辑"
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        sys.stdout.write("正在准备安装依赖检查...\n")
        # 执行你的前置逻辑
        self.run_command('install_lib')

setup(
    # 包的基本配置（name、version等）
    cmdclass={'install': CustomInstall}
)

二、告知用户运行自定义脚本my-package-install-specials #

可以通过多种方式明确传递信息：

• 安装后钩子提示：在自定义安装命令的末尾，用sys.stdout.write()输出醒目的提示，引导用户执行脚本：

  def run(self):
      # 执行默认安装逻辑
      self.run_command('install_lib')
      # 输出提示
      sys.stdout.write("\n=== 额外依赖安装提示 ===\n")
      sys.stdout.write("请运行以下命令完成`srm`依赖安装：\n")
      sys.stdout.write("sudo my-package-install-specials\n")
  

• README高亮说明：在包的README.md中添加重要安装步骤板块，明确告知用户需要执行该脚本，用户通过pip查看包详情时会看到这部分内容。
• 运行时检查提示：当用户首次调用包功能时，检查srm是否存在，若未找到则直接抛出清晰的错误提示，引导用户执行脚本。

三、每次调用srm时检查secure-delete是否安装是否属于不良实践？ #

这不仅不是不良实践，反而更推荐，原因如下：

• 鲁棒性更强：用户可能在安装包后卸载secure-delete，或在新环境（如容器）中复用包，每次调用前检查能避免无提示的运行时崩溃。
• 用户体验更友好：检查时可以给出明确的错误指引，比如raise RuntimeError("未找到srm命令，请执行sudo apt install secure-delete安装依赖")，比直接抛出subprocess错误更易理解。
• 性能可忽略：用shutil.which("srm")检查命令是否存在的逻辑极轻量，对整体性能无影响。

示例检查代码：

import shutil
import subprocess

def secure_delete(path_to_file):
    if not shutil.which("srm"):
        raise RuntimeError("未找到srm命令，请执行`sudo apt install secure-delete`安装依赖")
    subprocess.run(["srm", path_to_file], check=True)

内容的提问来源于stack exchange，提问作者Tom Hosker