python代码格式化工具只懂autopep8?这里有更好的

发布 2020-11-25 阅读 9分钟
### 前言 大家都懂自动格式化代码的好处。 - 不需要再对着pep8标准扣字眼来修改自己代码 - 减少了组内不必要的讨论,专注于项目功能 - 代码风格更统一,github上传代码冲突更少 - 帮助多人开发协调代码规范 因此大多数公司招聘python开发人员时将了解pep8规范和懂得使用自动格式化工具列入必备技能。 ### autopep8 vs yapf vs black 以下列举了python中的三个自动格式化工具: star 数截止 2020/11/25 **autopep8** - [github](https://github.com/hhatto/autopep8) star 3.6k autopep8 是一个国人中知名度最高和使用最广泛的自动格式化工具。 一个较为宽松的格式化工具,只会以最低限度的标准对不符合 pep8 标准的代码进行修正。可能无法满足那些有特定需求,或想让代码看起来更干净更漂亮的人。 **yapf** - [github](https://github.com/google/yapf) star 11.2k 由 google 开发并维护的格式化工具,特点是支持多种格式化风格与功能繁多的自定义配置。默认支持三种格式化样式:pep8, google, Facebook 和 chromium。 yapf的初衷不是让代码符合pep准则, 而且让代码看起来更整洁更友好。 **black** - [github](https://github.com/psf/black) star 18.6k 可以说是最流行最多人使用的python格式化工具了,统一的格式化标准。傻瓜化的使用方式,极少的定制化选项(没错,开发者包括使用 black 的人都认为这是个优势)。 默认的 black 是将字符串格式化成用双引号包含且不支持自定义,在连续的用户抗议和开发组成员“吵”了近百楼,各种丢数据各种引经据典后,开发组成员才勉为其难给出了个不格式化字符串引号的选项。github 原楼请戳。 ### 总结 autopep8 是刚开始学习 python 的人都被推荐的一个格式化工具,不幸的是它已经不适合当下了。较低的维护频率,较低的社区活跃度,一大堆 issuse 未解决。都是我们放弃它的理由。 yapf 包含着 google 文化中的工程师极客精神,支持多样化的自定义配置是他的优点。如果你对自己的代码风格有硬性的要求,yapf 将是你不二的选择。 black 秉承的是 "less is more" 的设计标准,开发组人员负责调研哪种格式化风格更适合pythonista的开发。允许我们自定义的余地较小,但对于我们来说,有人替我们考虑了哪种方式更好,躺平享受成果不失为一种最好的选择。 对于我们团队来说 black 是我们的选择。 如果你也跟我们有一样的选择,那请往下继续阅读。 ### vscode 配置 black #### 1. 安装 black 首先是在你的virtualenv中或本地开发环境中安装 black ```shell-session pip install black ``` #### 2. 安装 python 扩展 紧接着在 vscode 中安装 python 的扩展 方式1: 在 vscode 中按下 "ctrl + p", 输入以下代码并回车 ```shell-session ext install ms-python.python ``` 方式2: 在扩展商城中直接搜索 python 并安装 ![image](https://qiniu.chaorencode.com/4eeb670d4441ec1067ba0c45813c3b80/4eeb670d4441ec1067ba0c45813c3b80) #### 3. 配置 python 扩展 按下 "ctrl + ,"打开配置页面 ![image](https://qiniu.chaorencode.com/e93019420453731a8fdf511162fc4516/e93019420453731a8fdf511162fc4516) (可选)输入 format on save 过滤出配置选项,并将"format on save"勾选上。此选项的意思为在保存时自动格式化代码。 ![image](https://qiniu.chaorencode.com/23ca5e7822f2434f268b8b97f9991f85/23ca5e7822f2434f268b8b97f9991f85) 同样输入 python formatting provider 过滤,将 "Provider" 设置为 black ![image](https://qiniu.chaorencode.com/f4a1a37127738d0117e1d6b550dfcb31/f4a1a37127738d0117e1d6b550dfcb31) #### 4. 避免字符串格式化成双引号包含(可选) 因为 black 是默认格式化成用双引号包含字符串的,而很多人包括我是用的单引号。开发组曾经和用户产生过争执,被迫接受群众意见增加了个不格式为双引号的选项,我们来看下在vscode 中如何配置。 在设置界面右上角打开 json 配置文件。 ![image](https://qiniu.chaorencode.com/196b5ab27858a9b3d93468749bdaa073/196b5ab27858a9b3d93468749bdaa073) 加入以下这行配置代码,意思是跳过字符串格式化 ![image](https://qiniu.chaorencode.com/7a5b7ea6296c808820244d114be45721/7a5b7ea6296c808820244d114be45721) #### 5.完成 如果之前选择了在保存时格式化代码,此时随便打开一个python文件`"ctrl + s"`即可看到效果。 或者在要格式化的文件按下 `"shift + alt + f"` 或右键选择 Format Document ![image](https://qiniu.chaorencode.com/94e3a4314c32b313ae47dd3ff6787e54/94e3a4314c32b313ae47dd3ff6787e54) ![image](https://qiniu.chaorencode.com/28c6c4c452b27fce7947dde26b6da3cb/28c6c4c452b27fce7947dde26b6da3cb)