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




公众号  超人编程






前言

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

因此大多数公司招聘python开发人员时将了解pep8规范和懂得使用自动格式化工具列入必备技能。

autopep8 vs yapf vs black

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

star 数截止 2020/11/25

autopep8 - github

star 3.6k

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

yapf - github

star 11.2k

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

black - github

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

pip install black

2. 安装 python 扩展

紧接着在 vscode 中安装 python 的扩展

方式1:

在 vscode 中按下 "ctrl + p", 输入以下代码并回车

ext install ms-python.python

方式2:

在扩展商城中直接搜索 python 并安装

3. 配置 python 扩展

按下 "ctrl + ,"打开配置页面

(可选)输入 format on save 过滤出配置选项,并将"format on save"勾选上。此选项的意思为在保存时自动格式化代码。

同样输入 python formatting provider 过滤,将 "Provider" 设置为 black

4. 避免字符串格式化成双引号包含(可选)

因为 black 是默认格式化成用双引号包含字符串的,而很多人包括我是用的单引号。开发组曾经和用户产生过争执,被迫接受群众意见增加了个不格式为双引号的选项,我们来看下在vscode 中如何配置。

在设置界面右上角打开 json 配置文件。

加入以下这行配置代码,意思是跳过字符串格式化

5.完成

如果之前选择了在保存时格式化代码,此时随便打开一个python文件"ctrl + s"即可看到效果。

或者在要格式化的文件按下 "shift + alt + f" 或右键选择 Format Document






©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,635评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,628评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,971评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,986评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,006评论 6 394
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,784评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,475评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,364评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,860评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,008评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,152评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,829评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,490评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,035评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,156评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,428评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,127评论 2 356

推荐阅读更多精彩内容