Odoo Gevent 环境下 VSCode 远程调试断点不命中解决方案

本文提供odoo在gevent环境下使用vscode进行远程调试时，断点无法命中的解决方案。核心问题源于debugpy与gevent_support=true的冲突。解决方案涉及修改vscode调试配置，移除gevent_support，并创建一个自定义python入口脚本。该脚本在debugpy启动后重新启用gevent支持，并执行odoo主程序，从而绕过bug，使断点正常工作。此方法尤其适用于python 3.12以下版本。

Odoo Gevent 环境下 VSCode 远程调试断点不命中解决方案

在使用VSCode远程调试基于Docker部署的Odoo应用时，开发者可能会遇到一个常见且令人困扰的问题：即使所有配置看起来都正确，断点却无法命中。这通常发生在Odoo运行在Gevent环境下，并且VSCode的debugpy调试器配置了GEVENT_SUPPORT=True时。本文将详细介绍这一问题的原因及提供一个有效的解决方案。

问题描述与根源分析

当通过Docker Compose启动Odoo环境，并尝试使用VSCode的debugpy进行远程附加调试时，尽管debugpy服务已在容器内监听（例如在5678端口），VSCode也成功连接，且断点显示为红色（表示VSCode已识别文件并设置断点），但实际执行到断点处时，程序并不会暂停。

在调试过程中，debugpy的输出日志可能会反复出现提示：“It seems that the gevent monkey-patching is being used. Please set an environment variable with: GEVENT_SUPPORT=True to enable gevent support in the debugger.” 这表明debugpy在处理Gevent环境时存在兼容性问题。

根据debugpy官方GitHub仓库的报告，这是一个已知的问题（例如，microsoft/debugpy#1206），即当debugpy在启动时检测到GEVENT_SUPPORT=True环境变量时，会导致其内部处理逻辑出现异常，从而阻止断点正常工作。此问题在Python 3.12及更高版本中已得到修复，但对于旧版本的Python环境，仍需要采取特定的规避措施。

解决方案：自定义入口点与环境变量管理

解决此问题的核心思路是：在debugpy启动时，不让它直接感知到GEVENT_SUPPORT=True，而是在debugpy成功启动并准备好调试会话后，再通过自定义脚本来设置Gevent支持并启动Odoo。

以下是详细的步骤和配置：

步骤一：修改 VSCode 调试配置 (launch.json)

首先，需要从VSCode的launch.json配置文件中移除或禁用GEVENT_SUPPORT环境变量。这将确保debugpy在启动时不会因该变量而产生冲突。

{
    "version": "0.2.0",
    "env": {
        // "GEVENT_SUPPORT": "True" // 移除或注释掉此行，避免debugpy启动时冲突
    },
    "configurations": [
        {
            "name": "Debug Odoo Remote",
            "type": "python",
            "request": "attach",
            "connect": {
                "host": "127.0.0.1", // 调试器连接的主机地址，通常是宿主机IP或localhost
                "port": 5678        // debugpy监听的端口
            },
            "pathMappings": [
                {
                    "localRoot": "/local_folder/odoo", // 替换为你的本地Odoo项目根目录
                    "remoteRoot": "/remote_folder/odoo" // 替换为容器内Odoo项目根目录
                }
            ],
            "justMyCode": true // 仅调试用户代码，忽略库代码，提高调试效率
        }
    ]
}

注意事项：

千帆大模型平台

面向企业开发者的一站式大模型开发及服务运行平台

35

查看详情

• 确保localRoot和remoteRoot路径正确映射了本地与容器内的Odoo项目根目录，这是远程调试的关键。
• justMyCode: true 是一个可选设置，可以帮助你专注于自己的代码，避免进入第三方库的内部，从而减少不必要的调试中断。

步骤二：创建自定义 Odoo 入口点脚本

在Odoo项目或相关路径下创建一个新的Python文件，例如命名为 odoo_custom.py。这个脚本将作为Odoo的实际启动点，并在其中手动设置GEVENT_SUPPORT环境变量。

#!/usr/bin/env python3

import sys
import os

# 将Odoo框架路径添加到Python模块搜索路径
# 替换为你的Odoo框架实际路径，例如：/opt/odoo/odoo/odoo-bin所在的父目录
sys.path.append('/path/to/project_folder/framework') 

# 在debugpy启动后，手动启用gevent支持
# 这样可以避免debugpy在启动时因GEVENT_SUPPORT=True而产生的冲突
os.environ['GEVENT_SUPPORT'] = 'true'

# 设置服务器时区为UTC，确保时间处理一致性，避免时区问题
os.environ['TZ'] = 'UTC'

# 导入并执行原始的odoo-bin脚本
if __name__ == "__main__":
    # 替换为你的odoo-bin脚本的实际路径
    with open("/path/to/project_folder/framework/odoo-bin") as f:
        code = compile(f.read(), "odoo-bin", 'exec')
        exec(code)

关键点解释：

• sys.path.append(...): 确保Python解释器能够找到Odoo的模块。你需要将/path/to/project_folder/framework替换为你的Odoo容器内实际的框架路径，通常是odoo-bin文件所在的父目录。
• os.environ['GEVENT_SUPPORT'] = 'true': 这是核心操作，在debugpy加载完毕且没有因初始GEVENT_SUPPORT冲突后，再手动启用Gevent支持。
• os.environ['TZ'] = 'UTC': 这是一个常见的最佳实践，用于确保Odoo服务器的时区一致性。
• exec(code): 这段代码会读取并执行原始的odoo-bin脚本，确保Odoo的正常启动流程。同样，你需要将/path/to/project_folder/framework/odoo-bin替换为容器内odoo-bin的实际路径。

步骤三：更新 Docker Compose 启动命令

最后，修改docker-compose.yml文件中的Odoo服务配置，将command指令指向新创建的自定义入口点脚本。

services:
  odoo:
    # ... 其他Odoo服务配置
    ports:
      - "8069:8069" # Odoo HTTP端口映射
      - "5678:5678" # debugpy 调试端口映射
    expose:
      - 8069
      - 5678
    command: "python3 -m debugpy --listen 0.0.0.0:5678 --wait-for-client /path/to/project_folder/custom.py args"
    # ... 其他Odoo服务配置

注意事项：

• --listen 0.0.0.0:5678: debugpy将在容器内监听所有网络接口的5678端口，以便宿主机能够连接。
• --wait-for-client: Odoo服务将等待VSCode调试器连接后才继续执行，这对于确保调试会话的稳定启动非常重要。
• /path/to/project_folder/custom.py: 务必替换为你的odoo_custom.py脚本在容器内的实际路径。
• args: 如果Odoo需要额外的启动参数（例如数据库配置、模块加载等），可以在此处添加。

整体调试流程

1. 启动 Docker Compose 环境： 在终端中运行 docker-compose up -d (或不带 -d 查看实时日志)。
2. 等待调试器连接： 容器中的Odoo服务会启动debugpy并进入等待客户端连接的状态。
3. 在 VSCode 中启动调试： 在VSCode中打开调试视图，选择之前配置的“Debug Odoo Remote”配置，然后点击启动调试按钮。
4. 命中断点： 此时，当你在Odoo代码中设置的断点被执行到时，VSCode调试器应该能够正常暂停，允许你进行变量检查、单步执行等操作。

总结与未来展望

通过上述自定义入口点的方法，我们成功规避了debugpy在处理GEVENT_SUPPORT=True环境变量时的已知问题，使得Odoo在Gevent环境下也能通过VSCode进行远程调试。

需要注意的是，这个解决方案是一个针对特定debugpy版本和Python环境的临时性工作。根据debugpy官方的更新，此问题已在2024年1月3日得到修复，并将在Python 3.12及更高版本中生效。因此，如果你的Odoo环境使用的是Python 3.12或更高版本，并且debugpy版本也足够新，你可能不再需要这个复杂的自定义入口点。但对于使用旧版Python的Odoo部署，这个方法仍然是进行有效调试的关键。在实际应用中，始终建议保持开发工具和环境的更新，以利用最新的修复和改进。

以上就是Odoo Gevent 环境下 VSCode 远程调试断点不命中解决方案的详细内容，更多请关注php中文网其它相关文章！