自定义包中try/except包裹的debugpy异常为何在pip install时未被捕获？

核心原因 #

pip安装包的过程中，你的调试代码可能在模块顶层作用域被执行了——比如你的包的__init__.py或者setup.py里直接导入了包含这段代码的模块，导致安装阶段就触发了debugpy.connect()，而此时的执行环境和正常运行时完全不同，异常要么没被try/except覆盖到，要么根本没走到捕获逻辑里。

具体场景拆解 #

1. 调试代码写在模块顶层：如果你的调试代码没有放在函数/类内部，而是直接写在.py文件的顶层，那么当pip安装时导入这个模块（比如setup.py里用了import your_package），代码会立刻执行。这时候可能遇到：

   • debugpy还没安装（如果你的包没把debugpy列为依赖，pip会先处理你的包，debugpy还未安装完成，import debugpy就会抛ImportError，而如果你的try/except只包裹了connect()，没包裹import语句，这个异常就会直接抛出）
   • 安装环境的特殊限制导致debugpy.connect()抛出了BaseException子类（比如SystemExit），这类异常不会被except Exception捕获，裸except虽然能捕获，但如果代码逻辑里没覆盖到触发场景，也没用。

2. setup.py不当导入包代码：很多人写setup.py时会直接导入包的模块来获取版本号（比如from your_package import __version__），这会触发模块顶层所有代码执行，包括你的调试逻辑。

解决步骤 #

• 把调试代码移到函数内部：不在模块顶层直接执行，而是封装成初始化函数，让用户主动调用才触发：

  def init_debug():
      try:
          import debugpy
          debugpy.connect(("localhost", 5678))
      except Exception:
          pass
  

  安装阶段没人调用这个函数，自然不会触发异常。

• 用环境变量控制调试逻辑：如果必须在模块加载时执行，先判断环境变量，只有开启调试标记时才运行：

  import os
  if os.getenv("ENABLE_DEBUGPY") == "1":
      try:
          import debugpy
          debugpy.connect(("localhost", 5678))
      except BaseException:
          pass
  

  安装时没有这个环境变量，代码根本不会走到try块，也就不会抛异常。

• 修复setup.py的导入问题：如果setup.py里导入了包的模块，改用读取文件的方式获取版本号，避免触发模块代码：

  import re
  with open("your_package/__init__.py", "r") as f:
      version = re.search(r'__version__ = "(.*?)"', f.read()).group(1)
  

• 把debugpy列为依赖项：在setup.py的install_requires里加上debugpy，或者在pyproject.toml的dependencies里声明，这样pip安装时会先安装debugpy，避免导入失败。

• 查看详细安装日志：执行pip install -v your_package，查看具体的异常栈，定位到底是哪一行代码抛出的异常，针对性解决。

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