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