2021-01-09 PyCharm配置black扮叨,代碼格式化工具

前言

大家都懂自動格式化代碼的好處缤弦。

不需要再對著pep8標(biāo)準(zhǔn)扣字眼來修改自己代碼

減少了組內(nèi)不必要的討論,專注于項目功能

代碼風(fēng)格更統(tǒng)一彻磁,github上傳代碼沖突更少

幫助多人開發(fā)協(xié)調(diào)代碼規(guī)范

因此大多數(shù)公司招聘python開發(fā)人員時將了解pep8規(guī)范和懂得使用自動格式化工具列入必備技能碍沐。

autopep8 vs yapf vs black

以下列舉了python中的三個自動格式化工具:

star 數(shù)截止 2020/8/28

autopep8 - github

star 3.5k

autopep8 是一個國人中知名度最高和使用最廣泛的自動格式化工具。 一個較為寬松的格式化工具衷蜓,只會以最低限度的標(biāo)準(zhǔn)對不符合 pep8 標(biāo)準(zhǔn)的代碼進(jìn)行修正累提。可能無法滿足那些有特定需求磁浇,或想讓代碼看起來更干凈更漂亮的人斋陪。

yapf - github

star 11k

由 google 開發(fā)并維護(hù)的格式化工具,特點(diǎn)是支持多種格式化風(fēng)格置吓。默認(rèn)支持三種格式化樣式:pep8, google, Facebook 和 chromium无虚。 yapf的初衷不是讓代碼符合pep準(zhǔn)則, 而且讓代碼看起來更整潔更友好衍锚。

black - github

star 17.6k

可以說是最流行最多人使用的python格式化工具了友题,統(tǒng)一的格式化標(biāo)準(zhǔn)。傻瓜化的使用方式戴质,極少的定制化選項(沒錯度宦,開發(fā)者包括使用 black 的人都認(rèn)為這是個優(yōu)勢)。

默認(rèn)的 black 是將字符串格式化成用雙引號包含且不支持自定義告匠,在連續(xù)的用戶抗議和開發(fā)組成員“吵”了近百樓戈抄,各種丟數(shù)據(jù)各種引經(jīng)據(jù)典后,開發(fā)組成員才勉為其難給出了個不格式化字符串引號的選項后专。

總結(jié):

autopep8 是剛開始學(xué)習(xí) python 的人都被推薦的一個格式化工具呛凶,不幸的是它已經(jīng)不適合當(dāng)下了。較低的維護(hù)頻率行贪,較低的社區(qū)活躍度漾稀,一大堆 issuse 未解決。都是我們放棄它的理由建瘫。

yapf 包含著 google 文化中的工程師極客精神崭捍,支持自定義配置是他的優(yōu)點(diǎn)。如果你對自己的代碼風(fēng)格有硬性的要求啰脚,yapf 將是你不二的選擇殷蛇。

black 秉承的是 "less is more" 的設(shè)計標(biāo)準(zhǔn)实夹,開發(fā)組人員負(fù)責(zé)調(diào)研哪種格式化風(fēng)格更適合pythonista的開發(fā)。允許我們自定義的余地較小粒梦,但對于我們來說亮航,有人替我們考慮了哪種方式更好,躺平享受成果不失為一種最好的選擇匀们。

對于我們團(tuán)隊來說 black 是我們的選擇缴淋。 如果你也跟我們有一樣的選擇,那請往下繼續(xù)閱讀泄朴。

1.pip3.6 install black

2.選擇Preference--->Tools--->External Tools 進(jìn)入到以下這個頁面(可能pycharm版本不同重抖,有細(xì)小差別)

image.png
image.png

一般你只需要配置下Program和parmeters,
Program的環(huán)境配置:$PyInterpreterDirectory$/python
Paraments的配置:-m black $FilePath$
directory: $ProjectFileDir$

3.配置好后祖灰,在代碼區(qū)域按鼠標(biāo)右鍵钟沛,選擇External Tools中的black。就可以啦局扶。

image.png

autopep8恨统,在python2版本上好用,但是autopep8本身在github上已經(jīng)很久沒人維護(hù)了三妈,black在python3上好用畜埋,有人維護(hù),但不支持python2

有用請點(diǎn)贊哦沈跨,你的贊同是我更新的動力~

祝你學(xué)業(yè)有成~

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末由捎,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子饿凛,更是在濱河造成了極大的恐慌狞玛,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,542評論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件涧窒,死亡現(xiàn)場離奇詭異心肪,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)纠吴,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,596評論 3 385
  • 文/潘曉璐 我一進(jìn)店門硬鞍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人戴已,你說我怎么就攤上這事固该。” “怎么了糖儡?”我有些...
    開封第一講書人閱讀 158,021評論 0 348
  • 文/不壞的土叔 我叫張陵伐坏,是天一觀的道長。 經(jīng)常有香客問我握联,道長桦沉,這世上最難降的妖魔是什么每瞒? 我笑而不...
    開封第一講書人閱讀 56,682評論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮纯露,結(jié)果婚禮上剿骨,老公的妹妹穿的比我還像新娘。我一直安慰自己埠褪,他們只是感情好浓利,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,792評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著组橄,像睡著了一般荞膘。 火紅的嫁衣襯著肌膚如雪罚随。 梳的紋絲不亂的頭發(fā)上玉工,一...
    開封第一講書人閱讀 49,985評論 1 291
  • 那天,我揣著相機(jī)與錄音淘菩,去河邊找鬼遵班。 笑死,一個胖子當(dāng)著我的面吹牛潮改,可吹牛的內(nèi)容都是我干的狭郑。 我是一名探鬼主播,決...
    沈念sama閱讀 39,107評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼汇在,長吁一口氣:“原來是場噩夢啊……” “哼翰萨!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起糕殉,我...
    開封第一講書人閱讀 37,845評論 0 268
  • 序言:老撾萬榮一對情侶失蹤亩鬼,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后阿蝶,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體雳锋,經(jīng)...
    沈念sama閱讀 44,299評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,612評論 2 327
  • 正文 我和宋清朗相戀三年羡洁,在試婚紗的時候發(fā)現(xiàn)自己被綠了玷过。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,747評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡筑煮,死狀恐怖辛蚊,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情真仲,我是刑警寧澤袋马,帶...
    沈念sama閱讀 34,441評論 4 333
  • 正文 年R本政府宣布,位于F島的核電站袒餐,受9級特大地震影響飞蛹,放射性物質(zhì)發(fā)生泄漏谤狡。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,072評論 3 317
  • 文/蒙蒙 一卧檐、第九天 我趴在偏房一處隱蔽的房頂上張望墓懂。 院中可真熱鬧,春花似錦霉囚、人聲如沸捕仔。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,828評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽榜跌。三九已至,卻和暖如春盅粪,著一層夾襖步出監(jiān)牢的瞬間钓葫,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,069評論 1 267
  • 我被黑心中介騙來泰國打工票顾, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留础浮,地道東北人。 一個月前我還...
    沈念sama閱讀 46,545評論 2 362
  • 正文 我出身青樓奠骄,卻偏偏與公主長得像豆同,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子含鳞,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,658評論 2 350