2021-01-09 PyCharm配置black,代码格式化工具

前言

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

不需要再对着pep8标准扣字眼来修改自己代码

减少了组内不必要的讨论,专注于项目功能

代码风格更统一,github上传代码冲突更少

帮助多人开发协调代码规范

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

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 是将字符串格式化成用双引号包含且不支持自定义,在连续的用户抗议和开发组成员“吵”了近百楼,各种丢数据各种引经据典后,开发组成员才勉为其难给出了个不格式化字符串引号的选项。

总结:

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

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

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

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

1.pip3.6 install black

2.选择Preference--->Tools--->External Tools 进入到以下这个页面(可能pycharm版本不同,有细小差别)

image.png
image.png

一般你只需要配置下Program和parmeters,
Program的环境配置:$PyInterpreterDirectory$/python
Paraments的配置:-m black $FilePath$
directory: $ProjectFileDir$

3.配置好后,在代码区域按鼠标右键,选择External Tools中的black。就可以啦。

image.png

autopep8,在python2版本上好用,但是autopep8本身在github上已经很久没人维护了,black在python3上好用,有人维护,但不支持python2

有用请点赞哦,你的赞同是我更新的动力~

祝你学业有成~

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