常用方案

python代码格式化工具

大家都懂自动格式化代码的好处。

• 不需要再对着pep8标准扣字眼来修改自己代码
• 减少了组内不必要的讨论，专注于项目功能
• 代码风格更统一，github上传代码冲突更少
• 帮助多人开发协调代码规范

autopep8 vs yapf vs black

以下列举了python中的三个自动格式化工具：

star 数截止 2020/8/28

autopep8 - github

star 3.5k

autopep8 是一个国人中知名度最高和使用最广泛的自动格式化工具。 一个较为宽松的格式化工具，只会以最低限度的标准对不符合 pep8 标准的代码进行修正。可能无法满足那些有特定需求，或想让代码看起来更干净更漂亮的人。

yapf - github

star 11k

由 google 开发并维护的格式化工具，特点是支持多种格式化风格与功能繁多的自定义配置。默认支持三种格式化样式：pep8, google, Facebook 和 chromium。 yapf的初衷不是让代码符合pep准则， 而且让代码看起来更整洁更友好。

black - github

star 17.6k

可以说是最流行最多人使用的python格式化工具了，统一的格式化标准。傻瓜化的使用方式，极少的定制化选项（没错，开发者包括使用 black 的人都认为这是个优势）。

默认的 black 是将字符串格式化成用双引号包含且不支持自定义，在连续的用户抗议和开发组成员“吵”了近百楼，各种丢数据各种引经据典后，开发组成员才勉为其难给出了个不格式化字符串引号的选项。github 原楼请戳。

总结：

autopep8 是刚开始学习 python 的人都被推荐的一个格式化工具，不幸的是它已经不适合当下了。较低的维护频率，较低的社区活跃度，一大堆 issuse 未解决。都是我们放弃它的理由。

yapf 包含着 google 文化中的工程师极客精神，支持多样化的自定义配置是他的优点。如果你对自己的代码风格有硬性的要求，yapf 将是你不二的选择。

black 秉承的是 "less is more" 的设计标准，开发组人员负责调研哪种格式化风格更适合pythonista的开发。允许我们自定义的余地较小，但对于我们来说，有人替我们考虑了哪种方式更好，躺平享受成果不失为一种最好的选择。

对于我们团队来说 black 是我们的选择。 如果你也跟我们有一样的选择，那请往下继续阅读。