如何运行Wheel包中的可执行Python脚本？规范做法与实现

1. 当前做法是否规范？ #

不是规范做法。直接通过绝对路径执行脚本会跳过Python的包导入机制，可能引发以下问题：

• 当包结构调整（比如脚本移动位置），命令就会失效
• 若脚本依赖包内的其他模块，可能因为路径问题导致ImportError
• 不利于在不同环境（比如其他虚拟环境）中复用，路径需要重新调整

2. 直接运行python myscript.py是否更优？ #

也不是最优解。这种方式依赖当前工作目录必须是脚本所在路径，一旦切换目录就无法执行，同样存在路径依赖问题，而且没有利用Python包管理的优势。

3. 如何实现规范的执行方式？ #

正确的做法是在构建wheel包时，配置控制台入口点（console scripts），这样安装包后会自动在虚拟环境的bin（Linux/macOS）或Scripts（Windows）目录下生成可执行命令，直接通过命令名就能运行脚本，无需关心路径。

具体实现步骤： #

• 在你的包的pyproject.toml（现代Python包推荐）中添加入口点配置：

  [project.scripts]
  myscript = "mypackage.mysubpackage.myscript:main"
  

  这里mypackage.mysubpackage.myscript是脚本的模块路径，main是脚本中要执行的函数（需要把脚本的核心逻辑封装到这个函数里）。
  如果你仍在使用setup.py，可以这样配置：

  from setuptools import setup
  
  setup(
      # 其他包配置项...
      entry_points={
          'console_scripts': [
              'myscript = mypackage.mysubpackage.myscript:main',
          ],
      }
  )
  

• 修改myscript.py，把执行逻辑封装到main()函数中：

  def main():
      # 原来的脚本执行代码
      print("Hello from myscript!")
  
  if __name__ == "__main__":
      main()
  

• 重新构建wheel包：

  python -m build --wheel
  

• 在虚拟环境中重新安装新构建的wheel包：

  (xyz)> pip install path/to/your/new/package.whl
  

• 完成后，无论当前工作目录在哪里，只要激活了虚拟环境，直接敲命令就能运行脚本：

  (xyz)> myscript
  

替代方案（无法修改包配置时）： #

如果暂时无法重新构建wheel包，可以通过以下方式简化调用：

• Linux/macOS：在虚拟环境的~/xyz/bin目录下创建名为myscript的脚本，内容如下：

  #!/bin/bash
  python ~/xyz/mypackage/mysubpackage/myscript.py "$@"
  

  然后赋予执行权限：chmod +x ~/xyz/bin/myscript
• Windows：在虚拟环境的~/xyz/Scripts目录下创建myscript.bat，内容如下：

  @echo off
  python "%USERPROFILE%\xyz\mypackage\mysubpackage\myscript.py" %*
  

  之后也能直接敲myscript运行，但这种方式不如入口点规范，包更新后可能需要手动维护路径。

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