建站
咨詢
售后
建站咨詢
新聞中心
代碼可讀性是評(píng)判代碼質(zhì)量的標(biāo)準(zhǔn)之一，有一個(gè)衡量代碼質(zhì)量的標(biāo)準(zhǔn)是 Martin 提出的 “WFT” 定律，即每分鐘爆出 “WTF” 的次數(shù)。你在讀別人代碼或者做 Code Review 的時(shí)候有沒(méi)有 “WTF” 沖動(dòng)呢？
為了幫助開(kāi)發(fā)者統(tǒng)一代碼風(fēng)格，Python 社區(qū)提出了 PEP8 代碼編碼風(fēng)格，它并沒(méi)有強(qiáng)制要求大家必須遵循，Python 官方同時(shí)推出了一個(gè)檢查代碼風(fēng)格是否符合 PEP8 的工具，名字也叫 pep8，后來(lái)被重命名為了 pycodestyle。
看如下代碼：
這是一個(gè)不符合 PEP8 的代碼段，用 pycodestyle 可檢測(cè)有哪些地方不符合 PEP8 風(fēng)格。
pycodestyle 提示我們有兩處地方不符合規(guī)范，***個(gè)是單行有多個(gè) import，第二個(gè)是類與模塊之間需要空兩行，這只是一個(gè)簡(jiǎn)單代碼示例，真正的業(yè)務(wù)代碼可能有上百行甚至幾百行，如果我們要根據(jù) PEP8 規(guī)范逐個(gè)進(jìn)行修改建議會(huì)非常耗時(shí)，而我們的開(kāi)發(fā)過(guò)程中，如果時(shí)刻關(guān)注每一行代碼是否完全遵循 PEP8，將影響開(kāi)發(fā)效率。
而有這么一款工具 Black，號(hào)稱不妥協(xié)的代碼格式化工具，為什么叫不妥協(xié)呢？因?yàn)樗鼨z測(cè)到不符合規(guī)范的代碼風(fēng)格直接就幫你全部格式化好，根本不需要你確定，直接替你做好決定。它也是 requests 作者最喜歡的工具之一
使用非常簡(jiǎn)單，安裝成功后，和其他系統(tǒng)命令一樣使用，只需在 black 命令后面指定需要格式化的文件或者目錄就ok。
black link.py
這是一款小而美的工具，它并不是完全按照 PEP8 規(guī)范來(lái)格式化，比如默認(rèn)每行代碼的字符數(shù)是88個(gè)，當(dāng)然你可以通過(guò)參數(shù) -l 自定義長(zhǎng)度，能一行顯示完成的代碼會(huì)放在一行，比如有多個(gè)元素的列表
后者把多個(gè)元素放在一行，顯然更易讀，而且代碼更緊湊（如果你的工資是按照代碼行數(shù)來(lái)算的話，不建議這么做），Black 是 PEP8 的嚴(yán)格子集。我的***實(shí)踐方式就是使用 PyCharm 自帶的格式化工具配合 Black 使用。因?yàn)?Black 也支持集成到 Pycharm 中。
如何集成 Pycharm？1、 安裝black：
pip install black
2、 找到 black 的安裝路徑
$ which black # linux/mac$ where black # windows3、 添加擴(kuò)展工具，打開(kāi) Preferences->Tools->External Tools ，添加一個(gè)新的擴(kuò)展工具，Program 填 black 的安裝路徑，Arguments 填 $FilePath$
4、選擇 Tools-> External Tools-> Black 即可對(duì)當(dāng)前打開(kāi)的文件斤西瓜代碼格式化，當(dāng)然，你還可以為其指定一個(gè)快捷鍵，使操作起來(lái)更方便。
值得注意的是，該工具只支持 Python3.6 環(huán)境
網(wǎng)站標(biāo)題：推薦一個(gè)小而美的Python代碼格式化工具
分享地址：http://www.5511xx.com/article/cohpdhd.html
