使用vscode开发Python程序：代码静态检查工具pylint及代码格式化工具yapf的配置使用

Pylint

由于 Python 插件在 2018.1.0 (Jan. 2018) 版本更新中引入了一项默认设置：

  // 静态检查时是否使用pylint的最小规则集（minimal set of rules）
  "python.linting.pylintUseMinimalCheckers": true
这一默认设置等价于以下pylint选项：

--disable=all  --enable=F,E,unreachable,duplicate-key,unnecessary-semicolon,global-variable-not-assigned,unused-variable,binary-op-exception,bad-format-string,anomalous-backslash-in-string,bad-open-mode

不难看出，这样的默认设置直接禁用了所有的规范（Convertion，C ）和重构（Refactor，R ）类规则，只保留了致命错误（Fatal，F ）、错误（Error，E ）和少数几个警告（Warning，W ）类规则，因此pylint检查显示出的问题数量大幅减少。

自定义pylint规则选项：

如果希望直接应用所有pylint检查规则，则可以简单将 "python.linting.pylintUseMinimalCheckers" 的值修改为 false。

如果只希望应用部分pylint检查规则或者需要使用pylint某些选项，则可在 settings.json 中找到以下默认设置：

// pylint选项，每个选项都是数组中的一个字符串元素
"python.linting.pylintArgs": []
在数组 [] 中加入所需的pylint选项即可，例如

// pylint选项，以逗号分隔的字符串元素
"python.linting.pylintArgs": [
    "--disable=W0402,R0201,C0304", 
    "--extension-pkg-whitelist=numpy"
]
此时 "python.linting.pylintUseMinimalCheckers" 的值将自动被覆盖为 false，不用再手动修改。其他lint工具参数

https://code.visualstudio.com/docs/python/linting#_specific-linters

 

代码格式化工具：yapf

在 settings.json 页面上方搜索栏内输入 python.formatting 即可快速定位与Python代码格式化工具相关的设置内容。激活 Python 插件后，默认设置已包含以下内容：

  // Python代码格式化工具，可选'autopep8'、'black'或'yapf'.
  "python.formatting.provider": "autopep8",
Python 插件默认的代码格式化工具是autopep8，也可以使用black或yapf。推荐使用Google开发的yapf：

首先，安装yapf：pip install yapf

其次，将上面 "python.formatting.provider" 的值改为 "yapf"

最后，如需自定义yapf选项，则可找到 ""python.formatting.yapfArgs": []" 并在数组 [] 中加入所需选项，例如

// yapf选项，以逗号分隔的字符串元素
"python.formatting.yapfArgs": [
   "--style", "{based_on_style: chromium, indent_width: 4}"
]
以上安装配置完成后，在Python代码编辑界面按 F1 或 Ctrl + Shift + P 打开命令面板，输入 Format Document 即可调用yapf进行格式化，也可以在代码编辑页面使用默认快捷键直接调用yapf：Ctrl + Shift + I（Linux系统）、Shift + Alt + F （Windows系统）或 ⇧(Shift) + ⌥(Option) + F（Mac系统）。

除以上手动调用yapf以外，yapf也可以像pylint那样在文件保存甚至是代码段粘贴时自动调用，与之相关的设置是

  // 控制编辑器是否应自动设置粘贴内容的格式。格式化程序必须可用并且能设置文档中某一范围的格式。
  "editor.formatOnPaste": false,

  // 保存时设置文件的格式。格式化程序必须可用，不能自动保存文件，并且不能关闭编辑器。
  "editor.formatOnSave": false,

  // 在保存时格式化操作的超时时间。为 formatOnSave 命令指定时间限制 (单位: 毫秒)。运行超过设定时间的命令将被取消。
  "editor.formatOnSaveTimeout": 750,
可以看出这些设置属于 editor ，不是 Python 专属设置，因此这些设置会影响所有配置有格式化工具的语言文件。"editor.formatOnPaste" 和 "editor.formatOnSave" 默认均为 false ，主要是为了避免频繁自动调用格式化工具对编辑工作产生干扰，如确实需要可以将其改为 true。
--------------------- 
作者：sunxb10 
来源：CSDN 
原文：https://blog.csdn.net/sunxb10/article/details/80984243 
版权声明：本文为博主原创文章，转载请附上博文链接！