【python】pylint在項(xiàng)目中的使用

需求背景:

Pylint 是一個(gè) Python 代碼分析工具,它分析 Python 代碼中的錯(cuò)誤穴张,查找不符合代碼風(fēng)格標(biāo)準(zhǔn)和有潛在問(wèn)題的代碼俊柔。

Pylint 是一個(gè) Python 工具埠况,除了平常代碼分析工具的作用之外,它提供了更多的功能:如檢查一行代碼的長(zhǎng)度痴怨,變量名是否符合命名標(biāo)準(zhǔn),一個(gè)聲明過(guò)的接口是否被真正實(shí)現(xiàn)等等器予。

Pylint 的一個(gè)很大的好處是它的高可配置性浪藻,高可定制性,并且可以很容易寫小插件來(lái)添加功能乾翔。

項(xiàng)目中需要做代碼規(guī)范檢查爱葵,所以研究一下pylint的使用。

pylint使用:

  • 安裝pylint:

>pip install pylint

確認(rèn)pylint安裝成功:

>pylint --version
No config file found, using default configuration
pylint 1.6.5,
astroid 1.4.9
Python 2.7.13 (v2.7.13:a06454b1afa1, Dec 17 2016, 20:53:40) [MSC v.1500 64 bit (AMD64)]
  • 生成默認(rèn)配置文件:

>pylint --persistent=n --generate-rcfile > pylint.conf
No config file found, using default configuration

查看當(dāng)前目錄下反浓,已經(jīng)生成了名為pylint.conf的文件钧惧,該文件中的配置項(xiàng)都是pylint的默認(rèn)配置,比較大400多行勾习。

  • check單個(gè)文件:

>pylint --rcfile=pylint.conf manage.py
  • check結(jié)果總覽:
************* Module manage
C:  1, 0: Missing module docstring (missing-docstring)
W: 14,12: Unused import django (unused-import)

報(bào)告中上述格式為檢查結(jié)果總覽:C表示convention浓瞪,規(guī)范;W表示warning巧婶,告警乾颁;pylint結(jié)果總共有四個(gè)級(jí)別:error,warning艺栈,refactor英岭,convention,可以根據(jù)首字母確定相應(yīng)的級(jí)別湿右。1, 0表示告警所在文件中的行號(hào)和列號(hào)诅妹。

  • 4種級(jí)別告警匯總:
Messages by category
+-----------+-------+---------+-----------+
|type       |number |previous |difference |
+===========+=======+=========+===========+
|convention |1      |NC       |NC         |
+-----------+-------+---------+-----------+
|refactor   |0      |NC       |NC         |
+-----------+-------+---------+-----------+
|warning    |1      |NC       |NC         |
+-----------+-------+---------+-----------+
|error      |0      |NC       |NC         |
+-----------+-------+---------+-----------+
  • 消息類型統(tǒng)計(jì):
Messages
+------------------+------------+
|message id        |occurrences |
+==================+============+
|mixed-indentation |8           |
+------------------+------------+
|unused-import     |2           |
+------------------+------------+
|invalid-name      |2           |
+------------------+------------+
|redefined-builtin |1           |
+------------------+------------+
  • check整個(gè)工程:

    目前看只能一個(gè)module一個(gè)module的pylint,但是如果在工程根目錄下添加init.py文件毅人,即把工程當(dāng)做一個(gè)python包的話吭狡,可以對(duì)整個(gè)工程進(jìn)行pylint。
pylint api(api為包名稱)

重命名pylint.conf為.pylintrc丈莺,即不需要每次執(zhí)行都帶上--rcfile參數(shù)了:

pylintrc in the current working directory
.pylintrc in the current working directory
If the current working directory is in a Python module, Pylint searches up the hierarchy of Python modules until it finds a pylintrc file. This allows you to specify coding standards on a module-by-module basis. Of course, a directory is judged to be a Python module if it contains an __init__.py file.
The file named by environment variable PYLINTRC
if you have a home directory which isn’t /root:
.pylintrc in your home directory
.config/pylintrc in your home directory
/etc/pylintrc

pylint集成到PyCharm:

打開File->設(shè)置對(duì)話框:

settings.png

單擊ToolsExternal Tools划煮,添加External Tool:
Create Tool.png

這樣修改完代碼后,Tools菜單下就會(huì)多出pylint工具了:

pylint.png

如果想要pylint當(dāng)前文件缔俄,只要運(yùn)行上圖的pylint工具即可弛秋。


參考資料:

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市俐载,隨后出現(xiàn)的幾起案子蟹略,更是在濱河造成了極大的恐慌,老刑警劉巖遏佣,帶你破解...
    沈念sama閱讀 217,907評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件挖炬,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡贼急,警方通過(guò)查閱死者的電腦和手機(jī)茅茂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,987評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)太抓,“玉大人空闲,你說(shuō)我怎么就攤上這事∽叩校” “怎么了碴倾?”我有些...
    開封第一講書人閱讀 164,298評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)掉丽。 經(jīng)常有香客問(wèn)我跌榔,道長(zhǎng),這世上最難降的妖魔是什么捶障? 我笑而不...
    開封第一講書人閱讀 58,586評(píng)論 1 293
  • 正文 為了忘掉前任僧须,我火速辦了婚禮,結(jié)果婚禮上项炼,老公的妹妹穿的比我還像新娘担平。我一直安慰自己,他們只是感情好锭部,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,633評(píng)論 6 392
  • 文/花漫 我一把揭開白布暂论。 她就那樣靜靜地躺著,像睡著了一般拌禾。 火紅的嫁衣襯著肌膚如雪取胎。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,488評(píng)論 1 302
  • 那天湃窍,我揣著相機(jī)與錄音闻蛀,去河邊找鬼。 笑死您市,一個(gè)胖子當(dāng)著我的面吹牛循榆,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播墨坚,決...
    沈念sama閱讀 40,275評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼秧饮,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了泽篮?” 一聲冷哼從身側(cè)響起盗尸,我...
    開封第一講書人閱讀 39,176評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎帽撑,沒(méi)想到半個(gè)月后泼各,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,619評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡亏拉,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,819評(píng)論 3 336
  • 正文 我和宋清朗相戀三年扣蜻,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了逆巍。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,932評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡莽使,死狀恐怖锐极,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情芳肌,我是刑警寧澤灵再,帶...
    沈念sama閱讀 35,655評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站亿笤,受9級(jí)特大地震影響翎迁,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜净薛,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,265評(píng)論 3 329
  • 文/蒙蒙 一汪榔、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧肃拜,春花似錦揍异、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,871評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至柿菩,卻和暖如春戚嗅,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背枢舶。 一陣腳步聲響...
    開封第一講書人閱讀 32,994評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工懦胞, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人凉泄。 一個(gè)月前我還...
    沈念sama閱讀 48,095評(píng)論 3 370
  • 正文 我出身青樓躏尉,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親后众。 傳聞我的和親對(duì)象是個(gè)殘疾皇子胀糜,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,884評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容