comparison pylintrc @ 0:1fd2201f5c36

Initial commit of parpg-core.
author M. George Hansen <technopolitica@gmail.com>
date Sat, 14 May 2011 01:12:35 -0700
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:1fd2201f5c36
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=CVS
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 (IRCWEF).
47 #enable-msg-cat=
48
49 # Disable all messages in the listed categories (IRCWEF).
50 disable-msg-cat=I
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=W0704,W0105,W0142,R0901,R0913,W0221,W0613,R0903,R0902,R0201,R0904,R0914,R0912,W0511,R0915,R0911
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=yes
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=R0004
89
90 # Disable the report(s) with the given id(s).
91 disable-report=R0001,R0002,R0003,R0101,R0401,R0402,R0701,R0801
92
93
94 # checks for :
95 # * doc strings
96 # * modules / classes / functions / methods / arguments / variables name
97 # * number of arguments, local variables, branchs, returns and statements in
98 # functions, methods
99 # * required module attributes
100 # * dangerous default values as arguments
101 # * redefinition of function / method / class
102 # * uses of the global statement
103 #
104 [BASIC]
105
106 # Required attributes for module, separated by a comma
107 required-attributes=
108
109 # Regular expression which should only match functions or classes name which do
110 # not require a docstring
111 no-docstring-rgx=__.*__
112
113 # Regular expression which should only match correct module names
114 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
115
116 # Regular expression which should only match correct module level names
117 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
118
119 # Regular expression which should only match correct class names
120 class-rgx=[A-Z_][a-zA-Z0-9]+$
121
122 # Regular expression which should only match correct function names
123 function-rgx=[a-z_][a-zA-Z0-9]{2,30}$
124
125 # Regular expression which should only match correct method names
126 method-rgx=[a-z_][a-zA-Z0-9]{2,30}$
127
128 # Regular expression which should only match correct instance attribute names
129 attr-rgx=[a-z_][a-z0-9_]{2,30}$
130
131 # Regular expression which should only match correct argument names
132 argument-rgx=[a-z_][a-z0-9_]{2,30}$
133
134 # Regular expression which should only match correct variable names
135 variable-rgx=[a-z_][a-z0-9_]{2,30}$
136
137 # Regular expression which should only match correct list comprehension /
138 # generator expression variable names
139 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
140
141 # Good variable names which should always be accepted, separated by a comma
142 good-names=k,ex,Run,_,__init__,__getstate__,__setstate__,ID,__repr__,x,y,z,X,Y,Z,__str__,__getitem__
143
144 # Bad variable names which should always be refused, separated by a comma
145 bad-names=foo,bar,baz,toto,tutu,tata
146
147 # List of builtins function names that should not be used, separated by a comma
148 bad-functions=map,filter,apply,input
149
150
151 # try to find bugs in the code using type inference
152 #
153 [TYPECHECK]
154
155 # Tells wether missing members accessed in mixin class should be ignored. A
156 # mixin class is detected if its name ends with "mixin" (case insensitive).
157 ignore-mixin-members=yes
158
159 # List of classes names for which member attributes should not be checked
160 # (useful for classes with attributes dynamicaly set).
161 ignored-classes=SQLObject
162
163 # When zope mode is activated, add a predefined set of Zope acquired attributes
164 # to generated-members.
165 zope=no
166
167 # List of members which are set dynamically and missed by pylint inference
168 # system, and so shouldn't trigger E0201 when accessed.
169 generated-members=REQUEST,acl_users,aq_parent
170
171
172 # checks for
173 # * unused variables / imports
174 # * undefined variables
175 # * redefinition of variable from builtins or from an outer scope
176 # * use of variable before assigment
177 #
178 [VARIABLES]
179
180 # Tells wether we should check for unused import in __init__ files.
181 init-import=no
182
183 # A regular expression matching names used for dummy variables (i.e. not used).
184 dummy-variables-rgx=_|dummy
185
186 # List of additional names supposed to be defined in builtins. Remember that
187 # you should avoid to define new builtins when possible.
188 additional-builtins=
189
190
191 # checks for :
192 # * methods without self as first argument
193 # * overridden methods signature
194 # * access only to existant members via self
195 # * attributes not defined in the __init__ method
196 # * supported interfaces implementation
197 # * unreachable code
198 #
199 [CLASSES]
200
201 # List of interface methods to ignore, separated by a comma. This is used for
202 # instance to not check methods defines in Zope's Interface base class.
203 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
204
205 # List of method names used to declare (i.e. assign) instance attributes.
206 defining-attr-methods=__init__,__new__,setUp
207
208
209 # checks for sign of poor/misdesign:
210 # * number of methods, attributes, local variables...
211 # * size, complexity of functions, methods
212 #
213 [DESIGN]
214
215 # Maximum number of arguments for function / method
216 max-args=5
217
218 # Maximum number of locals for function / method body
219 max-locals=15
220
221 # Maximum number of return / yield for function / method body
222 max-returns=6
223
224 # Maximum number of branch for function / method body
225 max-branchs=12
226
227 # Maximum number of statements in function / method body
228 max-statements=50
229
230 # Maximum number of parents for a class (see R0901).
231 max-parents=7
232
233 # Maximum number of attributes for a class (see R0902).
234 max-attributes=7
235
236 # Minimum number of public methods for a class (see R0903).
237 min-public-methods=2
238
239 # Maximum number of public methods for a class (see R0904).
240 max-public-methods=20
241
242
243 # checks for
244 # * external modules dependencies
245 # * relative / wildcard imports
246 # * cyclic imports
247 # * uses of deprecated modules
248 #
249 [IMPORTS]
250
251 # Deprecated modules which should not be used, separated by a comma
252 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
253
254 # Create a graph of every (i.e. internal and external) dependencies in the
255 # given file (report R0402 must not be disabled)
256 import-graph=
257
258 # Create a graph of external dependencies in the given file (report R0402 must
259 # not be disabled)
260 ext-import-graph=
261
262 # Create a graph of internal dependencies in the given file (report R0402 must
263 # not be disabled)
264 int-import-graph=
265
266
267 # checks for :
268 # * unauthorized constructions
269 # * strict indentation
270 # * line length
271 # * use of <> instead of !=
272 #
273 [FORMAT]
274
275 # Maximum number of characters on a single line.
276 max-line-length=80
277
278 # Maximum number of lines in a module
279 max-module-lines=1000
280
281 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
282 # tab).
283 indent-string=' '
284
285
286 # checks for:
287 # * warning notes in the code like FIXME, XXX
288 # * PEP 263: source code with non ascii character but no encoding declaration
289 #
290 [MISCELLANEOUS]
291
292 # List of note tags to take in consideration, separated by a comma.
293 notes=FIXME,XXX,TODO
294
295
296 # checks for similarities and duplicated code. This computation may be
297 # memory / CPU intensive, so you should disable it if you experiments some
298 # problems.
299 #
300 [SIMILARITIES]
301
302 # Minimum lines number of a similarity.
303 min-similarity-lines=4
304
305 # Ignore comments when computing similarities.
306 ignore-comments=yes
307
308 # Ignore docstrings when computing similarities.
309 ignore-docstrings=yes