在本教程中,我们将在 VSCode 中设置 Python linting 和自动代码格式化。我们将使用pylint突出显示 linting 错误,并使用black在保存时自动格式化我们的代码。

Linting 和自动格式化通常用于 Javascript 项目中,有助于在单个代码库中一起工作的开发人员团队中强制执行一致的代码标准。对于在团队中使用 Python 的任何人,pylint和black可以帮助加快开发速度,减少为新员工提升技能所花费的时间,并使您的差异更易于阅读以进行代码审查。

设置

首先,让我们开始为本教程创建一个名为python-linting的新虚拟环境。

conda create -y -n python-linting python=3.8
conda activate python-linting

进入全屏模式 退出全屏模式

接下来,我们将确保安装了 linter 和 formatter。

conda install -y pylint black

进入全屏模式 退出全屏模式

现在我们已经安装了我们的工具,我们可以继续在 VSCode 中设置它们。

用pylint起绒

要在 VSCode 中为 Python 启用 linting,我们需要确保在我们的设置中启用了一些东西。请务必对“用户”级别(而不是仅工作区或文件夹)进行这些更改,以便它在任何项目中生效。

首先,打开 VSCode 设置 UI 并搜索“Python linting”。确保选中以下设置:

Python > Linting:启用

[x]是否对 Python 文件进行 lint。

通过确保选中以下设置,还特别允许pylintlinting:

Python > Linting:Pylint 已启用

[x]是否使用 pylint 对 Python 文件进行 lint。

如果您只想突出更严重的问题,您可以选择抑制“约定”级别的 linting 消息。要禁用约定消息,请将--disable=C添加到pylint参数中:

Python > Linting:Pylint Args

--disable=C

仅当您知道不希望显示约定 linting 错误时才执行此部分。

使用black自动格式化

要设置自动格式化,我们需要告诉 VSCode 使用black作为 Python 代码的格式化程序。我们可以通过从以下下拉选择器中选择black在我们的设置中执行此操作:

Python > 格式化:提供者

black

接下来,我们需要告诉 VSCode 我们想在保存文件时自动格式化我们的代码。我们可以使用Format on Save选项来做到这一点:

编辑器:保存时格式化

[x]保存时格式化文件。必须有格式化程序,延迟后不得保存文件,不得关闭编辑器。

结果

如果一切顺利,您应该在每次保存文件时在编码和自动代码格式化时收到有用的 linting 消息。

最后的想法

在本教程中,我们设置pylint和black用于在 VSCode 中进行 Python linting 和自动格式化。 Linting 和自动格式化可以通过消除调试和考虑格式化所花费的时间来帮助加速开发。他们还可以通过执行一组合理的标准来帮助开发人员团队一起工作,这些标准努力使他们的代码库和拉取请求更易于阅读和审查。

源可用性

本文的所有源材料都可以在我的博客 GitHub repo 上找到这里。