1
|
# lint Python modules using external checkers.
|
2
|
#
|
3
|
# This is the main checker controlling the other ones and the reports
|
4
|
# generation. It is itself both a raw checker and an astng checker in order
|
5
|
# to:
|
6
|
# * handle message activation / deactivation at the module level
|
7
|
# * handle some basic but necessary stats'data (number of classes, methods...)
|
8
|
#
|
9
|
[MASTER]
|
10
|
|
11
|
# Specify a configuration file.
|
12
|
#rcfile=
|
13
|
|
14
|
# Python code to execute, usually for sys.path manipulation such as
|
15
|
# pygtk.require().
|
16
|
#init-hook=
|
17
|
|
18
|
# Profiled execution.
|
19
|
profile=no
|
20
|
|
21
|
# Add <file or directory> to the black list. It should be a base name, not a
|
22
|
# path. You may set this option multiple times.
|
23
|
ignore=.svn,qommon
|
24
|
|
25
|
# Pickle collected data for later comparisons.
|
26
|
persistent=yes
|
27
|
|
28
|
# Set the cache size for astng objects.
|
29
|
cache-size=500
|
30
|
|
31
|
# List of plugins (as comma separated values of python modules names) to load,
|
32
|
# usually to register additional checkers.
|
33
|
load-plugins=
|
34
|
|
35
|
|
36
|
[MESSAGES CONTROL]
|
37
|
|
38
|
# Enable only checker(s) with the given id(s). This option conflicts with the
|
39
|
# disable-checker option
|
40
|
#enable-checker=
|
41
|
|
42
|
# Enable all checker(s) except those with the given id(s). This option
|
43
|
# conflicts with the enable-checker option
|
44
|
#disable-checker=
|
45
|
|
46
|
# Enable all messages in the listed categories.
|
47
|
#enable-msg-cat=
|
48
|
|
49
|
# Disable all messages in the listed categories.
|
50
|
#disable-msg-cat=
|
51
|
|
52
|
# Enable the message(s) with the given id(s).
|
53
|
#enable-msg=
|
54
|
|
55
|
# Disable the message(s) with the given id(s).
|
56
|
disable-msg=C0111,R0904,W0403
|
57
|
|
58
|
|
59
|
[REPORTS]
|
60
|
|
61
|
# Set the output format. Available formats are text, parseable, colorized, msvs
|
62
|
# (visual studio) and html
|
63
|
output-format=text
|
64
|
|
65
|
# Include message's id in output
|
66
|
include-ids=yes
|
67
|
|
68
|
# Put messages in a separate file for each module / package specified on the
|
69
|
# command line instead of printing them on stdout. Reports (if any) will be
|
70
|
# written in a file name "pylint_global.[txt|html]".
|
71
|
files-output=no
|
72
|
|
73
|
# Tells wether to display a full report or only the messages
|
74
|
reports=no
|
75
|
|
76
|
# Python expression which should return a note less than 10 (10 is the highest
|
77
|
# note). You have access to the variables errors warning, statement which
|
78
|
# respectivly contain the number of errors / warnings messages and the total
|
79
|
# number of statements analyzed. This is used by the global evaluation report
|
80
|
# (R0004).
|
81
|
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
|
82
|
|
83
|
# Add a comment according to your evaluation note. This is used by the global
|
84
|
# evaluation report (R0004).
|
85
|
comment=no
|
86
|
|
87
|
# Enable the report(s) with the given id(s).
|
88
|
#enable-report=
|
89
|
|
90
|
# Disable the report(s) with the given id(s).
|
91
|
#disable-report=
|
92
|
|
93
|
|
94
|
# try to find bugs in the code using type inference
|
95
|
#
|
96
|
[TYPECHECK]
|
97
|
|
98
|
# Tells wether missing members accessed in mixin class should be ignored. A
|
99
|
# mixin class is detected if its name ends with "mixin" (case insensitive).
|
100
|
ignore-mixin-members=yes
|
101
|
|
102
|
# List of classes names for which member attributes should not be checked
|
103
|
# (useful for classes with attributes dynamicaly set).
|
104
|
ignored-classes=SQLObject
|
105
|
|
106
|
# When zope mode is activated, add a predefined set of Zope acquired attributes
|
107
|
# to generated-members.
|
108
|
zope=no
|
109
|
|
110
|
# List of members which are set dynamically and missed by pylint inference
|
111
|
# system, and so shouldn't trigger E0201 when accessed.
|
112
|
generated-members=REQUEST,acl_users,aq_parent
|
113
|
|
114
|
|
115
|
# checks for
|
116
|
# * unused variables / imports
|
117
|
# * undefined variables
|
118
|
# * redefinition of variable from builtins or from an outer scope
|
119
|
# * use of variable before assigment
|
120
|
#
|
121
|
[VARIABLES]
|
122
|
|
123
|
# Tells wether we should check for unused import in __init__ files.
|
124
|
init-import=no
|
125
|
|
126
|
# A regular expression matching names used for dummy variables (i.e. not used).
|
127
|
dummy-variables-rgx=_|dummy
|
128
|
|
129
|
# List of additional names supposed to be defined in builtins. Remember that
|
130
|
# you should avoid to define new builtins when possible.
|
131
|
additional-builtins=
|
132
|
|
133
|
|
134
|
# checks for :
|
135
|
# * doc strings
|
136
|
# * modules / classes / functions / methods / arguments / variables name
|
137
|
# * number of arguments, local variables, branchs, returns and statements in
|
138
|
# functions, methods
|
139
|
# * required module attributes
|
140
|
# * dangerous default values as arguments
|
141
|
# * redefinition of function / method / class
|
142
|
# * uses of the global statement
|
143
|
#
|
144
|
[BASIC]
|
145
|
|
146
|
# Required attributes for module, separated by a comma
|
147
|
required-attributes=
|
148
|
|
149
|
# Regular expression which should only match functions or classes name which do
|
150
|
# not require a docstring
|
151
|
no-docstring-rgx=__.*__
|
152
|
|
153
|
# Regular expression which should only match correct module names
|
154
|
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
|
155
|
|
156
|
# Regular expression which should only match correct module level names
|
157
|
#const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
|
158
|
const-rgx=[a-z\_][a-z0-9\_]{2,30}$
|
159
|
|
160
|
# Regular expression which should only match correct class names
|
161
|
class-rgx=[A-Z_][a-zA-Z0-9]+$
|
162
|
|
163
|
# Regular expression which should only match correct function names
|
164
|
function-rgx=[a-z_][a-z0-9_]{2,30}$
|
165
|
|
166
|
# Regular expression which should only match correct method names
|
167
|
method-rgx=[a-z_][a-z0-9_]{2,30}$
|
168
|
|
169
|
# Regular expression which should only match correct instance attribute names
|
170
|
attr-rgx=[a-z_][a-z0-9_]{2,30}$
|
171
|
|
172
|
# Regular expression which should only match correct argument names
|
173
|
argument-rgx=[a-z_][a-z0-9_]{2,30}$
|
174
|
|
175
|
# Regular expression which should only match correct variable names
|
176
|
variable-rgx=[a-z_][a-z0-9_]{2,30}$
|
177
|
|
178
|
# Regular expression which should only match correct list comprehension /
|
179
|
# generator expression variable names
|
180
|
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
|
181
|
|
182
|
# Good variable names which should always be accepted, separated by a comma
|
183
|
good-names=i,j,k,ex,Run,_
|
184
|
|
185
|
# Bad variable names which should always be refused, separated by a comma
|
186
|
bad-names=foo,bar,baz,toto,tutu,tata
|
187
|
|
188
|
# List of builtins function names that should not be used, separated by a comma
|
189
|
bad-functions=map,filter,apply,input
|
190
|
|
191
|
|
192
|
# checks for sign of poor/misdesign:
|
193
|
# * number of methods, attributes, local variables...
|
194
|
# * size, complexity of functions, methods
|
195
|
#
|
196
|
[DESIGN]
|
197
|
|
198
|
# Maximum number of arguments for function / method
|
199
|
max-args=5
|
200
|
|
201
|
# Maximum number of locals for function / method body
|
202
|
max-locals=15
|
203
|
|
204
|
# Maximum number of return / yield for function / method body
|
205
|
max-returns=6
|
206
|
|
207
|
# Maximum number of branch for function / method body
|
208
|
max-branchs=12
|
209
|
|
210
|
# Maximum number of statements in function / method body
|
211
|
max-statements=50
|
212
|
|
213
|
# Maximum number of parents for a class (see R0901).
|
214
|
max-parents=7
|
215
|
|
216
|
# Maximum number of attributes for a class (see R0902).
|
217
|
max-attributes=7
|
218
|
|
219
|
# Minimum number of public methods for a class (see R0903).
|
220
|
min-public-methods=2
|
221
|
|
222
|
# Maximum number of public methods for a class (see R0904).
|
223
|
max-public-methods=20
|
224
|
|
225
|
|
226
|
# checks for :
|
227
|
# * methods without self as first argument
|
228
|
# * overridden methods signature
|
229
|
# * access only to existant members via self
|
230
|
# * attributes not defined in the __init__ method
|
231
|
# * supported interfaces implementation
|
232
|
# * unreachable code
|
233
|
#
|
234
|
[CLASSES]
|
235
|
|
236
|
# List of interface methods to ignore, separated by a comma. This is used for
|
237
|
# instance to not check methods defines in Zope's Interface base class.
|
238
|
ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
|
239
|
|
240
|
# List of method names used to declare (i.e. assign) instance attributes.
|
241
|
defining-attr-methods=__init__,__new__,setUp
|
242
|
|
243
|
|
244
|
# checks for
|
245
|
# * external modules dependencies
|
246
|
# * relative / wildcard imports
|
247
|
# * cyclic imports
|
248
|
# * uses of deprecated modules
|
249
|
#
|
250
|
[IMPORTS]
|
251
|
|
252
|
# Deprecated modules which should not be used, separated by a comma
|
253
|
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
|
254
|
|
255
|
# Create a graph of every (i.e. internal and external) dependencies in the
|
256
|
# given file (report R0402 must not be disabled)
|
257
|
import-graph=
|
258
|
|
259
|
# Create a graph of external dependencies in the given file (report R0402 must
|
260
|
# not be disabled)
|
261
|
ext-import-graph=
|
262
|
|
263
|
# Create a graph of internal dependencies in the given file (report R0402 must
|
264
|
# not be disabled)
|
265
|
int-import-graph=
|
266
|
|
267
|
|
268
|
# checks for :
|
269
|
# * unauthorized constructions
|
270
|
# * strict indentation
|
271
|
# * line length
|
272
|
# * use of <> instead of !=
|
273
|
#
|
274
|
[FORMAT]
|
275
|
|
276
|
# Maximum number of characters on a single line.
|
277
|
max-line-length=100
|
278
|
|
279
|
# Maximum number of lines in a module
|
280
|
max-module-lines=1000
|
281
|
|
282
|
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
|
283
|
# tab).
|
284
|
indent-string=' '
|
285
|
|
286
|
|
287
|
# checks for similarities and duplicated code. This computation may be
|
288
|
# memory / CPU intensive, so you should disable it if you experiments some
|
289
|
# problems.
|
290
|
#
|
291
|
[SIMILARITIES]
|
292
|
|
293
|
# Minimum lines number of a similarity.
|
294
|
min-similarity-lines=4
|
295
|
|
296
|
# Ignore comments when computing similarities.
|
297
|
ignore-comments=yes
|
298
|
|
299
|
# Ignore docstrings when computing similarities.
|
300
|
ignore-docstrings=yes
|
301
|
|
302
|
|
303
|
# checks for:
|
304
|
# * warning notes in the code like FIXME, XXX
|
305
|
# * PEP 263: source code with non ascii character but no encoding declaration
|
306
|
#
|
307
|
[MISCELLANEOUS]
|
308
|
|
309
|
# List of note tags to take in consideration, separated by a comma.
|
310
|
notes=FIXME,XXX,TODO
|