现已发布!阅读关于 11 月新增功能和修复的内容。

VS Code 中的 Python 环境

在 Python 中,“环境”是指 Python 程序运行的上下文,它包含一个解释器和任意数量的已安装包。

注意:如果您想更熟悉 Python 编程语言,请参阅更多 Python 资源

Python 环境的类型

全局环境

默认情况下,任何已安装的 Python 解释器都运行在其自己的全局环境中。例如,如果您在新终端中仅运行 pythonpython3py(取决于您的 Python 安装方式),您就是在该解释器的全局环境中运行。您安装或卸载的任何包都会影响全局环境以及您在该环境中运行的所有程序。

提示:在 Python 中,最好为工作区创建特定环境,例如使用本地环境。

本地环境

您可以为工作区创建两种类型的环境:虚拟环境conda 环境。这些环境允许您在不影响其他环境的情况下安装包,从而隔离工作区的包安装。

虚拟环境

一个虚拟环境是创建环境的内置方法。虚拟环境创建一个包含特定解释器副本(或符号链接)的文件夹。当您将包安装到虚拟环境中时,它们会进入这个新文件夹,从而与其他工作区使用的包隔离开。

注意:虽然可以将虚拟环境文件夹作为工作区打开,但不建议这样做,并且可能会导致使用 Python 扩展时出现问题。

Conda 环境

conda 环境是使用 conda 包管理器管理的 Python 环境(请参阅conda 入门指南)。在 conda 和虚拟环境之间进行选择取决于您的包需求、团队标准等。

Python 环境工具

下表列出了与 Python 环境相关的各种工具

工具 定义和目的
pip Python 包管理器,用于安装和更新包。它默认随 Python 3.9+ 一起安装(除非您使用的是基于 Debian 的操作系统;在这种情况下,请安装 python3-pip)。
venv 允许您为不同的项目管理单独的包安装,并且默认随 Python 3 一起安装(除非您使用的是基于 Debian 的操作系统;在这种情况下,请安装 python3-venv)。
conda Miniconda安装。它可用于管理包和虚拟环境。通常用于数据科学项目。

创建环境

使用“创建环境”命令

要在 VS Code 中使用虚拟环境或 Anaconda 创建本地环境,您可以按照以下步骤操作:打开命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P)),搜索Python: Create Environment命令,然后选择它。

该命令会显示环境类型列表:VenvConda

Create Environment dropdown

如果您使用Venv创建环境,该命令会显示可作为新虚拟环境基础的解释器列表。

Virtual environment interpreter selection

如果您使用Conda创建环境,该命令会显示可用于项目的 Python 版本列表。

Conda environment Python version selection

选择所需的解释器或 Python 版本后,将显示一条通知,说明环境创建的进度,并且环境文件夹将出现在您的工作区中。

Create environment status notification

注意:该命令还将安装需求/依赖项文件中概述的必要包,例如位于项目文件夹中的 requirements.txtpyproject.tomlenvironment.yml。它还会向虚拟环境添加 .gitignore 文件,以帮助防止您意外地将虚拟环境提交到源代码管理。

在终端中创建虚拟环境

如果您选择手动创建虚拟环境,请使用以下命令(其中“.venv”是环境文件夹的名称)

# macOS/Linux
# You may need to run `sudo apt-get install python3-venv` first on Debian-based OSs
python3 -m venv .venv

# Windows
# You can also use `py -3 -m venv .venv`
python -m venv .venv

注意:要了解有关 venv 模块的更多信息,请阅读 Python.org 上的虚拟环境的创建

创建新的虚拟环境时,VS Code 中会显示一个提示,允许您为工作区选择它。

Python environment prompt

提示:确保更新您的源代码控制设置,以防止意外提交虚拟环境(例如,在 .gitignore 中)。由于虚拟环境不可移植,通常不应将其提交给他人使用。

在终端中创建 conda 环境

Python 扩展会自动检测现有的 conda 环境。我们建议您在 conda 环境中安装 Python 解释器,否则在选择环境后会为您安装一个。例如,以下命令创建了一个名为 env-01 的 conda 环境,其中包含 Python 3.9 解释器和几个库

conda create -n env-01 python=3.9 scipy=0.15.0 numpy

注意:有关 conda 命令行界面的更多信息,您可以阅读Conda 环境

附加说明

  • 如果您在 VS Code 运行时创建了新的 conda 环境,请使用Python: Select Interpreter窗口右上角的刷新图标;否则,您可能找不到该环境。

    Conda environment refresh icon

  • 为确保从 shell 的角度正确设置环境,请使用 Anaconda 提示并激活所需的环境。然后,您可以通过输入 code . 命令来启动 VS Code。打开 VS Code 后,您可以通过命令面板或单击状态栏来选择解释器。

  • 尽管 VS Code 的 Python 扩展目前没有与 conda environment.yml 文件直接集成,但 VS Code 本身就是一个出色的 YAML 编辑器。

  • 如果默认 shell 设置为 PowerShell,则无法在 VS Code 集成终端中自动激活 conda 环境。要更改 shell,请参阅集成终端 - 终端配置文件

  • 您可以手动指定用于激活的 conda 可执行文件的路径(版本 4.4+)。为此,请打开命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))并运行Preferences: Open User Settings。然后设置 python.condaPath(位于用户设置的 Python 扩展部分),并提供正确的路径。

使用 Python 解释器

选择和激活环境

Python 扩展会尝试查找并选择它认为最适合工作区的环境。如果您希望选择特定环境,请使用命令面板⇧⌘P (Windows, Linux Ctrl+Shift+P))中的Python: Select Interpreter命令。

Python: Select Interpreter command

注意:如果 Python 扩展找不到解释器,它会发出警告。在 macOS 12.2 及更早版本上,如果您使用的是操作系统安装的 Python 解释器,该扩展也会发出警告,因为它已知存在兼容性问题。在这两种情况下,您都可以通过在用户设置中将 python.disableInstallationCheck 设置为 true 来禁用这些警告。

Python: Select Interpreter 命令会显示可用的全局环境、conda 环境和虚拟环境列表。(有关详细信息,包括这些环境类型的区别,请参阅扩展程序查找环境的位置部分。)例如,下图显示了几个 Anaconda 和 CPython 安装,以及一个 conda 环境和一个位于工作区文件夹内的虚拟环境(env)。

List of interpreters

注意:在 Windows 上,VS Code 可能需要一些时间才能检测到可用的 conda 环境。在此过程中,您可能会在环境路径前面看到“(cached)”。该标签表示 VS Code 目前正在使用该环境的缓存信息。

如果您在 VS Code 中打开了文件夹或工作区,然后从列表中选择了一个解释器,Python 扩展会将其信息内部存储起来。这确保了在您重新打开工作区时会使用相同的解释器。

所选环境由 Python 扩展用于运行 Python 代码(使用Python: Run Python File in Terminal命令),在编辑器中打开 .py 文件时提供语言服务(自动完成、语法检查、代码检查、格式化等),以及使用Terminal: Create New Terminal命令打开终端。在后一种情况下,VS Code 会自动激活所选环境。

提示:要阻止自动激活所选环境,请将 "python.terminal.activateEnvironment": false 添加到您的 settings.json 文件中(它可以放在现有设置的同级位置)。

提示:如果激活命令生成消息“Activate.ps1 未数字签名。您无法在当前系统上运行此脚本。”,那么您需要暂时更改 PowerShell 执行策略以允许运行脚本(请参阅 PowerShell 文档中的关于执行策略):Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process

注意:默认情况下,VS Code 在调试代码时使用为工作区选择的解释器。您可以通过在 launch.json 的调试配置中指定不同的路径来覆盖此行为。请参阅选择调试环境

所选解释器的版本将显示在状态栏的右侧。

Status Bar showing a selected interpreter

状态栏还会反映未选择解释器的情况。

Status bar showing no selected Python interpreter

在这两种情况下,单击状态栏的此区域都是Python: Select Interpreter命令的便捷快捷方式。

提示:如果您在 VS Code 识别虚拟环境方面遇到任何问题,请提交问题,以便我们帮助确定原因。

手动指定解释器

如果 VS Code 未自动找到您想使用的解释器,您可以浏览文件系统查找解释器或手动提供其路径。

您可以通过运行Python: Select Interpreter命令并选择解释器列表顶部的Enter interpreter path...选项来执行此操作。

Enter interpreter path option on the interpreters list

然后,您可以直接在文本框中输入 Python 解释器的完整路径(例如,“.venv/Scripts/python.exe”),或者您可以选择Find...按钮并在文件系统中浏览以找到您要选择的 python 可执行文件。

Enter path or browse for an interpreter

如果您想手动指定一个默认解释器,该解释器将在您首次打开工作区时使用,您可以创建或修改 python.defaultInterpreterPath 设置的条目。

注意:在为工作区选择了解释器后,对 python.defaultInterpreterPath 设置的更改将不会被采纳;一旦为工作区选择了初始解释器,对该设置的任何更改都将被忽略。

此外,如果您想为所有 Python 应用程序设置默认解释器,可以在用户设置中手动添加 python.defaultInterpreterPath 的条目。为此,请打开命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))并输入Preferences: Open User Settings。然后设置 python.defaultInterpreterPath(位于用户设置的 Python 扩展部分),并提供正确的解释器。

扩展程序如何自动选择环境

如果尚未指定解释器,则 Python 扩展程序会按照以下优先级顺序自动选择版本最高的解释器

  1. 直接位于工作区文件夹下的虚拟环境。
  2. 与工作区相关但全局存储的虚拟环境。例如,位于工作区文件夹外部的PipenvPoetry环境。
  3. 全局安装的解释器。例如,位于 /usr/local/binC:\\python38 等位置的解释器。

注意:所选的解释器可能与您的终端中 python 引用的解释器不同。

如果 Visual Studio Code 未自动找到您的解释器,您可以手动指定解释器

扩展程序查找环境的位置

扩展程序会自动在以下位置查找解释器,顺序不固定

  • 标准安装路径,例如 /usr/local/bin/usr/sbin/sbinc:\\python36 等。
  • 直接位于工作区(项目)文件夹下的虚拟环境。
  • 位于 python.venvPath 设置标识的文件夹中的虚拟环境(请参阅通用 Python 设置),该文件夹可以包含多个虚拟环境。扩展程序会在 venvPath 的第一级子文件夹中查找虚拟环境。
  • 位于 ~/.virtualenvs 文件夹中的虚拟环境,用于virtualenvwrapper
  • pyenvPipenvPoetry 创建的解释器。
  • 位于 WORKON_HOME 标识的路径中的虚拟环境(由virtualenvwrapper使用)。
  • conda env list 找到的 Conda 环境。没有解释器的 Conda 环境将在选择时为其安装一个。
  • 位于工作区文件夹下 .direnv 文件夹中的解释器,用于direnv

环境和终端窗口

使用Python: Select Interpreter后,该解释器将在右键单击文件并选择Python: Run Python File in Terminal时应用。除非您将 python.terminal.activateEnvironment 设置更改为 false,否则在使用Terminal: Create New Terminal命令时,环境也会自动激活。

请注意,从已激活特定 Python 环境的 shell 启动 VS Code,并不会自动在该激活的环境中激活集成终端。

注意:如果 PowerShell 被设置为集成 shell,conda 环境将无法在集成终端中自动激活。有关如何更改 shell,请参阅集成终端 - 终端配置文件

使用Python: Select Interpreter命令更改解释器不会影响已打开的终端面板。因此,您可以在拆分终端中激活不同的环境:选择第一个解释器,为它创建一个终端,选择另一个解释器,然后使用终端标题栏中的拆分按钮(⌘\ (Windows, Linux Ctrl+Shift+5))。

选择调试环境

默认情况下,调试器将使用通过 Python 扩展选择的 Python 解释器。但是,如果 launch.json 的调试配置中指定了 python 属性,则该属性具有优先权。如果未定义此属性,则会回退到使用为工作区选择的 Python 解释器路径。

有关调试配置的更多详细信息,请参阅调试配置

环境变量

环境变量定义文件

环境变量定义文件是包含 environment_variable=value 形式的键值对的文本文件,其中 # 用于注释。不支持多行值,但允许引用先前定义的环境变量。环境变量定义文件可用于调试和工具执行(包括 linter、格式化程序、IntelliSense 和测试工具)等场景,但不会应用于终端。

注意:环境变量定义文件不一定跨平台。例如,虽然 Unix 在环境变量中使用 : 作为路径分隔符,但 Windows 使用 ;。对此类操作系统差异没有进行标准化,因此您需要确保任何环境变量定义文件使用的值与您的操作系统兼容。

默认情况下,Python 扩展程序会在当前工作区文件夹中查找并加载名为 .env 的文件,然后应用这些定义。该文件由用户设置中的默认条目 "python.envFile": "${workspaceFolder}/.env" 标识(请参阅通用 Python 设置)。您可以随时更改 python.envFile 设置以使用不同的定义文件。

注意:环境变量定义文件并非在所有可以使用环境变量的情况下都使用。除非 Visual Studio Code 文档另有说明,否则它们仅按定义影响某些场景。例如,扩展程序在解析设置值时不会使用环境变量定义文件。

调试配置还包含一个 envFile 属性,该属性也默认为当前工作区中的 .env 文件(请参阅调试 - 设置配置选项)。此属性允许您轻松设置用于调试的目的变量,这些变量将替换在默认 .env 文件中指定的变量。

例如,在开发 Web 应用程序时,您可能希望轻松地在开发和生产服务器之间切换。与其直接将不同的 URL 和其他设置硬编码到您的应用程序中,不如为每个服务器使用单独的定义文件。例如

dev.env 文件

# dev.env - development configuration

# API endpoint
MYPROJECT_APIENDPOINT=https://my.domain.com/api/dev/

# Variables for the database
MYPROJECT_DBURL=https://my.domain.com/db/dev
MYPROJECT_DBUSER=devadmin
MYPROJECT_DBPASSWORD=!dfka**213=

prod.env 文件

# prod.env - production configuration

# API endpoint
MYPROJECT_APIENDPOINT=https://my.domain.com/api/

# Variables for the database
MYPROJECT_DBURL=https://my.domain.com/db/
MYPROJECT_DBUSER=coreuser
MYPROJECT_DBPASSWORD=kKKfa98*11@

然后,您可以将 python.envFile 设置为 ${workspaceFolder}/prod.env,然后将调试配置中的 envFile 属性设置为 ${workspaceFolder}/dev.env

注意:当使用多种方法指定环境变量时,请注意存在优先级顺序。launch.json 文件中定义的所有 env 变量都将覆盖 .env 文件中(通过 python.envFile 设置指定,用户或工作区)包含的变量。类似地,launch.json 文件中定义的 env 变量将覆盖 launch.json 中指定的 envFile 中定义的环境变量。

使用 PYTHONPATH 变量

PYTHONPATH 环境变量指定了 Python 解释器应查找模块的附加位置。在 VS Code 中,PYTHONPATH 可以通过终端设置(terminal.integrated.env.*)和/或 .env 文件进行设置。

当使用终端设置时,PYTHONPATH 会影响用户在终端中运行的任何工具,以及扩展程序为用户执行的任何通过终端路由的操作(例如调试)。但是,在这种情况下,当扩展程序执行未通过终端路由的操作(例如使用 linter 或 formatter)时,此设置不会影响模块查找。

后续步骤

  • 编辑代码 - 了解 Python 的自动完成、IntelliSense、格式设置和重构。
  • 调试 - 了解如何在本地和远程调试 Python。
  • 测试 - 配置测试环境以及发现、运行和调试测试。
  • 设置参考 - 探索 VS Code 中所有与 Python 相关的设置。

更多 Python 资源

© . This site is unofficial and not affiliated with Microsoft.