search: prepare for PyQt5
[git-cola.git] / .pylintrc
blobe19bff7ba8a85984bfc4f94ac0d3f0066cbd60b6
1 [MASTER]
3 # Specify a configuration file.
4 #rcfile=
6 # Python code to execute, usually for sys.path manipulation such as
7 # pygtk.require().
8 #init-hook=
10 # Add files or directories to the blacklist. They should be base names, not
11 # paths.
12 ignore=.git
14 # Pickle collected data for later comparisons.
15 persistent=yes
17 # List of plugins (as comma separated values of python modules names) to load,
18 # usually to register additional checkers.
19 load-plugins=
21 # Use multiple processes to speed up Pylint.
22 jobs=1
24 # Allow loading of arbitrary C extensions. Extensions are imported into the
25 # active Python interpreter and may run arbitrary code.
26 unsafe-load-any-extension=no
28 # A comma-separated list of package or module names from where C extensions may
29 # be loaded. Extensions are loading into the active Python interpreter and may
30 # run arbitrary code
31 extension-pkg-whitelist=
33 # Allow optimization of some AST trees. This will activate a peephole AST
34 # optimizer, which will apply various small optimizations. For instance, it can
35 # be used to obtain the result of joining multiple strings with the addition
36 # operator. Joining a lot of strings can lead to a maximum recursion error in
37 # Pylint and this flag can prevent that. It has one side effect, the resulting
38 # AST will be different than the one from reality.
39 optimize-ast=no
42 [MESSAGES CONTROL]
44 # Only show warnings with the listed confidence levels. Leave empty to show
45 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
46 confidence=
48 # Enable the message, report, category or checker with the given id(s). You can
49 # either give multiple identifier separated by comma (,) or put this option
50 # multiple time. See also the "--disable" option for examples.
51 #enable=
53 # Disable the message, report, category or checker with the given id(s). You
54 # can either give multiple identifiers separated by comma (,) or put this
55 # option multiple times (only on the command line, not in the configuration
56 # file where it should appear only once).You can also use "--disable=all" to
57 # disable everything first and then reenable specific checks. For example, if
58 # you want to run only the similarities checker, you can use "--disable=all
59 # --enable=similarities". If you want to run only the classes checker, but have
60 # no Warning level messages displayed, use"--disable=all --enable=classes
61 # --disable=W"
62 disable=E1608,W1627,E1601,E1603,E1602,E1605,E1604,E1607,E1606,W1621,W1620,W1623,W1622,W1625,W1624,W1609,W1608,W1607,W1606,W1605,W1604,W1603,W1602,W1601,W1639,W1640,I0021,W1638,I0020,W1618,W1619,W1630,W1626,W1637,W1634,W1635,W1610,W1611,W1612,W1613,W1614,W1615,W1616,W1617,W1632,W1633,W0704,W1628,W1629,W1636
65 [REPORTS]
67 # Set the output format. Available formats are text, parseable, colorized, msvs
68 # (visual studio) and html. You can also give a reporter class, eg
69 # mypackage.mymodule.MyReporterClass.
70 output-format=text
72 # Put messages in a separate file for each module / package specified on the
73 # command line instead of printing them on stdout. Reports (if any) will be
74 # written in a file name "pylint_global.[txt|html]".
75 files-output=no
77 # Tells whether to display a full report or only the messages
78 reports=yes
80 # Python expression which should return a note less than 10 (10 is the highest
81 # note). You have access to the variables errors warning, statement which
82 # respectively contain the number of errors / warnings messages and the total
83 # number of statements analyzed. This is used by the global evaluation report
84 # (RP0004).
85 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
87 # Template used to display messages. This is a python new-style format string
88 # used to format the message information. See doc for all details
89 #msg-template=
92 [BASIC]
94 # List of builtins function names that should not be used, separated by a comma
95 bad-functions=map,filter,input
97 # Good variable names which should always be accepted, separated by a comma
98 good-names=i,j,k,ex,Run,_
100 # Bad variable names which should always be refused, separated by a comma
101 bad-names=foo,bar,baz,toto,tutu,tata
103 # Colon-delimited sets of names that determine each other's naming style when
104 # the name regexes allow several styles.
105 name-group=
107 # Include a hint for the correct naming format with invalid-name
108 include-naming-hint=yes
110 # Regular expression matching correct function names
111 function-rgx=[a-z_][a-z0-9_]{2,30}$
113 # Naming hint for function names
114 function-name-hint=[a-z_][a-z0-9_]{2,30}$
116 # Regular expression matching correct variable names
117 variable-rgx=[a-z_][a-z0-9_]{2,30}$
119 # Naming hint for variable names
120 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
122 # Regular expression matching correct constant names
123 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
125 # Naming hint for constant names
126 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
128 # Regular expression matching correct attribute names
129 attr-rgx=[a-z_][a-z0-9_]{2,30}$
131 # Naming hint for attribute names
132 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
134 # Regular expression matching correct argument names
135 argument-rgx=[a-z_][a-z0-9_]{2,30}$
137 # Naming hint for argument names
138 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
140 # Regular expression matching correct class attribute names
141 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
143 # Naming hint for class attribute names
144 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
146 # Regular expression matching correct inline iteration names
147 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
149 # Naming hint for inline iteration names
150 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
152 # Regular expression matching correct class names
153 class-rgx=[A-Z_][a-zA-Z0-9]+$
155 # Naming hint for class names
156 class-name-hint=[A-Z_][a-zA-Z0-9]+$
158 # Regular expression matching correct module names
159 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
161 # Naming hint for module names
162 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
164 # Regular expression matching correct method names
165 method-rgx=[a-z_][a-z0-9_]{2,30}$
167 # Naming hint for method names
168 method-name-hint=[a-z_][a-z0-9_]{2,30}$
170 # Regular expression which should only match function or class names that do
171 # not require a docstring.
172 no-docstring-rgx=__.*__
174 # Minimum line length for functions/classes that require docstrings, shorter
175 # ones are exempt.
176 docstring-min-length=-1
179 [MISCELLANEOUS]
181 # List of note tags to take in consideration, separated by a comma.
182 notes=FIXME,XXX,TODO
185 [FORMAT]
187 # Maximum number of characters on a single line.
188 max-line-length=80
190 # Regexp for a line that is allowed to be longer than the limit.
191 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
193 # Allow the body of an if to be on the same line as the test if there is no
194 # else.
195 single-line-if-stmt=no
197 # List of optional constructs for which whitespace checking is disabled
198 no-space-check=trailing-comma,dict-separator
200 # Maximum number of lines in a module
201 max-module-lines=1000
203 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
204 # tab).
205 indent-string='    '
207 # Number of spaces of indent required inside a hanging or continued line.
208 indent-after-paren=4
210 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
211 expected-line-ending-format=LF
214 [TYPECHECK]
216 # Tells whether missing members accessed in mixin class should be ignored. A
217 # mixin class is detected if its name ends with "mixin" (case insensitive).
218 ignore-mixin-members=yes
220 # List of module names for which member attributes should not be checked
221 # (useful for modules/projects where namespaces are manipulated during runtime
222 # and thus existing member attributes cannot be deduced by static analysis
223 ignored-modules=
225 # List of classes names for which member attributes should not be checked
226 # (useful for classes with attributes dynamically set).
227 ignored-classes=SQLObject
229 # List of members which are set dynamically and missed by pylint inference
230 # system, and so shouldn't trigger E0201 when accessed. Python regular
231 # expressions are accepted.
232 generated-members=REQUEST,acl_users,aq_parent
235 [SIMILARITIES]
237 # Minimum lines number of a similarity.
238 min-similarity-lines=4
240 # Ignore comments when computing similarities.
241 ignore-comments=yes
243 # Ignore docstrings when computing similarities.
244 ignore-docstrings=yes
246 # Ignore imports when computing similarities.
247 ignore-imports=no
250 [SPELLING]
252 # Spelling dictionary name. Available dictionaries: none. To make it working
253 # install python-enchant package.
254 spelling-dict=
256 # List of comma separated words that should not be checked.
257 spelling-ignore-words=
259 # A path to a file that contains private dictionary; one word per line.
260 spelling-private-dict-file=
262 # Tells whether to store unknown words to indicated private dictionary in
263 # --spelling-private-dict-file option instead of raising a message.
264 spelling-store-unknown-words=no
267 [LOGGING]
269 # Logging modules to check that the string format arguments are in logging
270 # function parameter format
271 logging-modules=logging
274 [VARIABLES]
276 # Tells whether we should check for unused import in __init__ files.
277 init-import=no
279 # A regular expression matching the name of dummy variables (i.e. expectedly
280 # not used).
281 dummy-variables-rgx=_$|dummy
283 # List of additional names supposed to be defined in builtins. Remember that
284 # you should avoid to define new builtins when possible.
285 additional-builtins=
287 # List of strings which can identify a callback function by name. A callback
288 # name must start or end with one of those strings.
289 callbacks=cb_,_cb
292 [CLASSES]
294 # List of method names used to declare (i.e. assign) instance attributes.
295 defining-attr-methods=__init__,__new__,setUp
297 # List of valid names for the first argument in a class method.
298 valid-classmethod-first-arg=cls
300 # List of valid names for the first argument in a metaclass class method.
301 valid-metaclass-classmethod-first-arg=mcs
303 # List of member names, which should be excluded from the protected access
304 # warning.
305 exclude-protected=_asdict,_fields,_replace,_source,_make
308 [DESIGN]
310 # Maximum number of arguments for function / method
311 max-args=5
313 # Argument names that match this expression will be ignored. Default to name
314 # with leading underscore
315 ignored-argument-names=_.*
317 # Maximum number of locals for function / method body
318 max-locals=15
320 # Maximum number of return / yield for function / method body
321 max-returns=6
323 # Maximum number of branch for function / method body
324 max-branches=12
326 # Maximum number of statements in function / method body
327 max-statements=50
329 # Maximum number of parents for a class (see R0901).
330 max-parents=7
332 # Maximum number of attributes for a class (see R0902).
333 max-attributes=7
335 # Minimum number of public methods for a class (see R0903).
336 min-public-methods=2
338 # Maximum number of public methods for a class (see R0904).
339 max-public-methods=20
342 [IMPORTS]
344 # Deprecated modules which should not be used, separated by a comma
345 deprecated-modules=regsub,TERMIOS,Bastion,rexec
347 # Create a graph of every (i.e. internal and external) dependencies in the
348 # given file (report RP0402 must not be disabled)
349 import-graph=
351 # Create a graph of external dependencies in the given file (report RP0402 must
352 # not be disabled)
353 ext-import-graph=
355 # Create a graph of internal dependencies in the given file (report RP0402 must
356 # not be disabled)
357 int-import-graph=
360 [EXCEPTIONS]
362 # Exceptions that will emit a warning when being caught. Defaults to
363 # "Exception"
364 overgeneral-exceptions=Exception