无论您是经验丰富的开发人员还是刚刚开始编码冒险,正确设置 VS Code 都可能是将您的技能提升到新水平的秘诀。因此,让我们深入探索在 Visual Studio Code 的虚拟墙内打造崇高编码天堂的艺术!
为什么选择 VS 代码?
VS Code 已成为 Python 开发中最受欢迎的代码编辑器之一,这有几个充分的理由。以下是在 Python 开发中使用 VS Code 的一些令人信服的论据:
- 轻量级代码编辑器启动速度快,非常适合想要无缝编码体验且无需占用大量资源的开发人员。
- 可在多个平台上使用,包括 Windows、macOS 和 Linux。
- 拥有广泛的扩展生态系统。
- 内置调试器,可与 Python 无缝协作。
- 支持各种 Python 格式化程序和 linter。
- 与 Git 等版本控制系统完美集成。
- 内置终端。
- 直观的用户界面。
- 庞大而活跃的开发者社区。
在本文中,我们将探讨如何安装 VSCode,然后将其定制为 Python 开发的强大工具。
安装
在本节中,我们将讨论安装 VS Code。从此处的官方网站下载并运行安装程序。请在此处查看我们的完整指南,了解特定于系统的说明。
如何编辑设置
现在,让我们看看如何修改设置。这可能与您以前使用过的程序不同。
在 VS Code 中,有两个主要选项用于编辑设置:图形用户界面 (GUI) 和文件settings.json
。每个选项都具有独特的优势,可以满足不同的偏好和用例。
设置.json 文件:
该settings.json
文件是一个纯文本 JSON 文件,用于存储 Visual Studio Code 的所有配置设置。它是 GUI 设置修改的底层配置文件。您可以跳过 GUI 并直接编辑此文件。
要通过文件编辑设置settings.json
:
- 按
Ctrl + Shift + P
(Windows/Linux) 或Cmd + Shift + P
(Mac) 打开命令面板。 - 键入“用户设置”并从命令列表中选择 JSON 选项。
请记住命令面板,因为我们将在本指南中大量使用它。
图形用户界面(GUI):
GUI方法允许用户通过VS Code界面修改设置,而无需直接与底层JSON配置文件交互。
要访问 GUI 设置,请单击 VS Code 窗口左下角的齿轮图标。如果您是键盘快捷键爱好者,请使用快捷键Ctrl + ,
(Windows/Linux) 或Cmd + ,
(Mac)。
本指南使用该settings.json
方法,但可以通过搜索我们提供的密钥在 GUI 中找到每个项目。例如,要在 GUI 中查找标尺,您可以搜索“editor.rulers”。
主题
在本节中,我们将了解主题以及如何调整 VS Code 的视觉样式。为 VS Code 选择视觉主题可能看起来只是为了让你的编辑器看起来更漂亮。事实上,这是一个重要的决定,会对整体开发体验和生产力产生重大影响。以下是选择合适的视觉主题至关重要的几个原因:
- 减少眼睛疲劳:精心设计的视觉主题以及适当的颜色选择、对比度和语法突出显示可以减少长时间编码过程中的眼睛疲劳。
- 提高代码可读性:视觉主题在增强代码可读性方面发挥着关键作用。主题可以清晰地区分各种代码元素(例如关键字、函数、变量和注释),使代码更容易一目了然。
- 个性化和动机:视觉主题允许开发人员创建一个与他们的个性和偏好产生共鸣的环境。具有视觉吸引力和个性化的编码空间可以增强动力并激发创造力,使编码会议更具吸引力和乐趣。
- 可访问性和包容性:选择考虑颜色对比度和可读性的可访问主题对于确保包容性至关重要。满足不同需求(包括有视觉障碍或色盲的开发人员的需求)的主题可以营造包容性的编码环境。
在 VS Code 中浏览主题有时可能会令人沮丧,因为没有可以快速浏览的库。相反,您必须找到每个主题并在扩展市场中打开它。我们发现VS Code 主题提供了一种快速浏览可供选择的各种颜色主题的精美方式。
我们喜欢 One Dark Pro。然而,找到一个适合您需求的主题对您来说是多么重要,这一点怎么形容都不为过。
选择主题后,您可以选择它,然后选择 VS Code 按钮。这将在扩展市场中打开主题扩展。
从市场页面选择安装。安装后,主题将自动启用。
有些主题提供多种选项。在这里您可以看到 One Dark Pro 有 4 种不同的颜色主题可供选择。
您也可以在 中进行设置settings.json
。
添加该workbench.colorTheme
密钥,VS Code 将显示可供选择的主题列表。如果您想选择已安装的不同主题,可以从命令选项板中执行此操作。
打开命令调色板并输入“颜色主题”。选择首选项:颜色主题选项。当然,您也可以在settings.json
.
我们建议进行一些小调整,以使您的编辑器更易于理解。请随意使用您认为有用的任何内容。这些选项
window.zoomLevel
将 UI 比例设置得足够小,以容纳大量内容,但又足够大,以便清晰可见。您可以在 macOS 上使用Cmd +
和,或者在 Windows 和 Linux 上使用 和 进行放大和缩小。Cmd -
Ctl +
Ctl -
workbench.tree.indent
向文件资源管理器树添加更多水平插入。这使得查看嵌套内容变得更容易。
editor.minimap.renderCharacters
使小地图显示形状线而不是实际文本。说实话,没有人在阅读小地图文本。
editor.minimap.size
调整小地图的大小,使其可用但不会占用大量空间。
files.autoSave
会自动保存您最近修改过的文件。您可以将其设置为在更改选项卡、更改窗口或延迟后保存。如果您选择延迟选项,则必须设置files.autoSaveDelay
为秒数。
editor.cursorStyle
并editor.cursorBlinking
控制您使用的光标类型。我们更喜欢老式的块和块轮廓选项。
Ruler
标尺充当微妙的指南,防止代码过于庞大,从而鼓励简洁性和可读性。在 VS Code 环境中拥抱统治者的力量,使您能够编写干净、组织良好的代码,这些代码不仅符合行业标准,而且让您和您的开发人员同事一起工作成为一种乐趣。因此,让您的代码沿着标尺优雅地跳舞,并见证这个看似微小的添加如何对项目的整体优雅和专业性产生重大影响。
向 VS Code 添加标尺是一个简单的过程。打开settings.json
并添加以下行:
在这里,我们使用 88,因为这与我们将在本文后面讨论的黑色格式化程序一致。如果您的 linter 或格式化程序更喜欢不同的行长度,则使用该值。如果您想要多个标尺,也可以这样做:
结果是选定线长度的垂直线。
linter
linter 是一个重要的工具,在提高代码的整体质量和可维护性方面发挥着至关重要的作用。它通过分析代码中的潜在错误、样式不一致和语法问题,帮助您遵守 Python 编码标准和最佳实践。通过在编写代码时实时突出显示这些问题,linter 可以帮助您在开发过程的早期识别和纠正错误,减少引入错误的机会并增强代码库的可读性。使用 linter 不仅可以在团队中促进更清晰、更标准化的编码实践,还有助于提高协作效率,使其成为任何在 VS Code 环境中使用 Python 的 Django 开发人员不可或缺的工具。
linter 的选项数量不断增加。以下是一些最受欢迎的:
Flake 8
- pylint
- ruff
我们偏爱拉夫。它比其他 linter 快 100 倍,支持最新版本的 Python,并且具有与 Flake8 几乎相同的规则。当然,如果您偏爱另一个 linter,请使用它。大部分配置都是相似的。
设置 Ruff 再简单不过了。只需从此处的市场安装 Ruff 扩展即可。它立即开始工作。无论您选择哪种 linter,都将以下内容添加到settings.json
.
这两个选项将在您保存文件时启用 linting。通过我们的测试,我们发现了一些 Ruff 特有的配置选项,可以提高我们的工作效率。我们来看看这些。
进口自动分拣
PEP8风格指南详细介绍了如何组织导入。这有助于保持代码的可读性和可维护性。自动排序将首先按源(例如标准库、第三方、本地应用程序)构建您的 Python 导入,然后在这些部分中按字母顺序排列。
editor.codeActionsOnSave
通过将该部分添加到 中的 Python 作用域来启用它settings.json
。
这里可以看到之前导入排序的例子:
之后:
自动修复违规行为
只有修复代码中的违规行为,才能发现它们。您必须对每一项采取行动。Ruff 提供了一种自动修复违规行为的方法。source.fixAll
通过将密钥添加到editor.codeActionsOnSave
Python 作用域的部分来启用它。
在这里您可以看到自动修复违规的示例。Ruff 识别该类Post
已导入但未使用。
Ruff 通过删除Post
导入来解决这个问题。
格式化
代码格式化程序是一种根据预定义的编码风格和约定分析并自动重组源代码的工具。它的目的是在不改变代码功能的情况下实现代码布局、缩进、换行和其他格式方面的一致性。通过在整个项目中强制执行一致的代码样式,格式化程序可以增强代码的可读性,使其更易于理解,并最大限度地减少因格式不一致而导致的潜在错误。
就像 linter 一样,有许多格式化程序可供选择。以下是一些最受欢迎的:
- BLACK
- YAPF
- AutoPep8
我们更喜欢黑色的风格选择。Black 的方法遵循“不妥协的代码格式化程序”的原则,并且因其生成高度可读的一致代码的能力而获得广泛认可。
例如,黑方使用 88 个字符的行长度。这与使用 80 个字符的其他格式化程序形成对比。使用 10% 长的限制的决定会对文件长度产生巨大影响。它还允许减少换行,从而产生更具可读性的代码。像这样的小而有影响力的选择使黑色成为我们发展的一个简单选择。一如既往,选择符合您需求的格式化程序。
黑色扩展可以在这里找到。像安装任何其他扩展一样安装它。安装后,打开settings.json
这两个选项并将其添加到您的 python 范围中。
这些行将默认格式化程序设置为黑色并在保存时启用格式。这意味着 Black 仅在您保存文件时才会格式化您的代码。
git
VS Code 与 git 等版本控制系统的集成非常好。只需安装 git 就足以让编辑器发挥其魔力。如果您需要安装 git,请查看git 本身提供的指南。设置完成后,您的主侧栏将有一个源代码控制按钮。
主侧边栏的源代码控制按钮。
结论
您现在拥有一个完全配置的 VS Code,具有华丽的颜色主题、linting、格式,并安装了一些有用的扩展,使您的编码时间更加高效和愉快!通过利用 Visual Studio Code 的强大功能及其多功能配置,开发人员可以充分发挥潜力,并将 Python 开发提升到新的高度。随着开发环境的不断发展,VS Code 的适应性和丰富的功能无疑将使其保持在现代编码环境的最前沿,使开发人员能够轻松编写干净、高效且健壮的 Python 应用程序。