检测Python正在视觉工作室代码中运行

Question

在某些情况下，如果在Visual Studio代码中运行，代码需要采取不同的行动。

有人知道检测Python代码在Visual Studio代码调试器中运行的最有效方法吗？

到目前为止，我能找到的最好的方法是使用：

import sys
if 'debugpy' in sys.modules:
    print("Running in VS Code")

Answer 1

在vscode上，环境变量term_program设置为“ vscode”，您可以通过：

import os
if 'TERM_PROGRAM' in os.environ.keys() and os.environ['TERM_PROGRAM'] == 'vscode':
    print("Running in VS Code")

Answer 2

我认为解决此问题的最优雅方法只是在Vscode中设置运行任务，该任务运行Python脚本带有额外的命令行标志。

例如：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--vscode', action='store_true')

args = parser.parse_args()

if args.vscode:
    print("vscode")
else:
    print("not vscode")

然后，如果您调用脚本python myScript.py

'不是vscode'

python myScript.py -vscode

'vscode'

然后您只需在VSCODE中添加运行任务：

{
    "label": "run",
    "command": "python", // or python3
    "group": {
        "kind": "test",
        "isDefault": true
    },
    "args": [
        "${file}",
        "--vscode"
    ],
    "presentation": {
        "echo": true,
        "panel": "shared",
        "focus": true
    },
    "problemMatcher": []
}

要运行代码，只需在运行任务中使用快捷方式

Answer 3

尽管我认为 @Eran的答案感觉最为简洁，但这是另一种方法：

if ('debugpy' in sys.modules \
       and sys.modules['debugpy'].__file__.find('/.vscode/extensions/') > -1):
    print("Running in VS Code")

它检测debugpy，如果另一个工具使用相同的debugpy namesspace，则会防止误报。