在 VS Code 中开始使用 Python
在本教程中,您将学习如何在 Visual Studio Code 中使用 Python 3 创建、运行和调试 Python “掷骰子!”应用程序,使用虚拟环境、包等等!通过使用Python 扩展,您可以将 VS Code 变成一个出色的轻量级 Python 编辑器。
如果您是编程新手,请查看 Visual Studio Code for Education - Python 简介课程。本课程提供了 Python 的全面介绍,在基于浏览器的即用型开发环境中提供了结构化的模块。
要更深入地理解 Python 语言,您可以在 VS Code 的上下文环境中探索 python.org 上列出的任何编程教程。
有关 Python 的数据科学教程,请查看我们的数据科学部分。
先决条件
要成功完成本教程,您需要首先设置您的 Python 开发环境。具体来说,本教程需要:
- Python 3
- VS Code
- VS Code Python 扩展(有关安装扩展的更多详细信息,请参见扩展市场)
安装 Python 解释器
除了 Python 扩展之外,您还需要安装一个 Python 解释器。您使用哪个解释器取决于您的具体需求,但下面提供了一些指导。
Windows
从 python.org 安装 Python。使用页面上首先出现的 下载 Python 按钮下载最新版本。
注意:如果您没有管理员权限,在 Windows 上安装 Python 的另一个选项是使用 Microsoft Store。Microsoft Store 提供了受支持的 Python 版本的安装。
有关在 Windows 上使用 Python 的更多信息,请参见 Python.org 上关于在 Windows 上使用 Python 的说明。
macOS
不支持 macOS 上的系统安装 Python。建议使用包管理系统,例如 Homebrew。要在 macOS 上使用 Homebrew 安装 Python,请在终端提示符下使用 brew install python3。
注意:在 macOS 上,请确保您的 VS Code 安装位置包含在您的 PATH 环境变量中。有关更多信息,请参阅这些设置说明。
Linux
Linux 上内置的 Python 3 安装运行良好,但要安装其他 Python 包,您必须使用 get-pip.py 安装 pip。
其他选项
-
数据科学:如果您使用 Python 的主要目的是数据科学,那么您可以考虑从 Anaconda 下载。Anaconda 不仅提供 Python 解释器,还提供许多有用的数据科学库和工具。
-
适用于 Linux 的 Windows 子系统:如果您在 Windows 上工作并希望使用 Linux 环境进行 Python 开发,适用于 Linux 的 Windows 子系统 (WSL) 是您的一个选择。如果您选择此选项,您还需要安装 WSL 扩展。有关在 VS Code 中使用 WSL 的更多信息,请参见 VS Code 远程开发或尝试在 WSL 中工作教程,该教程将指导您设置 WSL、安装 Python,并创建一个在 WSL 中运行的 Hello World 应用程序。
注意:要验证您是否已成功在机器上安装 Python,请运行以下命令之一(取决于您的操作系统):
Linux/macOS:打开终端窗口并输入以下命令:
python3 --versionWindows:打开命令提示符并运行以下命令:
py -3 --version如果安装成功,输出窗口应显示您安装的 Python 版本。或者,您可以在 VS Code 集成终端中使用
py -0命令查看机器上安装的 Python 版本。默认解释器由星号 (*) 标识。
在工作区文件夹中启动 VS Code
通过在文件夹中启动 VS Code,该文件夹将成为您的“工作区”。
使用命令提示符或终端,创建一个名为 "hello" 的空文件夹,导航到该文件夹,并通过输入以下命令在该文件夹 (.) 中打开 VS Code (code):
mkdir hello
cd hello
code .
注意:如果您使用的是 Anaconda 分发版,请务必使用 Anaconda 命令提示符。
或者,您可以通过操作系统 UI 创建一个文件夹,然后使用 VS Code 的 文件 > 打开文件夹 来打开项目文件夹。
创建虚拟环境
Python 开发者之间的一种最佳实践是使用项目特定的虚拟环境。一旦您激活该环境,您随后安装的任何包都将与其他环境(包括全局解释器环境)隔离,从而减少因包版本冲突而引起的许多复杂问题。您可以使用 Venv 或 Anaconda 在 VS Code 中通过 Python: Create Environment 创建非全局环境。
打开命令面板(⇧⌘P(Windows、Linux Ctrl+Shift+P)),开始键入 Python: Create Environment 命令进行搜索,然后选择该命令。
该命令会显示一个环境类型列表,Venv 或 Conda。在本例中,选择 Venv。

然后,该命令会显示一个可用于您项目的解释器列表。选择您在本教程开头安装的解释器。

选择解释器后,通知将显示环境创建的进度,并且环境文件夹(/.venv)将出现在您的工作区中。

通过使用命令面板中的 Python: Select Interpreter 命令确保选择了您的新环境。

注意:有关虚拟环境的更多信息,或者如果您在环境创建过程中遇到错误,请参阅环境。
创建 Python 源代码文件
在文件资源管理器工具栏中,选择 hello 文件夹上的 新建文件 按钮。

将文件命名为 hello.py,VS Code 将自动在编辑器中打开它。

通过使用 .py 文件扩展名,您告诉 VS Code 将此文件解释为 Python 程序,以便它使用 Python 扩展和选定的解释器评估其内容。
注意:文件资源管理器工具栏还允许您在工作区中创建文件夹,以更好地组织您的代码。您可以使用 新建文件夹 按钮快速创建一个文件夹。
现在您的工作区中有一个代码文件,在 hello.py 中输入以下源代码:
msg = "Roll a dice!"
print(msg)
当您开始键入 print 时,请注意 IntelliSense 如何显示自动完成选项。

IntelliSense 和自动完成适用于标准 Python 模块以及您已安装到所选 Python 解释器环境中的其他包。它还提供对象类型上可用方法的完成。例如,由于 msg 变量包含一个字符串,当您键入 msg. 时,IntelliSense 会提供字符串方法。

最后,保存文件(⌘S(Windows、Linux Ctrl+S))。此时,您已准备好在 VS Code 中运行您的第一个 Python 文件。
有关编辑、格式化和重构的完整详细信息,请参阅编辑代码。Python 扩展还完全支持代码检查。
运行 Python 代码
单击编辑器右上角的 运行 Python 文件 播放按钮。

该按钮将打开一个终端面板,其中您的 Python 解释器会自动激活,然后运行 python3 hello.py(macOS/Linux)或 python hello.py(Windows)。

您可以通过其他三种方式在 VS Code 中运行 Python 代码:
-
右键单击编辑器窗口中的任意位置,然后选择 运行 Python > 在终端中运行 Python 文件(这会自动保存文件)。

-
选择一行或多行,然后按 Shift+Enter 或右键单击并选择 运行 Python > 在 Python 终端中运行选择/行。或者,您可以在未选择任何内容的情况下使用 Shift+Enter 激活智能发送,Python 扩展会将光标所在位置附近最小的可运行代码块发送到终端。此命令对于仅测试文件的一部分非常方便。
注意:如果您希望将代码发送到光标所在的特定行,您可以通过在用户设置中将
python.REPL.enableREPLSmartSend : "false"设置为关闭智能发送。 -
从命令面板(⇧⌘P(Windows、Linux Ctrl+Shift+P))中,选择 Python: Start Terminal REPL 命令以打开当前选定 Python 解释器的 REPL 终端(由
>>>表示)。在 REPL 中,您可以一次输入和运行一行代码。
恭喜,您刚刚在 Visual Studio Code 中运行了您的第一个 Python 代码!
配置和运行调试器
现在让我们尝试调试我们的 Python 程序。调试支持由Python 调试器扩展提供,该扩展随 Python 扩展自动安装。要确保它已正确安装,请打开扩展视图(⇧⌘X(Windows、Linux Ctrl+Shift+X))并搜索 @installed python debugger。您应该在结果中看到 Python 调试器扩展。

接下来,通过将光标放在 print 调用上并按 F9,在 hello.py 的第 2 行设置一个断点。或者,单击编辑器左侧的空白处,紧邻行号。当您设置断点时,空白处会出现一个红圈。

接下来,要初始化调试器,请按 F5。由于这是您第一次调试此文件,命令面板将打开一个配置菜单,允许您为打开的文件选择调试配置类型。

注意:VS Code 使用 JSON 文件进行所有各种配置;
launch.json是包含调试配置的文件的标准名称。
选择 Python 文件,此配置使用当前选定的 Python 解释器运行编辑器中显示的当前文件。
调试器将启动,然后在文件断点的第一行停止。当前行在左侧边距中用一个黄色箭头表示。如果您此时检查局部变量窗口,您可以看到 msg 变量出现在局部窗格中。

顶部出现一个调试工具栏,其中包含从左到右的以下命令:继续 (F5)、步过 (F10)、步入 (F11)、步出 (⇧F11(Windows、Linux Shift+F11))、重新启动 (⇧⌘F5(Windows、Linux Ctrl+Shift+F5)) 和停止 (⇧F5(Windows、Linux Shift+F5))。

状态栏也会变色(在许多主题中为橙色)以指示您处于调试模式。Python 调试控制台也会自动出现在右下方面板中,以显示正在运行的命令和程序输出。
要继续运行程序,请在调试工具栏上选择继续命令(F5)。调试器将运行程序直到结束。
提示:通过将鼠标悬停在代码(例如变量)上,也可以查看调试信息。在
msg的情况下,将鼠标悬停在变量上会在变量上方的框中显示字符串Roll a dice!。
您还可以在调试控制台中处理变量(如果您没有看到它,请在 VS Code 的右下角选择调试控制台,或从...菜单中选择它)。然后尝试在控制台底部的 > 提示符处逐行输入以下内容:
msg
msg.capitalize()
msg.split()

再次选择工具栏上的蓝色 继续 按钮(或按 F5),以运行程序直到完成。“掷骰子!”将出现在 Python 调试控制台中(如果您切换回它),并且程序完成后 VS Code 将退出调试模式。
如果您重新启动调试器,调试器将再次在第一个断点处停止。
要在程序完成之前停止运行,请使用调试工具栏上的红色停止按钮(⇧F5(Windows、Linux Shift+F5)),或使用 运行 > 停止调试 菜单命令。
有关完整详细信息,请参阅调试配置,其中包括有关如何使用特定 Python 解释器进行调试的说明。
提示:使用日志点代替打印语句:开发人员经常在源代码中散布
安装和使用包
让我们通过使用包来扩展前面的例子。
在 Python 中,包是您获取许多有用的代码库的方式,通常来自 PyPI,它们为您的程序提供额外功能。在本例中,您使用 numpy 包生成一个随机数。
返回到资源管理器视图(左侧最顶部的图标,显示文件),打开 hello.py,然后粘贴以下源代码:
import numpy as np
msg = "Roll a dice!"
print(msg)
print(np.random.randint(1,9))
提示:如果您手动输入上述代码,您可能会发现当您在行尾按 Enter 时,自动完成会更改
as关键字后的名称。为避免这种情况,请键入一个空格,然后按 Enter。
接下来,使用上一节中描述的“Python: Current file”配置在调试器中运行文件。
您应该会看到消息 "ModuleNotFoundError: No module named 'numpy'"。此消息表示所需的包在您的解释器中不可用。如果您使用的是 Anaconda 发行版或之前已安装 numpy 包,则可能不会看到此消息。
要安装 numpy 包,请停止调试器并使用命令面板运行 终端: 创建新终端 (⌃⇧`(Windows、Linux Ctrl+Shift+`))。此命令将为您的选定解释器打开一个命令提示符。
要在您的虚拟环境中安装所需的包,请根据您的操作系统输入以下命令:
-
安装包
# Don't use with Anaconda distributions because they include matplotlib already. # macOS python3 -m pip install numpy # Windows (may require elevation) py -m pip install numpy # Linux (Debian) apt-get install python3-tk python3 -m pip install numpy -
现在,重新运行程序,无论是否带调试器,以查看输出!
管理跨环境的依赖关系
在进行 Python 项目时,有效管理依赖关系至关重要。一个有用的技巧是使用 pip freeze > requirements.txt 命令。此命令可帮助您创建一个 requirements.txt 文件,其中列出了虚拟环境中安装的所有包。然后,此文件可用于在其他地方重新创建相同的环境。
请按照以下步骤创建 requirements.txt 文件:
-
如果您尚未激活虚拟环境,请激活它。
source venv/bin/activate # On macOS/Linux.\venv\Scripts\activate # On Windows -
生成
requirements.txt文件。pip freeze > requirements.txt
现在您可以使用新生成的 requirements.txt 文件在另一个环境中安装依赖项。此外,随着您的项目复杂性增加,您可以继续向其中添加依赖项。
pip install -r requirements.txt
通过遵循这些步骤,您可以确保项目依赖项在不同环境中保持一致,从而更轻松地与他人协作和部署项目。
恭喜您完成了 Python 教程!在本教程中,您学习了如何创建 Python 项目、创建虚拟环境、运行和调试 Python 代码以及安装 Python 包。探索其他资源,了解如何在 Visual Studio Code 中充分利用 Python!
后续步骤
要了解如何使用流行的 Python Web 框架构建 Web 应用程序,请参阅以下教程:
在 Visual Studio Code 中还有更多关于 Python 的内容可供探索:
- Python 配置文件模板 - 使用一组精选的扩展、设置和代码片段创建新的配置文件。
- 编辑代码 - 了解 Python 的自动完成、IntelliSense、格式设置和重构。
- Linting - 启用、配置和应用各种 Python linter。
- 调试 - 了解如何在本地和远程调试 Python。
- 测试 - 配置测试环境以及发现、运行和调试测试。
- 设置参考 - 探索 VS Code 中所有与 Python 相关的设置。
- 将 Python 部署到 Azure App Service
- 将 Python 部署到容器应用