dev: format code using "garden fmt" (black)
[git-cola.git] / .pylintrc
blobda59e6cc34519c3999b4e52c2693994e4d8e756c
1 [MASTER]
3 # Specify what version of Python to evaluate code against.
4 py-version = 3.6
6 # Specify a configuration file.
7 #rcfile=
9 # Python code to execute, usually for sys.path manipulation such as
10 # pygtk.require().
11 #init-hook=
13 # Add files or directories to the blacklist. They should be base names, not
14 # paths.
15 ignore=.git,qtpy,sphinxtogithub
17 # Pickle collected data for later comparisons.
18 persistent=yes
20 # List of plugins (as comma separated values of python modules names) to load,
21 # usually to register additional checkers.
22 load-plugins=
24 # Use multiple processes to speed up Pylint.
25 jobs=4
27 # Allow loading of arbitrary C extensions. Extensions are imported into the
28 # active Python interpreter and may run arbitrary code.
29 unsafe-load-any-extension=no
31 # A comma-separated list of package or module names from where C extensions may
32 # be loaded. Extensions are loading into the active Python interpreter and may
33 # run arbitrary code
34 extension-pkg-whitelist=binascii,math,PyQt4,PyQt5,PyQt6,PySide,PySide2,select,struct,struct.pack,struct.unpack
36 [MESSAGES CONTROL]
38 # Only show warnings with the listed confidence levels. Leave empty to show
39 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
40 confidence=
42 # Enable the message, report, category or checker with the given id(s). You can
43 # either give multiple identifier separated by comma (,) or put this option
44 # multiple time. See also the "--disable" option for examples.
45 #enable=
47 # Disable the message, report, category or checker with the given id(s). You
48 # can either give multiple identifiers separated by comma (,) or put this
49 # option multiple times (only on the command line, not in the configuration
50 # file where it should appear only once).You can also use "--disable=all" to
51 # disable everything first and then reenable specific checks. For example, if
52 # you want to run only the similarities checker, you can use "--disable=all
53 # --enable=similarities". If you want to run only the classes checker, but have
54 # no Warning level messages displayed, use"--disable=all --enable=classes
55 # --disable=W"
56 disable=
57     bad-option-value,
58     consider-using-f-string,
59     duplicate-code,
60     invalid-name,
61     missing-docstring,
62     no-self-use,
63     raise-missing-from,
64     super-with-arguments,
65     too-many-instance-attributes,
66     useless-object-inheritance,
67     useless-option-value,
69 [REPORTS]
71 # Set the output format. Available formats are text, parseable, colorized, msvs
72 # (visual studio) and html. You can also give a reporter class, eg
73 # mypackage.mymodule.MyReporterClass.
74 output-format=text
76 # Tells whether to display a full report or only the messages
77 reports=no
79 # Python expression which should return a note less than 10 (10 is the highest
80 # note). You have access to the variables errors warning, statement which
81 # respectively contain the number of errors / warnings messages and the total
82 # number of statements analyzed. This is used by the global evaluation report
83 # (RP0004).
84 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
86 # Template used to display messages. This is a python new-style format string
87 # used to format the message information. See doc for all details
88 msg-template={path}:{line}:{column}: {msg} ({symbol})
91 [BASIC]
93 # Good variable names which should always be accepted, separated by a comma
94 good-names=f,i,j,k,ok,v,_
96 # Bad variable names which should always be refused, separated by a comma
97 bad-names=
99 # Colon-delimited sets of names that determine each other's naming style when
100 # the name regexes allow several styles.
101 name-group=
103 # Include a hint for the correct naming format with invalid-name
104 include-naming-hint=yes
106 # Regular expression matching correct function names
107 function-rgx=[a-z_][a-z0-9_]{2,30}$
109 # Regular expression matching correct variable names
110 variable-rgx=[a-z_][a-z0-9_]{2,30}$
112 # Regular expression matching correct constant names
113 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
115 # Regular expression matching correct attribute names
116 attr-rgx=[a-z_][a-z0-9_]{2,30}$
118 # Regular expression matching correct argument names
119 argument-rgx=[a-z_][a-z0-9_]{2,30}$
121 # Regular expression matching correct class attribute names
122 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
124 # Regular expression matching correct inline iteration names
125 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
127 # Regular expression matching correct class names
128 class-rgx=[A-Z_][a-zA-Z0-9]+$
130 # Regular expression matching correct module names
131 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
133 # Regular expression matching correct method names
134 method-rgx=[a-z_][a-z0-9_]{2,30}$
136 # Regular expression which should only match function or class names that do
137 # not require a docstring.
138 no-docstring-rgx=__.*__
140 # Minimum line length for functions/classes that require docstrings, shorter
141 # ones are exempt.
142 docstring-min-length=-1
145 [MISCELLANEOUS]
147 # List of note tags to take in consideration, separated by a comma.
148 notes=FIXME,XXX,TODO
151 [FORMAT]
153 # Maximum number of characters on a single line.
154 max-line-length=88
156 # Regexp for a line that is allowed to be longer than the limit.
157 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
159 # Allow the body of an if to be on the same line as the test if there is no
160 # else.
161 single-line-if-stmt=no
163 # Maximum number of lines in a module
164 max-module-lines=3000
166 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
167 # tab).
168 indent-string='    '
170 # Number of spaces of indent required inside a hanging or continued line.
171 indent-after-paren=4
173 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
174 expected-line-ending-format=LF
177 [TYPECHECK]
179 # Tells whether missing members accessed in mixin class should be ignored. A
180 # mixin class is detected if its name ends with "mixin" (case insensitive).
181 ignore-mixin-members=yes
183 # List of module names for which member attributes should not be checked
184 # (useful for modules/projects where namespaces are manipulated during runtime
185 # and thus existing member attributes cannot be deduced by static analysis
186 ignored-modules=
188 # List of classes names for which member attributes should not be checked
189 # (useful for classes with attributes dynamically set).
190 ignored-classes=
192 # List of members which are set dynamically and missed by pylint inference
193 # system, and so shouldn't trigger E0201 when accessed. Python regular
194 # expressions are accepted.
195 generated-members=
198 [SIMILARITIES]
200 # Minimum lines number of a similarity.
201 min-similarity-lines=4
203 # Ignore comments when computing similarities.
204 ignore-comments=yes
206 # Ignore docstrings when computing similarities.
207 ignore-docstrings=yes
209 # Ignore imports when computing similarities.
210 ignore-imports=no
213 [SPELLING]
215 # Spelling dictionary name. Available dictionaries: none. To make it working
216 # install python-enchant package.
217 spelling-dict=
219 # List of comma separated words that should not be checked.
220 spelling-ignore-words=
222 # A path to a file that contains private dictionary; one word per line.
223 spelling-private-dict-file=
225 # Tells whether to store unknown words to indicated private dictionary in
226 # --spelling-private-dict-file option instead of raising a message.
227 spelling-store-unknown-words=no
230 [LOGGING]
232 # Logging modules to check that the string format arguments are in logging
233 # function parameter format
234 logging-modules=logging
237 [VARIABLES]
239 # Tells whether we should check for unused import in __init__ files.
240 init-import=no
242 # A regular expression matching the name of dummy variables (i.e. expectedly
243 # not used).
244 dummy-variables-rgx=_$|dummy
246 # List of additional names supposed to be defined in builtins. Remember that
247 # you should avoid to define new builtins when possible.
248 additional-builtins=
250 # List of strings which can identify a callback function by name. A callback
251 # name must start or end with one of those strings.
252 callbacks=cb_,_cb
255 [CLASSES]
257 # List of method names used to declare (i.e. assign) instance attributes.
258 defining-attr-methods=__init__,__new__,setUp
260 # List of valid names for the first argument in a class method.
261 valid-classmethod-first-arg=cls
263 # List of valid names for the first argument in a metaclass class method.
264 valid-metaclass-classmethod-first-arg=mcs
266 # List of member names, which should be excluded from the protected access
267 # warning.
268 exclude-protected=_asdict,_fields,_replace,_source,_make
271 [DESIGN]
273 # Maximum number of arguments for function / method
274 max-args=12
276 # Argument names that match this expression will be ignored. Default to name
277 # with leading underscore
278 ignored-argument-names=_.*
280 # Maximum number of locals for function / method body
281 max-locals=32
283 # Maximum number of return / yield for function / method body
284 max-returns=6
286 # Maximum number of branch for function / method body
287 max-branches=24
289 # Maximum number of statements in function / method body
290 max-statements=300
292 # Maximum number of parents for a class (see R0901).
293 max-parents=10
295 # Maximum number of attributes for a class (see R0902).
296 max-attributes=7
298 # Minimum number of public methods for a class (see R0903).
299 min-public-methods=0
301 # Maximum number of public methods for a class (see R0904).
302 max-public-methods=40
305 [IMPORTS]
307 # Deprecated modules which should not be used, separated by a comma
308 deprecated-modules=
310 # Create a graph of every (i.e. internal and external) dependencies in the
311 # given file (report RP0402 must not be disabled)
312 import-graph=
314 # Create a graph of external dependencies in the given file (report RP0402 must
315 # not be disabled)
316 ext-import-graph=
318 # Create a graph of internal dependencies in the given file (report RP0402 must
319 # not be disabled)
320 int-import-graph=