3 # Specify what version of Python to evaluate code against.
6 # Specify a configuration file.
9 # Python code to execute, usually for sys.path manipulation such as
13 # Add files or directories to the blacklist. They should be base names, not
15 ignore=.git,qtpy,sphinxtogithub
17 # Pickle collected data for later comparisons.
20 # List of plugins (as comma separated values of python modules names) to load,
21 # usually to register additional checkers.
24 # Use multiple processes to speed up Pylint.
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
34 extension-pkg-whitelist=binascii,math,PyQt4,PyQt5,PyQt6,PySide,PySide2,select,struct,struct.pack,struct.unpack
38 # Only show warnings with the listed confidence levels. Leave empty to show
39 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
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.
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
61 consider-using-f-string,
69 too-many-instance-attributes,
71 useless-object-inheritance,
75 # Set the output format. Available formats are text, parseable, colorized, msvs
76 # (visual studio) and html. You can also give a reporter class, eg
77 # mypackage.mymodule.MyReporterClass.
80 # Tells whether to display a full report or only the messages
83 # Python expression which should return a note less than 10 (10 is the highest
84 # note). You have access to the variables errors warning, statement which
85 # respectively contain the number of errors / warnings messages and the total
86 # number of statements analyzed. This is used by the global evaluation report
88 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
90 # Template used to display messages. This is a python new-style format string
91 # used to format the message information. See doc for all details
92 msg-template={path}:{line}:{column}: {msg} ({symbol})
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.
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 # Regular expression matching correct variable names
114 variable-rgx=[a-z_][a-z0-9_]{2,30}$
116 # Regular expression matching correct constant names
117 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
119 # Regular expression matching correct attribute names
120 attr-rgx=[a-z_][a-z0-9_]{2,30}$
122 # Regular expression matching correct argument names
123 argument-rgx=[a-z_][a-z0-9_]{2,30}$
125 # Regular expression matching correct class attribute names
126 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
128 # Regular expression matching correct inline iteration names
129 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
131 # Regular expression matching correct class names
132 class-rgx=[A-Z_][a-zA-Z0-9]+$
134 # Regular expression matching correct module names
135 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
137 # Regular expression matching correct method names
138 method-rgx=[a-z_][a-z0-9_]{2,30}$
140 # Regular expression which should only match function or class names that do
141 # not require a docstring.
142 no-docstring-rgx=__.*__
144 # Minimum line length for functions/classes that require docstrings, shorter
146 docstring-min-length=-1
151 # List of note tags to take in consideration, separated by a comma.
157 # Maximum number of characters on a single line.
160 # Regexp for a line that is allowed to be longer than the limit.
161 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
163 # Allow the body of an if to be on the same line as the test if there is no
165 single-line-if-stmt=no
167 # Maximum number of lines in a module
168 max-module-lines=3000
170 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
174 # Number of spaces of indent required inside a hanging or continued line.
177 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
178 expected-line-ending-format=LF
183 # Tells whether missing members accessed in mixin class should be ignored. A
184 # mixin class is detected if its name ends with "mixin" (case insensitive).
185 ignore-mixin-members=yes
187 # List of module names for which member attributes should not be checked
188 # (useful for modules/projects where namespaces are manipulated during runtime
189 # and thus existing member attributes cannot be deduced by static analysis
192 # List of classes names for which member attributes should not be checked
193 # (useful for classes with attributes dynamically set).
196 # List of members which are set dynamically and missed by pylint inference
197 # system, and so shouldn't trigger E0201 when accessed. Python regular
198 # expressions are accepted.
204 # Minimum lines number of a similarity.
205 min-similarity-lines=4
207 # Ignore comments when computing similarities.
210 # Ignore docstrings when computing similarities.
211 ignore-docstrings=yes
213 # Ignore imports when computing similarities.
219 # Spelling dictionary name. Available dictionaries: none. To make it working
220 # install python-enchant package.
223 # List of comma separated words that should not be checked.
224 spelling-ignore-words=
226 # A path to a file that contains private dictionary; one word per line.
227 spelling-private-dict-file=
229 # Tells whether to store unknown words to indicated private dictionary in
230 # --spelling-private-dict-file option instead of raising a message.
231 spelling-store-unknown-words=no
236 # Logging modules to check that the string format arguments are in logging
237 # function parameter format
238 logging-modules=logging
243 # Tells whether we should check for unused import in __init__ files.
246 # A regular expression matching the name of dummy variables (i.e. expectedly
248 dummy-variables-rgx=_$|dummy
250 # List of additional names supposed to be defined in builtins. Remember that
251 # you should avoid to define new builtins when possible.
254 # List of strings which can identify a callback function by name. A callback
255 # name must start or end with one of those strings.
261 # List of method names used to declare (i.e. assign) instance attributes.
262 defining-attr-methods=__init__,__new__,setUp
264 # List of valid names for the first argument in a class method.
265 valid-classmethod-first-arg=cls
267 # List of valid names for the first argument in a metaclass class method.
268 valid-metaclass-classmethod-first-arg=mcs
270 # List of member names, which should be excluded from the protected access
272 exclude-protected=_asdict,_fields,_replace,_source,_make
277 # Maximum number of arguments for function / method
280 # Argument names that match this expression will be ignored. Default to name
281 # with leading underscore
282 ignored-argument-names=_.*
284 # Maximum number of locals for function / method body
287 # Maximum number of return / yield for function / method body
290 # Maximum number of branch for function / method body
293 # Maximum number of statements in function / method body
296 # Maximum number of parents for a class (see R0901).
299 # Maximum number of attributes for a class (see R0902).
302 # Minimum number of public methods for a class (see R0903).
305 # Maximum number of public methods for a class (see R0904).
306 max-public-methods=40
311 # Deprecated modules which should not be used, separated by a comma
314 # Create a graph of every (i.e. internal and external) dependencies in the
315 # given file (report RP0402 must not be disabled)
318 # Create a graph of external dependencies in the given file (report RP0402 must
322 # Create a graph of internal dependencies in the given file (report RP0402 must
329 # Exceptions that will emit a warning when being caught. Defaults to
331 overgeneral-exceptions=Exception