使用dh_virtualenv打包Python为Debian包时console_scripts不在PATH问题

我之前处理过完全相同的需求，直接复制文件到/usr/bin/确实能解决问题，但不符合Debian包的维护规范（卸载时会残留文件）。下面是两种更标准的最佳实践方案：

方案一：用Debian Links文件管理符号链接（最推荐） #

这是最贴合Debian打包生态的方式，利用debhelper的dh_link工具自动处理链接的创建与清理：

1. 在你的Debian打包目录（通常是debian/）下创建一个名为my_package.links的文件（把my_package换成你的包名）。
2. 在文件里为每个console script添加一行链接规则，格式是源路径 目标路径：

   /opt/venvs/my_package/bin/your_script1 /usr/bin/your_script1
   /opt/venvs/my_package/bin/your_script2 /usr/bin/your_script2
   

3. 确保你的debian/rules文件里包含dh_link的调用（dh-virtualenv打包流程会自动识别并执行这个工具，通常无需手动修改rules，除非你自定义了流程）。

这样安装包时，系统会自动创建这些符号链接；卸载包时，也会自动删除链接，完全符合Debian包的清理规范。

方案二：自定义postinst/postrm脚本（灵活度更高） #

如果你的console scripts数量很多，或者需要动态处理链接，可以通过自定义Debian包的维护脚本来实现：

1. 在debian/目录下创建extra/文件夹，然后分别创建postinst和postrm脚本：
   • postinst（安装后执行）：

     #!/bin/sh
     set -e
     
     # 遍历虚拟环境下的可执行脚本，创建全局符号链接
     for script in /opt/venvs/my_package/bin/*; do
         script_name=$(basename "$script")
         # 只处理可执行文件，且避免重复创建链接
         if [ -x "$script" ] && [ ! -L "/usr/bin/$script_name" ]; then
             ln -s "$script" "/usr/bin/$script_name"
         fi
     done
     

   • postrm（卸载时执行）：

     #!/bin/sh
     set -e
     
     if [ "$1" = "remove" ] || [ "$1" = "purge" ]; then
         # 清理之前创建的符号链接
         for script in /opt/venvs/my_package/bin/*; do
             script_name=$(basename "$script")
             if [ -L "/usr/bin/$script_name" ]; then
                 rm -f "/usr/bin/$script_name"
             fi
         done
     fi
     

2. 给这两个脚本添加可执行权限：chmod +x debian/extra/postinst debian/extra/postrm
3. 在debian/rules里的dh_virtualenv调用中添加--extra-dir=debian/extra/参数，让dh-virtualenv合并这些自定义脚本到最终的包维护流程里。

关键注意事项 #

• 绝对不要直接复制文件到/usr/bin/：卸载包时这些文件不会被Debian包管理系统识别，会残留垃圾文件。
• 确保你的console scripts的shebang指向虚拟环境的Python：比如#!/opt/venvs/my_package/bin/python，这样即使全局调用，也会使用虚拟环境里的依赖，避免版本冲突。
• 如果你的脚本和系统已有命令重名，建议给脚本加前缀（比如my_package-script1），避免覆盖系统命令。

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