526互联

VS code中python代码格式化配置

发布时间 2023-11-29 15:21:05作者: burningJ

VS code中python代码格式化配置

settings.json

VS code打开命令面板(快捷键ctrl shift P)搜settings.json
img
发现里面有好几个设置：用户设置、工作区设置、文件夹设置、默认设置。
其中默认设置一般不动，另外三个设置则是作用域一层层缩小：用户下所有文件=>工作区文件=>文件夹文件，可以根据自己的需要在不同层级下设置不同的配置文件。

python代码格式化插件

代码格式化常用插件有三种：black formatter、yapf、autopep8
一般插件下载页面都会有“usage”，告诉你基本的配置，将其粘贴到settings.json文件里即可。
以我在用的black formatter插件为例

black

img
具体一些其他的参数可以往下拉动插件详情页来查看。
网上搜到的一些配置设置不一定使用于最新版的插件，最好是在安装插件后参考插件详情页来进行基础的配置，复杂的参数配置信息可以参考网上的。我这里的配置如下：

    // black formatter配置
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.codeActionsOnSave": {
            "source.organizeImports": true
        },
        "editor.formatOnSave": true,
    },

三者区别

此处参考了博文：在VSCode中编写python代码，代码规范工具介绍与推荐
yapf参考网上搜到的配置粘贴到setting.json文件，发现配置信息不起作用，后面根据插件详情页进行基础的配置之后，发现保存文件并没有自动格式化代码，遂放弃使用。
black formatter虽然功能上不如pycharm的代码格式化，但是也够日常使用了。基于博文所说配置比较简单，故选取该插件。
autopep8发现和black没什么区别。