DO_NOT_MERGE CSIT-1194 - Framework easy pylint improvements
[csit.git] / pylint.cfg
1 [MASTER]
2
3 # Specify a configuration file.
4 #rcfile=
5
6 # Python code to execute, usually for sys.path manipulation such as
7 # pygtk.require().
8 #init-hook=
9
10 # Profiled execution.
11 profile=no
12
13 # Add files or directories to the blacklist. They should be base names, not
14 # paths.
15 ignore=CVS
16
17 # Pickle collected data for later comparisons.
18 persistent=yes
19
20 # List of plugins (as comma separated values of python modules names) to load,
21 # usually to register additional checkers.
22 load-plugins=
23
24 # A comma-separated list of package or module names from where C extensions may
25 # be loaded. Extensions are loading into the active Python interpreter and may
26 # run arbitrary code
27 extension-pkg-whitelist=numpy, scipy
28
29 [MESSAGES CONTROL]
30
31 # Enable the message, report, category or checker with the given id(s). You can
32 # either give multiple identifier separated by comma (,) or put this option
33 # multiple time. See also the "--disable" option for examples.
34 #enable=
35
36 # Disable the message, report, category or checker with the given id(s). You
37 # can either give multiple identifiers separated by comma (,) or put this
38 # option multiple times (only on the command line, not in the configuration
39 # file where it should appear only once).You can also use "--disable=all" to
40 # disable everything first and then reenable specific checks. For example, if
41 # you want to run only the similarities checker, you can use "--disable=all
42 # --enable=similarities". If you want to run only the classes checker, but have
43 # no Warning level messages displayed, use"--disable=all --enable=classes
44 # --disable=W"
45 disable=redefined-variable-type, locally-disabled, locally-enabled
46
47
48 [REPORTS]
49
50 # Set the output format. Available formats are text, parseable, colorized, msvs
51 # (visual studio) and html. You can also give a reporter class, eg
52 # mypackage.mymodule.MyReporterClass.
53 output-format=parseable
54
55 # Put messages in a separate file for each module / package specified on the
56 # command line instead of printing them on stdout. Reports (if any) will be
57 # written in a file name "pylint_global.[txt|html]".
58 files-output=no
59
60 # Tells whether to display a full report or only the messages
61 reports=yes
62
63 # Python expression which should return a note less than 10 (10 is the highest
64 # note). You have access to the variables errors warning, statement which
65 # respectively contain the number of errors / warnings messages and the total
66 # number of statements analyzed. This is used by the global evaluation report
67 # (RP0004).
68 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
69
70 # Add a comment according to your evaluation note. This is used by the global
71 # evaluation report (RP0004).
72 comment=no
73
74 # Template used to display messages. This is a python new-style format string
75 # used to format the message information. See doc for all details
76 #msg-template=
77
78
79 [FORMAT]
80
81 # Maximum number of characters on a single line.
82 max-line-length=80
83
84 # Regexp for a line that is allowed to be longer than the limit.
85 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
86
87 # Allow the body of an if to be on the same line as the test if there is no
88 # else.
89 single-line-if-stmt=no
90
91 # List of optional constructs for which whitespace checking is disabled
92 no-space-check=trailing-comma,dict-separator
93
94 # Maximum number of lines in a module
95 max-module-lines=2000
96
97 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
98 # tab).
99 indent-string='    '
100
101
102 [VARIABLES]
103
104 # Tells whether we should check for unused import in __init__ files.
105 init-import=no
106
107 # A regular expression matching the beginning of the name of dummy variables
108 # (i.e. not used).
109 dummy-variables-rgx=_$|dummy
110
111 # List of additional names supposed to be defined in builtins. Remember that
112 # you should avoid to define new builtins when possible.
113 additional-builtins=
114
115
116 [SIMILARITIES]
117
118 # Minimum lines number of a similarity.
119 min-similarity-lines=14
120
121 # Ignore comments when computing similarities.
122 ignore-comments=yes
123
124 # Ignore docstrings when computing similarities.
125 ignore-docstrings=no
126
127 # Ignore imports when computing similarities.
128 ignore-imports=no
129
130
131 [BASIC]
132
133 # Required attributes for module, separated by a comma
134 required-attributes=
135
136 # List of builtins function names that should not be used, separated by a comma
137 bad-functions=map,filter,apply,input
138
139 # Regular expression which should only match correct module names
140 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
141
142 # Regular expression which should only match correct module level names
143 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
144
145 # Regular expression which should only match correct class names
146 class-rgx=[A-Z_][a-zA-Z0-9]+$
147
148 # Regular expression which should only match correct function names
149 function-rgx=[a-z_][a-z0-9_]{2,30}$
150
151 # Regular expression which should only match correct method names
152 method-rgx=[a-z_][a-z0-9_]{2,50}$
153
154 # Regular expression which should only match correct instance attribute names
155 attr-rgx=[a-z_][a-z0-9_]{2,30}$
156
157 # Regular expression which should only match correct argument names
158 argument-rgx=[a-z_][a-z0-9_]{2,30}$
159
160 # Regular expression which should only match correct variable names
161 variable-rgx=[a-z_][a-z0-9_]{2,30}$
162
163 # Regular expression which should only match correct attribute names in class
164 # bodies
165 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
166
167 # Regular expression which should only match correct list comprehension /
168 # generator expression variable names
169 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
170
171 # Good variable names which should always be accepted, separated by a comma
172 good-names=i,j,k,ex,Run,_
173
174 # Bad variable names which should always be refused, separated by a comma
175 bad-names=foo,bar,baz,toto,tutu,tata
176
177 # Regular expression which should only match function or class names that do
178 # not require a docstring.
179 no-docstring-rgx=__.*__
180
181 # Minimum line length for functions/classes that require docstrings, shorter
182 # ones are exempt.
183 docstring-min-length=-1
184
185
186 [MISCELLANEOUS]
187
188 # List of note tags to take in consideration, separated by a comma.
189 notes=FIXME
190
191
192 [TYPECHECK]
193
194 # Tells whether missing members accessed in mixin class should be ignored. A
195 # mixin class is detected if its name ends with "mixin" (case insensitive).
196 ignore-mixin-members=yes
197
198 # List of classes names for which member attributes should not be checked
199 # (useful for classes with attributes dynamically set).
200 ignored-classes=SQLObject
201
202 # When zope mode is activated, add a predefined set of Zope acquired attributes
203 # to generated-members.
204 zope=no
205
206 # List of members which are set dynamically and missed by pylint inference
207 # system, and so shouldn't trigger E0201 when accessed. Python regular
208 # expressions are accepted.
209 generated-members=REQUEST,acl_users,aq_parent
210
211
212 [CLASSES]
213
214 # List of interface methods to ignore, separated by a comma. This is used for
215 # instance to not check methods defines in Zope's Interface base class.
216 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
217
218 # List of method names used to declare (i.e. assign) instance attributes.
219 defining-attr-methods=__init__,__new__,setUp
220
221 # List of valid names for the first argument in a class method.
222 valid-classmethod-first-arg=cls
223
224 # List of valid names for the first argument in a metaclass class method.
225 valid-metaclass-classmethod-first-arg=mcs
226
227
228 [IMPORTS]
229
230 # Deprecated modules which should not be used, separated by a comma
231 deprecated-modules=regsub,TERMIOS,Bastion,rexec
232
233 # Create a graph of every (i.e. internal and external) dependencies in the
234 # given file (report RP0402 must not be disabled)
235 import-graph=
236
237 # Create a graph of external dependencies in the given file (report RP0402 must
238 # not be disabled)
239 ext-import-graph=
240
241 # Create a graph of internal dependencies in the given file (report RP0402 must
242 # not be disabled)
243 int-import-graph=
244
245
246 [DESIGN]
247
248 # Maximum number of arguments for function / method
249 max-args=12
250
251 # Argument names that match this expression will be ignored. Default to name
252 # with leading underscore
253 ignored-argument-names=_.*
254
255 # Maximum number of locals for function / method body
256 max-locals=20
257
258 # Maximum number of return / yield for function / method body
259 max-returns=6
260
261 # Maximum number of branch for function / method body
262 max-branches=20
263
264 # Maximum number of statements in function / method body
265 max-statements=60
266
267 # Maximum number of parents for a class (see R0901).
268 max-parents=7
269
270 # Maximum number of attributes for a class (see R0902).
271 max-attributes=10
272
273 # Minimum number of public methods for a class (see R0903).
274 min-public-methods=0
275
276 # Maximum number of public methods for a class (see R0904).
277 max-public-methods=60
278
279
280 [EXCEPTIONS]
281
282 # Exceptions that will emit a warning when being caught. Defaults to
283 # "Exception"
284 overgeneral-exceptions=Exception