面向 Python 开发人员的高级 Visual Studio 代码

使用键盘快捷键编辑器

在 macOS 上，通过转至文件 → 首选项 → 键盘快捷键或代码 → 首选项 → 键盘快捷键，打开键盘快捷键编辑器：

如果您需要更具体的内容，还有更多条件运算符可供选择。以下是一些帮助您入门的示例：

• 使用resourceFilename == '__init__.py'时，该文件你是编辑__init__.py
• 使用editorLangId == 'python'与Python工作时。如果需要，您还可以替换'python'为其他语言标识符。
• 使用editorHasSelection的，当你在编辑器中。

一旦你配置了这个扩展，在编辑器中打开一个 Python 文件，通过按你新分配的键盘快捷键Ctrl+ Alt+T打开一个 Python 终端来尝试它。

从命令面板为命令设置键盘快捷键

在本教程中，您将多次参考命令面板。VS Code 中的大部分功能都可以通过 UI 从上下文菜单访问，但您不会在那里找到所有内容。可以在核心编辑器中或通过扩展完成的任何事情都可以在命令面板中使用。您可以通过按以下键盘快捷键之一进入命令面板：

• macOS: F1或Cmd+ Shift+P
• Windows 或 Linux： F1或Ctrl+ Shift+P

要运行命令，请键入其描述性名称，例如Python: Run All Tests. 命令面板启动并且您想要的命令位于菜单顶部后，单击右侧的齿轮以分配键盘快捷键：

一旦您开始定期使用命令面板，您可能会发现有五到十个命令是您经常运行的。为这些命令分配一些快捷方式，以节省一些额外的击键次数。

从其他编辑器安装键盘映射

如果您已经在其他编辑器或 IDE 中工作了一段时间，您可能会将常用的​​键盘快捷键用于肌肉记忆。

您会在Vim、IntelliJ 和 PyCharm、Sublime Text、Notepad++、Emacs和Atom 的扩展中找到有用的键盘映射。

如果您以前的编辑器不在此列表中，您可能会发现其他人为您创建了映射扩展。Keymaps是VS Code 扩展市场上的一个有用的类别。

安装键盘映射扩展后，您还可以找到其他选项来自定义默认设置之外的它。例如，您可以使用 Vim 键盘映射扩展来配置 Vim 功能，例如是否以插入模式启动。

使用分屏

Python 的风格指南PEP 8倾向于较短的行长度。对于宽屏幕，这会留下很多未使用的屏幕空间。

当您发现自己需要在两个或多个文件之间切换时，请使用拆分面板功能一次显示多个编辑器区域。您可以使用命令通过命令面板访问此功能View: Split Editor。

或者，您可以使用相关的键盘快捷键：

• macOS： Cmd+\
• Windows 或 Linux： Ctrl+\

您还可以通过转到“查看”→“编辑器布局”或右键单击文件选项卡来打开拆分编辑器功能：

当使用左侧的测试代码和右侧的模块编写单元测试时，此设置非常有用。

某些文件类型（例如 Markdown）具有您可以使用的预览区域。使用Markdown: Open Preview to the Side命令打开预览编辑器。

使用 Zen 模式专注工作

如果您需要在 VS Code 中将注意力完全集中在单个文件或任务上，请通过转到“视图”→“外观”→“Zen 模式”来使用 Zen 模式，以显示仅包含编辑器的全屏窗口：

此功能对于屏蔽嘈杂的干扰和通知特别有用，这样您就可以专注于完成当前的任务。

主题化

VS Code 在VS Code Marketplace 中有一个巨大的主题库。一些最流行的主题是Material Theme、Winter is Coming、Dracula、Noctis和Monokai Pro。

让我们专注于Material 主题，因为它提供了广泛的配色方案以满足多种口味。您可以从扩展视图安装扩展。安装后，您可以通过Preferences: Color Theme在命令面板中运行来选择颜色主题。

Material Theme 最好使用自定义图标主题。图标主题是独立于颜色主题的扩展，因此您必须安装第二个扩展。pkief.material-icon-theme在扩展视图中搜索以找到最流行的主题材质图标包。安装后，VS Code 会提示你切换图标包。

这是带有 Palenight 颜色主题和 Material 图标包的 Material 主题：

您可以随时从命令面板更改图标主题，方法是使用命令Preferences: File Icon Theme然后从列表中选择图标主题之一。

安装更好的编程字体

编程字体是一组特殊的字体，通常带有称为monospace 的固定宽度字符。ProgrammingFonts.org上有一长串可用字体可供浏览：

更改默认 Shell 提供程序

您可以将终端窗口重新配置为具有多个配置文件。当您生成新终端时，这些配置文件形成下拉列表。

VS Code 允许您配置多个终端配置文件。您无法在设置 UI 中编辑终端配置文件，因此您需要使用Preferences: Open Settings (JSON)命令面板中的命令打开settings.json文件。您会注意到键值对构成了设置文件。每个键代表 VS Code 或其扩展之一的配置设置。

共有三种终端配置文件设置，它们的名称如下：

输入名称后，编辑器会自动将默认配置文件填充到 JSON 文件中。

请注意，默认设置中没有 Python REPL 配置文件。您可以将带有密钥"python3-repl"的配置文件添加到集成配置文件 JSON 文件中，以便 VS Code 将其作为配置文件选项提供，并将您直接带到 REPL 提示：

VS Code 有两种终端启动模式：集成和外部。配置配置文件后，您可以通过设置以下值来为集成终端设置默认配置文件"terminal.integrated.defaultProfile.osx"：

"terminal.integrated.defaultProfile.osx": "zsh",

如果某些内容在外部终端中启动，它将使用您操作系统的默认 shell。如果您更喜欢不同的终端应用程序，例如适用于 macOS 的iTerm 2或适用于 Windows 的Windows Terminal，您也可以更改默认的外部终端：

"terminal.external.osxExec": "iTerm.app",

例如，对于 macOS 的此设置，您是说 VS Code 每次启动外部终端窗口时都应该启动 iTerm 应用程序。

您可以在 VS Code 中更改更多有关终端的设置。例如，您可以让 VS Code 在您打开新的终端窗口时自动激活您的虚拟环境，并且您可以通过添加自定义提示来自定义终端的外观。您将在本教程中探索如何做到这两点。

终端中的虚拟环境激活

虚拟环境对于跨 Python 项目管理多个依赖项非常重要。一旦选择了解释器，Visual Studio Code 将激活任何Python 虚拟环境。如果您已有虚拟环境，请Python: Select Interpreter从命令面板运行以选择 Python 解释器虚拟环境。

如果您没有，请在终端内创建一个。如果虚拟环境路径命名为、 或.venv/，VS Code 可以自动选取它。env/venv/

设置解释器后，当您在 VS Code 中启动一个新的终端窗口时，您将自动激活虚拟环境：

如果您已经打开了一个终端，您可以通过单击垃圾桶图标来销毁它。

您在终端内运行的任何命令，例如python -m pip install，都将用于激活的虚拟环境。

在上面的屏幕截图中，您可以看到使用 Oh My Posh 提示工具包的自定义命令提示符。在下一部分中，您将安装和配置 Oh My Posh。Oh My Posh 是可选的，特别是如果您已经安装了自定义命令提示符。

安装 Oh My Posh

Oh My Posh是用于自定义终端命令提示符的众多库之一。它适用于 Linux、macOS 和 Windows。它还适用于所有 shell，如 Bash、Zsh、Fish 和 PowerShell。您可以安装 Oh My Posh 来为您的终端增添趣味。

如果您使用的是 macOS 并使用 Bash，请运行以下命令来安装 Oh My Posh：

$ brew tap jandedobbeleer/oh-my-posh
$ brew install oh-my-posh
$ curl https://github.com/JanDeDobbeleer/oh-my-posh/raw/main/themes/tonybaloney.omp.json -sLo ~/.mytheme.omp.json
$ echo "eval \"\$(oh-my-posh --init --shell bash --config ~/.mytheme.omp.json)\"" >> ~/.profile
$ . ~/.profile

如果您使用的是 macOS 并使用 Zsh，请运行以下命令来安装 Oh My Posh：

$ brew tap jandedobbeleer/oh-my-posh
$ brew install oh-my-posh
$ curl https://github.com/JanDeDobbeleer/oh-my-posh/raw/main/themes/tonybaloney.omp.json -sLo ~/.mytheme.omp.json
$ echo "eval \"\$(oh-my-posh --init --shell bash --config ~/.mytheme.omp.json)\"" >> ~/.zprofile
$ . ~/.zprofile

如果您使用的是 Windows 并使用 PowerShell，请运行以下命令来安装 Oh My Posh：

PS C:\> Install-Module oh-my-posh -Scope CurrentUser
PS C:\> Add-Content $PROFILE "`nSet-PoshPrompt -Theme tonybaloney"

最后，如果您使用的是 Linux 并使用 Bash，请运行以下命令来安装 Oh My Posh：

$ sudo wget https://github.com/JanDeDobbeleer/oh-my-posh/releases/latest/download/posh-linux-amd64 -O /usr/local/bin/oh-my-posh
$ sudo chmod +x /usr/local/bin/oh-my-posh
$ curl https://github.com/JanDeDobbeleer/oh-my-posh/raw/main/themes/tonybaloney.omp.json -sLo ~/.mytheme.omp.json
$ echo "eval \"\$(oh-my-posh --init --shell bash --config ~/.mytheme.omp.json)\"" >> ~/.bashrc
$ . ~/.bashrc

当你在 VS Code 中打开一个新终端时，你会得到这样的提示：

Python 的全局用户设置

默认情况下，Visual Studio Code 的 Python 扩展有一个非常基本的配置。许多功能（如 linting、格式化和安全检查）被禁用，因为您需要安装 Black、Pylint 和 Bandit 等第三方工具才能使用它们。

您可以使用pipx或安装这些工具并使它们可用于每个虚拟环境pip install --user。pipx更可取，pip install --user因为它将为该包创建和维护一个虚拟环境，使您的全局站点包更小并降低打包冲突的风险。

一旦你已经安装了pipx，你可以安装常用工具：

$ pipx install pylint && \
  pipx install black && \
  pipx install poetry && \
  pipx install pipenv && \
  pipx install bandit && \
  pipx install mypy && \
  pipx install flake8

或者，使用python3 -m pip install --user安装常用工具：

$ python3 -m pip install --user pylint black poetry pipenv bandit mypy flake8

安装基本工具后，从命令面板中打开用户设置Preferences: Open Settings (JSON)。为要应用于所有项目的首选项添加设置：

 1"python.pipenvPath": "${env:HOME}/.local/bin/pipenv",
 2"python.poetryPath": "${env:HOME}/.local/bin/poetry",
 3"python.condaPath": "${env:HOME}/.local/bin/conda",
 4"python.linting.enabled": true,
 5"python.linting.banditPath": "${env:HOME}/.local/bin/bandit",
 6"python.linting.banditEnabled": true,
 7"python.linting.pylintPath": "${env:HOME}/.local/bin/pylint",
 8"python.linting.mypyPath": "${env:HOME}/.local/bin/mypy",
 9"python.linting.flake8Path": "${env:HOME}/.local/bin/flake8",
10"python.formatting.blackPath": "${env:HOME}/.local/bin/black",

使用这些设置，您已经成功完成了一些对跨多个项目的开发工作流有用的事情：

1. 行1至3启用项目包发现启用pipenv，poetry和conda。
2. 第 4 行启用 Python linting。
3. 第 5 到 6 行启用并将路径设置为bandit.
4. 线7至10启用的Python格式化和路径设定为一个全局安装的实例pylint，mypy，flake8，和black。

在每个绝对路径中，您可以使用宏自动替换您的主文件夹${env:HOME}。

工作区设置

在用户设置之外，您可以使用.vscode/工作区内的目录来配置一些特定于项目的设置：

• 运行哪些命令来执行项目
• 如何测试和调试项目
• 其中棉短绒和格式来使用和任何项目特定参数

以下文件包含 VS Code 首选项：

VS Code 的大部分设置，以及扩展的设置，都在这三个文件中。

在工作区首选项中，支持以下预定义变量：

使用这些变量将使项目设置与环境无关，因此您可以将它们提交到 Git。

作为使用这些设置的示例，如果您想使用 Black 作为此项目的默认代码格式化程序，您可以.vscode/settings.json使用以下配置创建文件：

{
    "python.formatting.provider": "black",
}

任何签出此项目的人现在都将自动使用 Black 作为 Python 文件的格式化程序。您将在有关设置 format 和 lint on save的部分中看到此设置如何影响自动格式化选项。

使用设置同步扩展

如果您在多台计算机上使用 VS Code，则可以启用设置、键盘快捷键、用户代码段、扩展和 UI 状态的自动同步。如果您之前未使用过设置同步，则需要启用它：

1. Settings Sync: Turn On在您的命令面板中运行。
2. 按照 VS Code 提示的设置步骤进行操作。您可以使用 GitHub 进行身份验证。
3. 设置完成后，Settings Sync: Configure从命令面板运行。
4. 选择要同步的内容。

在安装了 VS Code 的所有计算机上配置了 Settings Sync 后，您可以通过Settings Sync: Show Synced Data从 Command Palette运行来查看每个同步设置的状态，它们将显示在Synced Machines 下：