blob: 934f30be5cca7fd5175fd8f86ee2661a14b631c2 [file] [log] [blame]
Mohammad Azim Khan21798102018-07-06 00:41:08 +01001[MASTER]
2
3# A comma-separated list of package or module names from where C extensions may
4# be loaded. Extensions are loading into the active Python interpreter and may
5# run arbitrary code
6extension-pkg-whitelist=
7
8# Add files or directories to the blacklist. They should be base names, not
9# paths.
10ignore=CVS
11
12# Add files or directories matching the regex patterns to the blacklist. The
13# regex matches against base names, not paths.
14ignore-patterns=
15
16# Python code to execute, usually for sys.path manipulation such as
17# pygtk.require().
18#init-hook=
19
20# Use multiple processes to speed up Pylint.
21jobs=1
22
23# List of plugins (as comma separated values of python modules names) to load,
24# usually to register additional checkers.
25load-plugins=
26
27# Pickle collected data for later comparisons.
28persistent=yes
29
30# Specify a configuration file.
31#rcfile=
32
33# Allow loading of arbitrary C extensions. Extensions are imported into the
34# active Python interpreter and may run arbitrary code.
35unsafe-load-any-extension=no
36
37
38[MESSAGES CONTROL]
39
40# Only show warnings with the listed confidence levels. Leave empty to show
41# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
42confidence=
43
44# Disable the message, report, category or checker with the given id(s). You
45# can either give multiple identifiers separated by comma (,) or put this
46# option multiple times (only on the command line, not in the configuration
47# file where it should appear only once).You can also use "--disable=all" to
48# disable everything first and then reenable specific checks. For example, if
49# you want to run only the similarities checker, you can use "--disable=all
50# --enable=similarities". If you want to run only the classes checker, but have
51# no Warning level messages displayed, use"--disable=all --enable=classes
52# --disable=W"
53disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
54
55# Enable the message, report, category or checker with the given id(s). You can
56# either give multiple identifier separated by comma (,) or put this option
57# multiple time (only on the command line, not in the configuration file where
58# it should appear only once). See also the "--disable" option for examples.
59enable=
60
61
62[REPORTS]
63
64# Python expression which should return a note less than 10 (10 is the highest
65# note). You have access to the variables errors warning, statement which
66# respectively contain the number of errors / warnings messages and the total
67# number of statements analyzed. This is used by the global evaluation report
68# (RP0004).
69evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
70
71# Template used to display messages. This is a python new-style format string
72# used to format the message information. See doc for all details
73#msg-template=
74
75# Set the output format. Available formats are text, parseable, colorized, json
76# and msvs (visual studio).You can also give a reporter class, eg
77# mypackage.mymodule.MyReporterClass.
78output-format=text
79
80# Tells whether to display a full report or only the messages
81reports=no
82
83# Activate the evaluation score.
84score=yes
85
86
87[REFACTORING]
88
89# Maximum number of nested blocks for function / method body
90max-nested-blocks=5
91
92
93[SIMILARITIES]
94
95# Ignore comments when computing similarities.
96ignore-comments=yes
97
98# Ignore docstrings when computing similarities.
99ignore-docstrings=yes
100
101# Ignore imports when computing similarities.
102ignore-imports=no
103
104# Minimum lines number of a similarity.
105min-similarity-lines=4
106
107
108[FORMAT]
109
110# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
111expected-line-ending-format=
112
113# Regexp for a line that is allowed to be longer than the limit.
114ignore-long-lines=^\s*(# )?<?https?://\S+>?$
115
116# Number of spaces of indent required inside a hanging or continued line.
117indent-after-paren=4
118
119# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
120# tab).
121indent-string=' '
122
123# Maximum number of characters on a single line.
124max-line-length=79
125
126# Maximum number of lines in a module
127max-module-lines=2000
128
129# List of optional constructs for which whitespace checking is disabled. `dict-
130# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
131# `trailing-comma` allows a space between comma and closing bracket: (a, ).
132# `empty-line` allows space-only lines.
133no-space-check=trailing-comma,dict-separator
134
135# Allow the body of a class to be on the same line as the declaration if body
136# contains single statement.
137single-line-class-stmt=no
138
139# Allow the body of an if to be on the same line as the test if there is no
140# else.
141single-line-if-stmt=no
142
143
144[BASIC]
145
146# Naming hint for argument names
147argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
148
149# Regular expression matching correct argument names
150argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
151
152# Naming hint for attribute names
153attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
154
155# Regular expression matching correct attribute names
156attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
157
158# Bad variable names which should always be refused, separated by a comma
159bad-names=foo,bar,baz,toto,tutu,tata
160
161# Naming hint for class attribute names
162class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
163
164# Regular expression matching correct class attribute names
165class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
166
167# Naming hint for class names
168class-name-hint=[A-Z_][a-zA-Z0-9]+$
169
170# Regular expression matching correct class names
171class-rgx=[A-Z_][a-zA-Z0-9]+$
172
173# Naming hint for constant names
174const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
175
176# Regular expression matching correct constant names
177const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
178
179# Minimum line length for functions/classes that require docstrings, shorter
180# ones are exempt.
181docstring-min-length=-1
182
183# Naming hint for function names
184function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
185
186# Regular expression matching correct function names
187function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
188
189# Good variable names which should always be accepted, separated by a comma
190good-names=i,j,k,ex,Run,_
191
192# Include a hint for the correct naming format with invalid-name
193include-naming-hint=no
194
195# Naming hint for inline iteration names
196inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
197
198# Regular expression matching correct inline iteration names
199inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
200
201# Naming hint for method names
202method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
203
204# Regular expression matching correct method names
205method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
206
207# Naming hint for module names
208module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
209
210# Regular expression matching correct module names
211module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
212
213# Colon-delimited sets of names that determine each other's naming style when
214# the name regexes allow several styles.
215name-group=
216
217# Regular expression which should only match function or class names that do
218# not require a docstring.
219no-docstring-rgx=^_
220
221# List of decorators that produce properties, such as abc.abstractproperty. Add
222# to this list to register other decorators that produce valid properties.
223property-classes=abc.abstractproperty
224
225# Naming hint for variable names
226variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
227
228# Regular expression matching correct variable names
229variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
230
231
232[TYPECHECK]
233
234# List of decorators that produce context managers, such as
235# contextlib.contextmanager. Add to this list to register other decorators that
236# produce valid context managers.
237contextmanager-decorators=contextlib.contextmanager
238
239# List of members which are set dynamically and missed by pylint inference
240# system, and so shouldn't trigger E1101 when accessed. Python regular
241# expressions are accepted.
242generated-members=
243
244# Tells whether missing members accessed in mixin class should be ignored. A
245# mixin class is detected if its name ends with "mixin" (case insensitive).
246ignore-mixin-members=yes
247
248# This flag controls whether pylint should warn about no-member and similar
249# checks whenever an opaque object is returned when inferring. The inference
250# can return multiple potential results while evaluating a Python object, but
251# some branches might not be evaluated, which results in partial inference. In
252# that case, it might be useful to still emit no-member and other checks for
253# the rest of the inferred objects.
254ignore-on-opaque-inference=yes
255
256# List of class names for which member attributes should not be checked (useful
257# for classes with dynamically set attributes). This supports the use of
258# qualified names.
259ignored-classes=optparse.Values,thread._local,_thread._local
260
261# List of module names for which member attributes should not be checked
262# (useful for modules/projects where namespaces are manipulated during runtime
263# and thus existing member attributes cannot be deduced by static analysis. It
264# supports qualified module names, as well as Unix pattern matching.
265ignored-modules=
266
267# Show a hint with possible names when a member name was not found. The aspect
268# of finding the hint is based on edit distance.
269missing-member-hint=yes
270
271# The minimum edit distance a name should have in order to be considered a
272# similar match for a missing member name.
273missing-member-hint-distance=1
274
275# The total number of similar names that should be taken in consideration when
276# showing a hint for a missing member.
277missing-member-max-choices=1
278
279
280[VARIABLES]
281
282# List of additional names supposed to be defined in builtins. Remember that
283# you should avoid to define new builtins when possible.
284additional-builtins=
285
286# Tells whether unused global variables should be treated as a violation.
287allow-global-unused-variables=yes
288
289# List of strings which can identify a callback function by name. A callback
290# name must start or end with one of those strings.
291callbacks=cb_,_cb
292
293# A regular expression matching the name of dummy variables (i.e. expectedly
294# not used).
295dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
296
297# Argument names that match this expression will be ignored. Default to name
298# with leading underscore
299ignored-argument-names=_.*|^ignored_|^unused_
300
301# Tells whether we should check for unused import in __init__ files.
302init-import=no
303
304# List of qualified module names which can have objects that can redefine
305# builtins.
306redefining-builtins-modules=six.moves,future.builtins
307
308
309[SPELLING]
310
311# Spelling dictionary name. Available dictionaries: none. To make it working
312# install python-enchant package.
313spelling-dict=
314
315# List of comma separated words that should not be checked.
316spelling-ignore-words=
317
318# A path to a file that contains private dictionary; one word per line.
319spelling-private-dict-file=
320
321# Tells whether to store unknown words to indicated private dictionary in
322# --spelling-private-dict-file option instead of raising a message.
323spelling-store-unknown-words=no
324
325
326[MISCELLANEOUS]
327
328# List of note tags to take in consideration, separated by a comma.
329notes=FIXME,XXX,TODO
330
331
332[LOGGING]
333
334# Logging modules to check that the string format arguments are in logging
335# function parameter format
336logging-modules=logging
337
338
339[CLASSES]
340
341# List of method names used to declare (i.e. assign) instance attributes.
342defining-attr-methods=__init__,__new__,setUp
343
344# List of member names, which should be excluded from the protected access
345# warning.
346exclude-protected=_asdict,_fields,_replace,_source,_make
347
348# List of valid names for the first argument in a class method.
349valid-classmethod-first-arg=cls
350
351# List of valid names for the first argument in a metaclass class method.
352valid-metaclass-classmethod-first-arg=mcs
353
354
355[DESIGN]
356
357# Maximum number of arguments for function / method
358max-args=5
359
360# Maximum number of attributes for a class (see R0902).
361max-attributes=7
362
363# Maximum number of boolean expressions in a if statement
364max-bool-expr=5
365
366# Maximum number of branch for function / method body
367max-branches=12
368
369# Maximum number of locals for function / method body
370max-locals=15
371
372# Maximum number of parents for a class (see R0901).
373max-parents=7
374
375# Maximum number of public methods for a class (see R0904).
376max-public-methods=20
377
378# Maximum number of return / yield for function / method body
379max-returns=6
380
381# Maximum number of statements in function / method body
382max-statements=50
383
384# Minimum number of public methods for a class (see R0903).
385min-public-methods=2
386
387
388[IMPORTS]
389
390# Allow wildcard imports from modules that define __all__.
391allow-wildcard-with-all=no
392
393# Analyse import fallback blocks. This can be used to support both Python 2 and
394# 3 compatible code, which means that the block might have code that exists
395# only in one or another interpreter, leading to false positives when analysed.
396analyse-fallback-blocks=no
397
398# Deprecated modules which should not be used, separated by a comma
399deprecated-modules=regsub,TERMIOS,Bastion,rexec
400
401# Create a graph of external dependencies in the given file (report RP0402 must
402# not be disabled)
403ext-import-graph=
404
405# Create a graph of every (i.e. internal and external) dependencies in the
406# given file (report RP0402 must not be disabled)
407import-graph=
408
409# Create a graph of internal dependencies in the given file (report RP0402 must
410# not be disabled)
411int-import-graph=
412
413# Force import order to recognize a module as part of the standard
414# compatibility libraries.
415known-standard-library=
416
417# Force import order to recognize a module as part of a third party library.
418known-third-party=enchant
419
420
421[EXCEPTIONS]
422
423# Exceptions that will emit a warning when being caught. Defaults to
424# "Exception"
425overgeneral-exceptions=Exception