sequenceeditor.Editor: save (method) to helpers
[git-cola.git] / .pylintrc
blob46091ca390c6dfbb619ce2a590455be97a91b83d
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 ignore. They should be base names, not paths.
14 ignore=.git,qtpy,sphinxtogithub
16 # Pickle collected data for later comparisons.
17 persistent=yes
19 # List of plugins (as comma separated values of python modules names) to load,
20 # usually to register additional checkers.
21 load-plugins=
23 # Use multiple processes to speed up Pylint.
24 jobs=4
26 # Allow loading of arbitrary C extensions. Extensions are imported into the
27 # active Python interpreter and may run arbitrary code.
28 unsafe-load-any-extension=no
30 # A comma-separated list of package or module names from where C extensions may
31 # be loaded. Extensions are loading into the active Python interpreter and may
32 # run arbitrary code
33 extension-pkg-whitelist=binascii,math,PyQt4,PyQt5,PyQt6,PySide,PySide2,select,struct,struct.pack,struct.unpack
35 [MESSAGES CONTROL]
37 # Only show warnings with the listed confidence levels. Leave empty to show
38 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
39 confidence=
41 # Enable the message, report, category or checker with the given id(s). You can
42 # either give multiple identifier separated by comma (,) or put this option
43 # multiple time. See also the "--disable" option for examples.
44 #enable=
46 # Disable the message, report, category or checker with the given id(s). You
47 # can either give multiple identifiers separated by comma (,) or put this
48 # option multiple times (only on the command line, not in the configuration
49 # file where it should appear only once).You can also use "--disable=all" to
50 # disable everything first and then reenable specific checks. For example, if
51 # you want to run only the similarities checker, you can use "--disable=all
52 # --enable=similarities". If you want to run only the classes checker, but have
53 # no Warning level messages displayed, use"--disable=all --enable=classes
54 # --disable=W"
55 disable=
56     bad-option-value,
57     consider-using-f-string,
58     duplicate-code,
59     invalid-name,
60     missing-docstring,
61     no-self-use,
62     raise-missing-from,
63     super-with-arguments,
64     too-many-instance-attributes,
65     useless-object-inheritance,
66     useless-option-value,
68 [REPORTS]
70 # Set the output format. Available formats are text, parseable, colorized, msvs
71 # (visual studio) and html. You can also give a reporter class, eg
72 # mypackage.mymodule.MyReporterClass.
73 output-format=text
75 # Tells whether to display a full report or only the messages
76 reports=no
78 # Python expression which should return a note less than 10 (10 is the highest
79 # note). You have access to the variables errors warning, statement which
80 # respectively contain the number of errors / warnings messages and the total
81 # number of statements analyzed. This is used by the global evaluation report
82 # (RP0004).
83 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
85 # Template used to display messages. This is a python new-style format string
86 # used to format the message information. See doc for all details
87 msg-template={path}:{line}:{column}: {msg} ({symbol})
90 [BASIC]
92 # Good variable names which should always be accepted, separated by a comma
93 good-names=f,i,j,k,ok,v,_
95 # Bad variable names which should always be refused, separated by a comma
96 bad-names=
98 # Colon-delimited sets of names that determine each other's naming style when
99 # the name regexes allow several styles.
100 name-group=
102 # Include a hint for the correct naming format with invalid-name
103 include-naming-hint=yes
105 # Regular expression matching correct function names
106 function-rgx=[a-z_][a-z0-9_]{2,30}$
108 # Regular expression matching correct variable names
109 variable-rgx=[a-z_][a-z0-9_]{2,30}$
111 # Regular expression matching correct constant names
112 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
114 # Regular expression matching correct attribute names
115 attr-rgx=[a-z_][a-z0-9_]{2,30}$
117 # Regular expression matching correct argument names
118 argument-rgx=[a-z_][a-z0-9_]{2,30}$
120 # Regular expression matching correct class attribute names
121 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
123 # Regular expression matching correct inline iteration names
124 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
126 # Regular expression matching correct class names
127 class-rgx=[A-Z_][a-zA-Z0-9]+$
129 # Regular expression matching correct module names
130 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
132 # Regular expression matching correct method names
133 method-rgx=[a-z_][a-z0-9_]{2,30}$
135 # Regular expression which should only match function or class names that do
136 # not require a docstring.
137 no-docstring-rgx=__.*__
139 # Minimum line length for functions/classes that require docstrings, shorter
140 # ones are exempt.
141 docstring-min-length=-1
144 [MISCELLANEOUS]
146 # List of note tags to take in consideration, separated by a comma.
147 notes=FIXME,XXX,TODO
150 [FORMAT]
152 # Maximum number of characters on a single line.
153 max-line-length=88
155 # Regexp for a line that is allowed to be longer than the limit.
156 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
158 # Allow the body of an if to be on the same line as the test if there is no
159 # else.
160 single-line-if-stmt=no
162 # Maximum number of lines in a module
163 max-module-lines=3000
165 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
166 # tab).
167 indent-string='    '
169 # Number of spaces of indent required inside a hanging or continued line.
170 indent-after-paren=4
172 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
173 expected-line-ending-format=LF
176 [TYPECHECK]
178 # Tells whether missing members accessed in mixin class should be ignored. A
179 # mixin class is detected if its name ends with "mixin" (case insensitive).
180 ignore-mixin-members=yes
182 # List of module names for which member attributes should not be checked
183 # (useful for modules/projects where namespaces are manipulated during runtime
184 # and thus existing member attributes cannot be deduced by static analysis
185 ignored-modules=
187 # List of classes names for which member attributes should not be checked
188 # (useful for classes with attributes dynamically set).
189 ignored-classes=
191 # List of members which are set dynamically and missed by pylint inference
192 # system, and so shouldn't trigger E0201 when accessed. Python regular
193 # expressions are accepted.
194 generated-members=
197 [SIMILARITIES]
199 # Minimum lines number of a similarity.
200 min-similarity-lines=4
202 # Ignore comments when computing similarities.
203 ignore-comments=yes
205 # Ignore docstrings when computing similarities.
206 ignore-docstrings=yes
208 # Ignore imports when computing similarities.
209 ignore-imports=no
212 [SPELLING]
214 # Spelling dictionary name. Available dictionaries: none. To make it working
215 # install python-enchant package.
216 spelling-dict=
218 # List of comma separated words that should not be checked.
219 spelling-ignore-words=
221 # A path to a file that contains private dictionary; one word per line.
222 spelling-private-dict-file=
224 # Tells whether to store unknown words to indicated private dictionary in
225 # --spelling-private-dict-file option instead of raising a message.
226 spelling-store-unknown-words=no
229 [LOGGING]
231 # Logging modules to check that the string format arguments are in logging
232 # function parameter format
233 logging-modules=logging
236 [VARIABLES]
238 # Tells whether we should check for unused import in __init__ files.
239 init-import=no
241 # A regular expression matching the name of dummy variables (i.e. expectedly
242 # not used).
243 dummy-variables-rgx=_$|dummy
245 # List of additional names supposed to be defined in builtins. Remember that
246 # you should avoid to define new builtins when possible.
247 additional-builtins=
249 # List of strings which can identify a callback function by name. A callback
250 # name must start or end with one of those strings.
251 callbacks=cb_,_cb
254 [CLASSES]
256 # List of method names used to declare (i.e. assign) instance attributes.
257 defining-attr-methods=__init__,__new__,setUp
259 # List of valid names for the first argument in a class method.
260 valid-classmethod-first-arg=cls
262 # List of valid names for the first argument in a metaclass class method.
263 valid-metaclass-classmethod-first-arg=mcs
265 # List of member names, which should be excluded from the protected access
266 # warning.
267 exclude-protected=_asdict,_fields,_replace,_source,_make
270 [DESIGN]
272 # Maximum number of arguments for function / method
273 max-args=12
275 # Argument names that match this expression will be ignored. Default to name
276 # with leading underscore
277 ignored-argument-names=_.*
279 # Maximum number of locals for function / method body
280 max-locals=32
282 # Maximum number of return / yield for function / method body
283 max-returns=6
285 # Maximum number of branch for function / method body
286 max-branches=24
288 # Maximum number of statements in function / method body
289 max-statements=300
291 # Maximum number of parents for a class (see R0901).
292 max-parents=10
294 # Maximum number of attributes for a class (see R0902).
295 max-attributes=7
297 # Minimum number of public methods for a class (see R0903).
298 min-public-methods=0
300 # Maximum number of public methods for a class (see R0904).
301 max-public-methods=40
304 [IMPORTS]
306 # Deprecated modules which should not be used, separated by a comma
307 deprecated-modules=
309 # Create a graph of every (i.e. internal and external) dependencies in the
310 # given file (report RP0402 must not be disabled)
311 import-graph=
313 # Create a graph of external dependencies in the given file (report RP0402 must
314 # not be disabled)
315 ext-import-graph=
317 # Create a graph of internal dependencies in the given file (report RP0402 must
318 # not be disabled)
319 int-import-graph=