Python 语言

导读

VSCode Python 扩展版本 v2021.12.1559732655

阅读本章节，可以了解到如何使用 VSCode 开发 Python 语言项目，其功能主要由如下几款 VSCode Python 扩展：

• Python - MIT 许可证
• Jupyter - MIT 许可证 （仅交互式 Python 涉及部分）
• Pylance - 闭源 Microsoft proprietary license
• Visual Studio IntelliCode - 闭源 许可证

特性速览

VSCode Docs - Language Python

• 环境管理
• 代码编辑（自动完成、快速修复、格式化、重构、代码生成、代码片段）
• 代码浏览（调转定义、查找引用、查找实现、调用层次、类型层次）
• 问题诊断（类型检查、Lint）
• 代码运行和调试
• 测试
• 数据分析（本文暂不涉及，后续有专门文章讲解描述）
• 交互式 Python
• 场景
  • Django 支持
  • Flask 支持
  • VSCode Web 支持

快速开始

VSCode Docs - Python Tutorial

• 安装 Python，参见 Python 官方文档
• 安装 VSCode
• 在 VSCode 中，安装如下几个扩展
  • Python - MIT 许可证
  • Jupyter - MIT 许可证
  • Pylance - 闭源 Microsoft proprietary license
  • Visual Studio IntelliCode - 闭源 许可证
• 使用 VSCode 打开 Python 文件或者 Python 项目
• Enjoy it!

使用指南

环境管理

VSCode Docs - Python Environments

一台设备可以装多个 Python 解析器，这些 Python 解释器会关联一些了 Python 包。因此某个和 Python 解释器和其关联的 Python 包的集合称为一个 Python 环境。更多关于 Python 环境，可以参见另一篇文章：一文彻底理解 Python 环境

VSCode Python 支持管理各种的 Python 环境，可以通过状态栏观察当前工作空间绑定的 Python 环境。

点击上图状态栏，可以快速浏览当前系统所有可用的 Python 环境，如下图所示：

选择一个，即可快速和工作空间关联。通过 "python.defaultInterpreterPath" 可以给所有工作空间配置一个默认的 Python 环境。（该配置支持引用环境变量，语法为 ${env:环境变量名}，例如 "python.defaultInterpreterPath": "${env:PYTHON_INSTALL_LOC}"）

Python 环境列表除了通过状态唤起外，还支持通过 >python: select interpreter 命令唤起，该列表默认按照如下逻辑去查找系统内的 Python 环境：

• 操作系统 PATH 环境变量指向的路径（echo $PATH 查看，查找路径）
• 当前工作空间目录的虚拟环境目录（一般为 .venv）
• python.venvPath 配置指向的路径，该路径可以包含多个虚拟环境目录
• virtualenvwrapper 支持的 ~/.virtualenvs 文件夹中的虚拟环境
• 由 pyenv、Pipenv 和 Poetry 安装的解释器
• 位于 WORKON_HOME 环境变量指向目录中的虚拟环境
• 包含 Python 解释器的 Conda 环境（不显示不包含解释器的 conda 环境）
• direnv 安装的 .direnv 目录

此外

• 还可以手动指定 Python 解释器，此外如果在工作空间目录中发现 pipenv 环境，则不会显示其他的 Python 环境，因此 pipenv 会管理这一切。
• Python 扩展还会加载由 python.envFile 配置指向的环境变量文件。默认值为 ${workspaceFolder}/.env

VSCode 选择一个 Python 环境后，其作用范围如下所示：

• 打开终端，会自动选中的 Python 环境，可用通过 "python.terminal.activateEnvironment": false 配置关闭该特性。
• 智能感知、Lint 等特性都会使用该 Python 环境。
• 断点调试时，默认使用该 Python 环境启动调试器（可以通过调试器的 python 字段覆盖默认配置）

默认情况下 Python 扩展会读取 ${workspaceFolder}/.env 文件中定义的环境变量（可以通过 python.envFile 配置自定义）。该文件语法非常简单：

• 通过 environment_variable=value 定义变量
• 使用 # 注释
• 支持 ${env:EXISTING_VARIABLE} 进行变量替换，不支持嵌套

在该文件中定义的环境变量将影响 Language Server 和调试器的行为（如 PYTHONPATH）

代码编辑

智能感知

编写代码中会自动触发建议列表、参数及其位置提示，鼠标 Hover 到代码出会显示对应位置的符号的文档。

• 建议列表 editor.action.triggerSuggest，手动唤起默认快捷键为 cmd + i。
• 显示参数和参数位置提示 editor.action.triggerParameterHints，手动唤起默认快捷键为 cmd+shift+space。
• 显示悬浮文档 editor.action.showHover，手动唤起默认快捷键为 cmd+k cmd+i。

注意：由于 Python 是弱类型语言，在没有启用类型注解的情况下，智能感知的能力是有限的。

Python 的智能感知能力由如下 Language Server 提供，通过 python.languageServer 进行配置

• Default （默认），当安装了 Pylance 时，将使用 Pylance，否则使用 Jedi。
• Jedi 使用 jedi
• None 关闭智能感知

通过 >Python: show language server output 可以输出，关于 Pylance 和 Jedi 参见下文。

智能感知支持添加自定义 Python 包，通过 python.autoComplete.extraPaths 进行配置，如：

"python.autoComplete.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

快速修复和重构

• 自动导入（需在当前环境中安装相关包）

• 提取变量、提取函数函数

• 符号重命名和模块重命名

• 导入排序 (>Python Refactor: Sort Imports 命令唤起)，可以通过 "python.sortImports.args": ["-rc", "--atomic"], 配置项进行配置。排序脚本参见 isort

格式化

通过 python.formatting.provider 配置项可以配置 Python 格式化器，默认为 "autopep8"，选项为 "autopep8"、"yapf"或"black"。使用这些格式化器时，需要如下配置

• autopep8，pip install pep8 & pip install --upgrade autopep8，特殊的配置项 python.formatting.autopep8Args，python.formatting.autopep8Path
• black，pip install black，特殊的配置项 python.formatting.blackArgs，python.formatting.blackPath （只支持运行在 Python 3 环境）
• yapf，pip install yapf，特殊的配置项 python.formatting.yapfArgs，python.formatting.yapfPath

下面有一些配置例子

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 20}"],
"python.formatting.blackArgs": ["--line-length", "100"]

代码浏览

代码编辑器鼠标右击，打开上下文菜单，可以调转定义、查找引用、查找实现、调用层次

• 调转定义 editor.action.revealDefinition ，快捷键 F12
• 查找引用 editor.action.goToReferences，快捷键 shift+F12
• 查找实现 editor.action.goToImplementation，快捷键 cmd+F12，光标在接口上
• 查找工作空间所有符号
• 调用层次 references-view.showCallHierarchy，快捷键 shift+option+H，命令名 >Calls: Show Call Hierarchy
• Explorer （资源管理器）的 Outline （大纲），可以看到当前编辑器打开文件的符号列表

问题诊断

默认情况下，针对语法问题，VSCode Python 默认会通过 Language Server 对项目进行语法检查。但在 Python 这种弱类型的编程语言的项目路中，如果想在工程中使用，光靠语法检查是不够的，静态代码检查（如代码风格）是必不可少的。因此 VSCode Python 支持与多种 Python 业界主流的 Lint 工具集成。

• 启用或禁用 Lint
  • 方式 1：通过 >Python: Select Linter 命令启用或者禁用 Lint 工具（默认启用 pylint）
  • 方式 2：通过 "python.linting.<linter>Enabled": true 配置启用或禁用 Lint 工具
• 触发 Lint 运行
  • 检查单文件：保存文件时自动触发
  • 检查整个项目：通过 >Python: Run Linting 命令手动触发
• Lint 输出，在编辑器会以波浪线方式展示，并问题面板可以浏览所有问题

• Lint 相关配置

  • python.linting.enabled 是否启用 Lint，默认 true
  • python.linting.lintOnSave 在保存文件时执行 Lint，默认 true
  • python.linting.maxNumberOfProblems 最大问题数量，默认 100
  • python.linting.ignorePatterns 忽略检查的目录或文件，默认为 [".vscode/*.py", "**/site-packages/**/*.py"]

• 不同 Lint 工具集成有不同的配置，需要安装不同的依赖和配置项，所有支持的 Lint 参见下表

• 命令行参数例子

  "python.linting.pylintArgs": ["--reports", "12", "--disable", "I0011"],
  "python.linting.flake8Args": ["--ignore=E24,W504", "--verbose"]
  "python.linting.pydocstyleArgs": ["--ignore=D400", "--ignore=D4"]

• 不同 Lint 工具配置参见下方链接

  • Pylint
  • pydocstyle
  • pycodestyle (pep8)
  • prospector
  • Flake8
  • mypy
  • pylama
  • bandit

代码运行和调试

交互式运行

• >Python: Run Selection/Line in Python Terminal 通过该命令，可以快速启动一个 Python REPL，并将选中代码发送到 该 REPL 中运行。
• >Python: Start REPL 快速启动一个 Python 解释器。
• >Python: run selection/line in Django shell 针对 Django 项目，可以选择在 Django Shell 中运行。
• 还可以田健 #%% 注释，快速在交互式窗口运行，参见下文：交互式 Python

使用默认配置快速运行或调试

VSCode Python 支持免配置的快速启动调试

• 按 F5 快速调试当前文件，按 Ctrl + F5 快速调试当前文件
• 点击调试视图的【运行和调试】按钮
• 点击编辑器标题栏右上角图标快速运行调试当前 Python 文件
  • 点击三角号运行当前文件
  • 点击右侧展开按钮可以调试当前文件

创建或添加调试配置

打开调试视图

• 在没有调试配置时，点击 create a launch.json file
  • 根据情况选择调试的调试配置模板
  • 将创建并打开 .vscode/launch.json 文件
• 在有调试配置时，按可通过如下方式添加一个新的调试配置

调试 Python 文件默认生成的文件配置的例子

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: 当前文件",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal"
        }
    ]
}

状态栏调试信息

当存在调试配置时，可以通过状态栏观察当前选中的调试配置，点击可快速选择并启动调试

调试能力详解

在此仅介绍断点能力

• 普通断点，点击编辑器左侧边框，在指定行添加断点，或者在光标所在位置按 F9
• 条件断点，右击编辑器左侧边框，选择条件断点
  • 表达式类型，输入一个结果为 bool 的表达式
  • 命中次数类型
    • 支持一个确定的整数
    • 支持比较运算符 (>, >=, <, <=, ==, !=) 加一个整数
    • 支持 % n 表示每命中 n 次断点一次
  • Logpoint，命中断点后再调试控制台输出日志
• 函数断点，在测试侧边栏中，最下方断点视图，点击加号，输入当前打开文件的函数名
• 通过代码添加断点
  • import debugpy
  • debugpy.breakpoint()

其他调试 VSCode Debug 视图和通用能力，参见：VSCode Docs - User Guide Debugging

选择一个配置启动调试

• cmd + p 输入 debug，选择添加配置，选择 Go: Launch Package 回车将创建并打开 .vscode/launch.json 文件
• 启动调试，有如下几种方式
  • F5 或者 >Debug: start debugging 以上次选中的调试配置启动调试
  • cmd + p 输入 debug 并选择调试配置，并启动调试
  • 菜单 > Run > Start debugging
  • 打开调试侧边栏，绿色三角号

• 运行（不调试），有如下几种方式
  • ctrl+F5 或者 >debug: start without debugging
  • 菜单 > Run > start without debugging

调试配置详解

本部分描述 .vscode/launch.json Python 调试配置支持的全部字段

• name 调试配置名，可以自定义
• type 调试类型，写死 python
• request 可选值为 launch 或者 attach
• request 为 launch 相关配置，配置 debug 的程序如何启动
  • pragram 启动的 Python 文件的绝对路径，可以使用魔法变量如（${file}、${workspaceFolder}，更多参见：变量手册）
  • module 提供指定要调试的模块名称的功能，类似于在命令行运行时的 -m 参数。有关更多信息，请参阅 Python.org
  • python Python 解释器路径。如果未指定，则此设置默认为为您的工作区选择的解释器，相当于使用 ${command:python.interpreterPath}
  • pythonArgs 传递给 Python 解释器的命令行参数
  • console 启动用户程序的终端
    • integratedTerminal 集成终端，即在 VSCode 终端中启动（可以处理标准输入）（推荐）（默认）
    • internalConsole 调试控制台，即在 VSCode 调试控制台启动（不能向进程里面输入标准输入）
    • externalTerminal 外部终端，不建议（调用操作系统中的终端程序）
  • internalConsoleOptions 控制是否如何打开调试控制台
    • neverOpen 从不打开
    • openOnFirstSessionStart" 仅第一次调试时打来
    • openOnSessionStart 每次调试都打开
  • env 环境变量
  • envFile 环境变量文件
  • args 命令行参数
  • stopOnEntry 当设置为 true 时，在被调试程序的第一行中断调试器。如果省略（默认）或设置为 false，调试器将程序运行到第一个断点。
  • autoReload 允许在调试器执行达到断点后对代码进行更改时自动重新加载调试器。要启用此功能，请设置 {"enable": true} （注意：当调试器执行重新加载时，导入时运行的代码可能会再次执行。为避免这种情况，请尝试仅在模块中使用导入、常量和定义，将所有代码放入函数中。或者，您也可以使用 if __name__=="__main__" 检查。）
  • purpose 该配置覆盖一些按钮的默认行为
    • debug-test，该配置用于调试测试
    • debug-in-terminal，该配置应用与于 Debug Python File in Terminal
  • subProcess 调试子进程，默认为 false，更多参见：multi-target debugging
  • cwd 调试进程的 WorkDir，默认为 ${workspaceFolder}
  • redirectOutput 当设置为 true（internalConsole 的默认值）时，会导致调试器将程序的所有输出打印到 VSCode 调试控制台窗口中。如果设置为 false（integratedTerminal 和 externalTerminal 的默认值），则程序输出不会显示在调试器输出窗口中。
  • justMyCode 默认为 true，将调试仅限于用户编写的代码。设置为 false 还可以启用标准库函数的调试。（建议修改为 false）
  • django 默认为 false，当设置为 true 时，将启用 django 特性，支持 django 模板的调试
  • sudo 默认为 false，当设置为 true 时，会在启动程序是通过 sudo 启动，可以输入密码
  • pyramid 默认为 false，当设置为 true 时，将启用 pyramid 特性
  • gevent 启用 gevent，参见 https://www.gevent.org/intro.html
  • jinja 默认为 false，当设置为 true 时，会启用 Jinja templating engine 的支持
• request 为 attach 相关配置，配置 debug 如何连接到远端
  • connect 配置远端 host 和 port
  • pathMappings 远端代码和本地代码的映射
• logToFile Enable logging of debugger events to a log file.
• showReturnValue 默认为 true，是否展示返回值
• 平台特性配置
  • windows
  • linux
  • osx

测试

VSCode Python 支持 unittest 和 pytest

相关代码

假设我们待测是模块为 inc_dec.py，代码如下：

def increment(x):
    return x + 1

def decrement(x):
    return x - 1

添加 pytest 测试代码 test_pytest.py

import inc_dec    # The code to test


def test_increment():
    assert inc_dec.increment(3) == 4


def test_decrement():
    assert inc_dec.decrement(3) == 4

添加 unittest 测试代码 test_unittest.py

import inc_dec    # The code to test
import unittest   # The test framework


class Test_TestIncrementDecrement(unittest.TestCase):
    def test_increment(self):
        self.assertEqual(inc_dec.increment(3), 4)

    def test_decrement(self):
        self.assertEqual(inc_dec.decrement(3), 4)


if __name__ == '__main__':
    unittest.main()

快速启用测试特性

• 打开测试浏览器，点击 Configuare Python Tests，可以快速配置测试。或者通过 >Python: Configure Tests 命令，也可以配置测试

• 以上选择，都会应用到 python.testing.unittestEnabled 和 python.testing.pytestEnabled 配置项，如果两个框架都启用，那么 Python 扩展将只运行 pytest。当启用测试框架时，如果当前激活的环境中尚不存在框架包，VS Code 会提示您安装该框架包：

运行或调试测试

有很多中运行测试的方法

• 打开测试文件后，选择测试定义行旁边的装订线中显示的绿色运行图标。点击可以直接运行，右击可以选择调试

• 通过如下命令运行测试
  • >Test: Run All Tests 运行所有测试
  • >Test: Run Tests in Current File 运行当前文件的所有测试
  • >Test: Run Test at Cursor 运行光标位置处的测试
• 通过如下命令调试测试
  • >Test: Debug All Tests 调试所有测试
  • >Test: Debug Tests in Current File 调试当前文件的所有测试
  • >Test: Debug Test at Cursor 调试 光标位置处的测试
• 从测试浏览器启动运行
  • 要运行所有发现的测试，请选择测试资源管理器顶部的播放按钮：
  • 要运行一组特定的测试或单个测试，请选择文件、类或测试，然后选择该项目右侧的播放按钮
  • 还可以通过测试资源管理器运行一系列测试。为此，请在要运行的测试上按 Ctrl+单击（或在 macOS 上为 Cmd+单击），右键单击其中一个，然后选择运行测试。

• 从测试浏览器启动调试
  • 要调试所有发现的测试，请选择测试资源管理器顶部的小虫子按钮：
  • 要运行一组特定的测试或单个测试，请选择文件、类或测试，然后选择该项目右侧的小虫子按钮
  • 您还可以通过测试资源管理器运行一系列测试。为此，请在要运行的测试上按 Ctrl+单击（或在 macOS 上为 Cmd+单击），右键单击其中一个，然后选择运行测试。

测试运行后，VS Code 将结果直接在编辑器中显示为装订线装饰。失败的测试也将在编辑器中突出显示，带有显示测试运行错误消息和所有测试运行历史记录的查看视图。您可以按 Escape 关闭视图，可通过 testing.automaticallyOpenPeekView 配置项设置。

另外，关于测试运行的输出，可以在 Python Test Log 输出面板找到。

通过 pytest-xdist 可以支持并发测试，更多参见：官方文档

通过 purpose 字段设置为 "debug-test" 可以为测试的调试添加调试配置，例如

{
    "name": "Python: Current File",
    "type": "python",
    "request": "launch",
    "program": "${file}",
    "purpose": ["debug-test"],
    "console": "integratedTerminal",
    "justMyCode": false
}

发现项目的测试

VSCode Python 默认开启了自动测试发现特性（可通过 python.testing.autoTestDiscoverOnSaveEnabled 配置关闭）。

也可以通过测试浏览器的刷新按钮手动刷刷新测试。

如果测试找不到，可能是测试目录没有 __init__.py，没有被识别成 Python 包。

如果有发现失败，可以通过 Python 输出面板查看具体原因

全部测试命令

全部测试配置

VSCode 测试通用配置，按 cmd + ,，搜索 Testing

Python 扩展通用配置

unittest 配置

unittest 的默认参数如下：

• -v 设置 verbosity 级别的输出。删除此参数以获得更简单的输出。
• -s . 指定用于发现测试的起始目录。如果 "test" 文件夹中有测试，请将参数更改为 -s test（在参数数组中表示"-s", "test"）。
• "-p *test*.py" 是用于查找测试的发现模式。在本例中，它是包含单词 test 的任何 .py 文件。如果以不同的方式命名测试文件，例如将 _test 附加到每个文件名，请在数组的相应参数中使用类似 "*_test.py" 的模式。

若要在第一次失败时停止测试运行，请将快速失败选项 "-f" 添加到参数数组中。

关于 unittestArgs 更多参见 unittest command-line interface

pytest 配置

可以通过 pytest.ini 文件配置，更多参见 pytest Configuration.

注意：如果安装了 pytest-cov 覆盖模块，则 VSCode 在调试时不会在断点处停止，因为 pytest-cov 使用相同的技术来访问正在运行的源代码。为防止此行为，请在调试测试时在 pytestArgs 中包含 --no-cov，或者通过将 "env": {"PYTEST_ADDOPTS": "--no-cov"} 添加到您的调试配置中。 （有关更多信息，请参阅 pytest-cov 文档中的调试器和 PyCharm）

交互式 Python

VSCode 支持一个普通的 Python 文件提供 Jupyter Cell 一样的交互式能力。（本文关注的是与 Python 源代码文件有关的特性，更多关于 Jupyter 详细说明，后续会在数据分析专题中讲述）

Python 交互式文件

• 在后缀为 py 的文件，通过特殊注释进行单元格区分 # %%，那么这个文件就会被识别为 Python 交互式文件。

• 点击 Run Cell 会创建一个 Python 交互式窗口

• 识别为 Python 交互式文件可以支持如下快捷键，常见的为

  • Ctrl+Enter Run Cell
  • Shift+Enter Run Cell 并聚焦到下一个单元格，如果不存在将创建一个

• 更多快捷键，参见下表

Python 交互式窗

除了通过上文的方式创建交互是窗口，还可以通过 >Jupyter: Create Interactive Window 命令创建一个交互式窗口。该窗口支持能力

• 自动完成

• Plot Viewer

变量和数据检查

• 变量浏览器

• 变量数据视图

其他 feature

• 连接到远端 Jupyter，通过 Jupyter: Specify local or remote Jupyter server for connections 命令选择，参见：官方文档
• Jupyter notebooks 和 Python 文件相互转换，参见：官方文档
• Debug Jupyter notebook
• Export a Jupyter notebook

全部命令

全部配置

VSCode Docs - Python settings reference

通用配置

代码分析设置

Language Server 提供者设置

Pylance 具体设置

Note: 对于 Pylance 内测版，可以使用 pylance.insidersChannel 配置项进行体验

诊断严重性规则

本节详细介绍了可以使用 "python.analysis.diagnosticSeverityOverrides" 设置自定义的所有可用规则，如以下示例所示。

一个例子：

{
  "python.analysis.diagnosticSeverityOverrides": {
    "reportUnboundVariable": "information",
    "reportImplicitStringConcatenation": "warning"
  }
}

自动完成配置

格式化设置

重构之导入排序

Linting 设置

通用

Pylint

pycodestyle (pep8)

Flake8

mypy

pydocstyle

prospector

pylama

测试设置

通用测试

unittest 配置

pytest 配置

预定义变量

Python 扩展设置支持预定义的变量。与常规 VS Code 设置类似，变量使用 ${变量名称} 语法。具体而言，该扩展支持以下变量：

• ${cwd} - 启动时任务运行者的当前工作目录
• ${workspaceFolder} - 在 VS 代码中打开的文件夹的路径
• ${workspaceRootFolderName} - 在 VSCode 中打开的文件夹的名称，不带任何斜杠 （/）
• ${workspaceFolderBasename} - 在 VSCode 中打开的文件夹的名称，不带任何斜杠 （/）
• ${file} - 当前打开的文件
• ${relativeFile} - 当前打开的文件相对于 "${workspaceFolder}" 的相对路径
• ${relativeFileDirname} - 当前打开的文件所在目录相对于 "${workspaceFolder}" 的相对路径
• ${fileBasename} - the current opened file’s basename
• ${fileBasenameNoExtension} - 当前打开的文件去掉文件扩展名后的名字
• ${fileDirname} - 当前打开的文件的目录名称
• ${fileExtname} - 当前打开的文件扩展名
• ${lineNumber} - 活动文件中当前选定的行号
• ${selectedText} - 活动文件中当前选定的文本
• ${execPath} - the path to the running VSCode executable

有关预定义变量和示例用法的其他信息，请参阅 VSCode 官方文档。

Pylance

具体参见： Pylance

Jedi

不支持 Python 2.7，更多参见：Github

场景和说明

VSCode Python 最佳配置

VSCode Python 多数情况下使用默认配置即可，如下两个配置可以酌情选择

{
    // Python 配置
    "python.analysis.typeCheckingMode": "basic",  // 指定要执行的类型检查分析的级别。未强制要求类型标注的项目使用 basic ；对项目代码质量有要求的使用 strict
    "python.analysis.completeFunctionParens": true,  // 为函数调用自动完成添加括号
}

开发 Django 项目

开发 Django 项目和普通 Python 主要区别在于调试配置，"django": true，对 HTML 模板调试的支持。

.vscode/launch.json

{
    "name": "Python: Django",
    "type": "python",
    "request": "launch",
    "program": "${workspaceFolder}/manage.py",
    "args": [
        "runserver",
    ],
    "django": true
},

此外，VSCode Python 还提供了 python.execSelectionInDjangoShell 命令，直接在 Django Shell 中执行选中内容

更多关于 Django 开发手册，参见：VSCode 官方文档

开发 Flask 项目

开发 Flask 项目和普通 Python 主要区别在于调试配置，"jinja": true，对 HTML 模板调试的支持，以及使用 flask module 启动项目。

.vscode/launch.json

{
    "name": "Python: Flask",
    "type": "python",
    "request": "launch",
    "module": "flask",
    "env": {
        "FLASK_APP": "app.py",
        "FLASK_ENV": "development",
        "FLASK_DEBUG": "0"
    },
    "args": [
        "run",
        "--no-debugger",
        "--no-reload"
    ],
    "jinja": true
},

更多关于 Flask 开发手册，参见：VSCode 官方文档

远程调试

远端，通过 python -m debugpy --listen 5678 ./myscript.py 命令启动调试器

VSCode 添加如下配置

{
  "name": "Python: Attach",
  "type": "python",
  "request": "attach",
  "connect": { // 根据情况替换
    "host": "localhost",
    "port": 5678
  }
}

详见：

• VSCode Docs - Python Debugging - Command Line Debugging
• VSCode Docs - Python Debugging - Debugging by attaching over a network connection

调试时依赖库断点不命中

调试配置添加： "justMyCode": false

Pyright、Pylance、Python三个VSCode扩展关系

在 VSCode 中，默认情况下为：

• Python 的 Language Server 的实现依赖 Pylance
• Pylance 自身有自己的特性，并依赖 Pyright 库（注意不是 Pyright 扩展）

为快速运行调试打开的文件以及测试添浏览器添加自定义配置

针对如下情况也可以添加自定义配置

• 1、通过如下方式快速运行调试打开的文件

• 2、通过 python.execInTerminal 以及 python.debugInTerminal 运行或调试当前文件
• 3、通过测试浏览器运行或调试测试

这几种情况，可以通过如下方式进行自定义配置

• 1 和 2 的运行情况，通过 python.terminal.executeInFileDir 以及 python.terminal.launchArgs 指定 cwd 以及 args；通过 terminal.integrated.env.linux 配置环境变量（如 "PYTHONPATH": "."）
• 1 和 2 的调试情况，通过 .vscode/launch.json 中添加调试配置，并通过 purpose 字段添加 debug-in-terminal 将该配置项应用到调试中
• 3 的情况，通过 .vscode/launch.json 中添加调试配置，并通过 purpose 字段添加 debug-test 将该配置项应用到调试中

Jedi 和 Pyright 能力对比

暂时未找到相关内容

如何开发 Python 2.7 项目

Jedi 完全不支持 Python 2.7。Pylance 和 Pyright 可以支持 Python 2.7 （但是只能识别 Python3 的语法和智能提示），参见：Python 2.7 的限制

如何让 IDE 更了解你的项目

在项目中强制使用标注（typing），同时启用强类型检查：

{
    "python.analysis.typeCheckingMode": "strict",
}

更多参见

• https://github.com/python/typing
• https://github.com/python/typeshed

如何解决 ImportError

参见：一文彻底理解 Python 环境。

完全开源的 VSCode Python 开发方案

目前 VSCode 使用了 Pylance 作为其默认 Language Server，但是 Pylance 是闭源的。因此，无法在非官方 VSCode 中使用 Pylance。

只开发 Python3 项目

安装扩展

• Python - MIT 许可证
• Jupyter - MIT 许可证

VSCode 配置添加配置，兼用默认（如果安装了 Pylance，需禁用之）

"python.languageServer": "Jedi"

同时支持 Python2 和 Python3 项目（推荐）

该方案使用 Pyright 替换 Pylance，可以获得 Pylance 类似的体验

安装扩展

• Python - MIT 许可证
• Jupyter - MIT 许可证
• Pyright - MIT 许可证

VSCode 配置添加配置，兼用默认（如果安装了 Pylance，需禁用之）

"python.languageServer": "None"

Reference

• VSCode Docs - Language Python
• VSCode Docs - Python Tutorial
• VSCode Docs - Python Editing Code
• VSCode Docs - Python Linting
• VSCode Docs - Python Debugging
• VSCode Docs - Python Environments
• VSCode Docs - Python Testing
• VSCode Docs - Python Interactive
• VSCode Docs - Python Django Tutorial
• VSCode Docs - Python Flask Tutorial
• VSCode Docs - Python Settings reference