使用pylint规范Python代码风格

为了保证协同开发和代码交接时的风格统一，使用Pylint来规范目前的Python项目

参考

检查单个文件

输入：

1
pylint qst\api\zcy\factory.py --reports=no

输出：

1
2
3
4
5
6
7
8
9
10
No config file found, using default configuration
************* Module qst.api.zcy.factory
I: 15, 0: Locally disabling unused-argument (W0613) (locally-disabled)
I:118, 0: Locally disabling invalid-name (C0103) (locally-disabled)
I:189, 0: Locally disabling invalid-name (C0103) (locally-disabled)
I:196, 0: Locally disabling invalid-name (C0103) (locally-disabled)
I:203, 0: Locally disabling invalid-name (C0103) (locally-disabled)
I:212, 0: Locally disabling too-few-public-methods (R0903) (locally-disabled)
C:175, 4: Invalid method name "create_query_confirm_waybill_api" (invalid-name)
C:218, 4: Invalid method name "create_get_logistics_companies_api" (invalid-name)

检查Python包

输入：

1
pylint qst\api\gw\

输出：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
No config file found, using default configuration                                                 
************* Module qst.api.gw.authz                                                             
I: 48, 0: Locally disabling bare-except (W0702) (locally-disabled)                                
                                                                                                  
                                                                                                  
Report                                                                                            
======                                                                                            
42 statements analysed.                                                                           
                                                                                                  
Statistics by type                                                                                
------------------                                                                                
                                                                                                  
+---------+-------+-----------+-----------+------------+---------+                                
|type     |number |old number |difference |%documented |%badname |                                
+=========+=======+===========+===========+============+=========+                                
|module   |4      |4          |=          |100.00      |0.00     |                                
+---------+-------+-----------+-----------+------------+---------+                                
|class    |0      |0          |=          |0           |0        |                                
+---------+-------+-----------+-----------+------------+---------+                                
|method   |0      |0          |=          |0           |0        |                                
+---------+-------+-----------+-----------+------------+---------+                                
|function |5      |5          |=          |100.00      |0.00     |                                
+---------+-------+-----------+-----------+------------+---------+                                
                                                                                                  
                                                                                                  
                                                                                                  
External dependencies                                                                             
---------------------                                                                             
::                                                                                                
                                                                                                  
    qst                                                                                           
      \-api                                                                                       
        \-gw                                                                                      
          \-api_config (qst.api.gw.authz,qst.api.gw.factory)                                      
    requests (qst.api.gw.authz,qst.api.gw.factory)                                                
                                                                                                  
                                                                                                  
                                                                                                  
Raw metrics                                                                                       
-----------                                                                                       
                                                                                                  
+----------+-------+------+---------+-----------+                                                 
|type      |number |%     |previous |difference |                                                 
+==========+=======+======+=========+===========+                                                 
|code      |45     |46.88 |NC       |NC         |                                                 
+----------+-------+------+---------+-----------+                                                 
|docstring |19     |19.79 |NC       |NC         |                                                 
+----------+-------+------+---------+-----------+                                                 
|comment   |15     |15.62 |NC       |NC         |                                                 
+----------+-------+------+---------+-----------+                                                 
|empty     |17     |17.71 |NC       |NC         |                                                 
+----------+-------+------+---------+-----------+                                                 
                                                                                                  
                                                                                                  
                                                                                                  
Duplication                                                                                       
-----------                                                                                       
                                                                                                  
+-------------------------+------+---------+-----------+                                          
|                         |now   |previous |difference |                                          
+=========================+======+=========+===========+                                          
|nb duplicated lines      |0     |0        |=          |                                          
+-------------------------+------+---------+-----------+                                          
|percent duplicated lines |0.000 |0.000    |=          |                                          
+-------------------------+------+---------+-----------+                                          
                                                                                                  
                                                                                                  
                                                                                                  
Messages by category                                                                              
--------------------                                                                              
                                                                                                  
+-----------+-------+---------+-----------+                                                       
|type       |number |previous |difference |                                                       
+===========+=======+=========+===========+                                                       
|convention |0      |0        |=          |                                                       
+-----------+-------+---------+-----------+                                                       
|refactor   |0      |0        |=          |                                                       
+-----------+-------+---------+-----------+                                                       
|warning    |0      |0        |=          |                                                       
+-----------+-------+---------+-----------+                                                       
|error      |0      |0        |=          |                                                       
+-----------+-------+---------+-----------+                                                       
                                                                                                  
                                                                                                  
                                                                                                  
Messages                                                                                          
--------                                                                                          
                                                                                                  
+-----------------+------------+                                                                  
|message id       |occurrences |                                                                  
+=================+============+                                                                  
|locally-disabled |1           |                                                                  
+-----------------+------------+                                                                  
                                                                                                  
                                                                                                  
                                                                                                  
Global evaluation                                                                                 
-----------------                                                                                 
Your code has been rated at 10.00/10

常用参数

  • 简化输出：--reports=no
  • 将结果导出html：pylint qst\ --files-output=y --output-format=html
  • 忽略警告：# pylint:disable

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

那年二十七