3 # Specify a configuration file.
6 # 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
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 # A comma-separated list of package or module names from where C extensions may
25 # be loaded. Extensions are loading into the active Python interpreter and may
27 extension-pkg-whitelist=numpy, scipy
31 # Enable the message, report, category or checker with the given id(s). You can
32 # either give multiple identifier separated by comma (,) or put this option
33 # multiple time. See also the "--disable" option for examples.
36 # Disable the message, report, category or checker with the given id(s). You
37 # can either give multiple identifiers separated by comma (,) or put this
38 # option multiple times (only on the command line, not in the configuration
39 # file where it should appear only once).You can also use "--disable=all" to
40 # disable everything first and then reenable specific checks. For example, if
41 # you want to run only the similarities checker, you can use "--disable=all
42 # --enable=similarities". If you want to run only the classes checker, but have
43 # no Warning level messages displayed, use"--disable=all --enable=classes
45 #disable=redefined-variable-type, locally-disabled, locally-enabled
47 # TODO: Add explanation when disabling an id, either locally or globally.
51 # Set the output format. Available formats are text, parseable, colorized, msvs
52 # (visual studio) and html. You can also give a reporter class, eg
53 # mypackage.mymodule.MyReporterClass.
54 output-format=parseable
56 # Put messages in a separate file for each module / package specified on the
57 # command line instead of printing them on stdout. Reports (if any) will be
58 # written in a file name "pylint_global.[txt|html]".
61 # Tells whether to display a full report or only the messages
64 # Python expression which should return a note less than 10 (10 is the highest
65 # note). You have access to the variables errors warning, statement which
66 # respectively contain the number of errors / warnings messages and the total
67 # number of statements analyzed. This is used by the global evaluation report
69 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
71 # Add a comment according to your evaluation note. This is used by the global
72 # evaluation report (RP0004).
75 # Template used to display messages. This is a python new-style format string
76 # used to format the message information. See doc for all details
82 # Maximum number of characters on a single line.
85 # Regexp for a line that is allowed to be longer than the limit.
86 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
88 # Allow the body of an if to be on the same line as the test if there is no
90 single-line-if-stmt=no
92 # List of optional constructs for which whitespace checking is disabled
93 no-space-check=trailing-comma,dict-separator
95 # Maximum number of lines in a module
98 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
105 # Tells whether we should check for unused import in __init__ files.
108 # A regular expression matching the beginning of the name of dummy variables
110 dummy-variables-rgx=_$|dummy
112 # List of additional names supposed to be defined in builtins. Remember that
113 # you should avoid to define new builtins when possible.
119 # Minimum lines number of a similarity.
120 min-similarity-lines=14
122 # Ignore comments when computing similarities.
125 # Ignore docstrings when computing similarities.
128 # Ignore imports when computing similarities.
134 # Required attributes for module, separated by a comma
137 # List of builtins function names that should not be used, separated by a comma
138 bad-functions=map,filter,apply,input
140 # Regular expression which should only match correct module names
141 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
143 # Regular expression which should only match correct module level names
144 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
146 # Regular expression which should only match correct class names
147 class-rgx=[A-Z_][a-zA-Z0-9]+$
149 # Regular expression which should only match correct function names
150 function-rgx=[a-z_][a-z0-9_]{2,30}$
152 # Regular expression which should only match correct method names
153 method-rgx=[a-z_][a-z0-9_]{2,50}$
155 # Regular expression which should only match correct instance attribute names
156 attr-rgx=[a-z_][a-z0-9_]{2,30}$
158 # Regular expression which should only match correct argument names
159 argument-rgx=[a-z_][a-z0-9_]{2,30}$
161 # Regular expression which should only match correct variable names
162 variable-rgx=[a-z_][a-z0-9_]{2,30}$
164 # Regular expression which should only match correct attribute names in class
166 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
168 # Regular expression which should only match correct list comprehension /
169 # generator expression variable names
170 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
172 # Good variable names which should always be accepted, separated by a comma
173 good-names=i,j,k,ex,Run,_
175 # Bad variable names which should always be refused, separated by a comma
176 bad-names=foo,bar,baz,toto,tutu,tata
178 # Regular expression which should only match function or class names that do
179 # not require a docstring.
180 no-docstring-rgx=__.*__
182 # Minimum line length for functions/classes that require docstrings, shorter
184 docstring-min-length=-1
189 # List of note tags to take in consideration, separated by a comma.
195 # Tells whether missing members accessed in mixin class should be ignored. A
196 # mixin class is detected if its name ends with "mixin" (case insensitive).
197 ignore-mixin-members=yes
199 # List of classes names for which member attributes should not be checked
200 # (useful for classes with attributes dynamically set).
201 ignored-classes=SQLObject
203 # When zope mode is activated, add a predefined set of Zope acquired attributes
204 # to generated-members.
207 # List of members which are set dynamically and missed by pylint inference
208 # system, and so shouldn't trigger E0201 when accessed. Python regular
209 # expressions are accepted.
210 generated-members=REQUEST,acl_users,aq_parent
215 # List of interface methods to ignore, separated by a comma. This is used for
216 # instance to not check methods defines in Zope's Interface base class.
217 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
219 # List of method names used to declare (i.e. assign) instance attributes.
220 defining-attr-methods=__init__,__new__,setUp
222 # List of valid names for the first argument in a class method.
223 valid-classmethod-first-arg=cls
225 # List of valid names for the first argument in a metaclass class method.
226 valid-metaclass-classmethod-first-arg=mcs
231 # Deprecated modules which should not be used, separated by a comma
232 deprecated-modules=regsub,TERMIOS,Bastion,rexec
234 # Create a graph of every (i.e. internal and external) dependencies in the
235 # given file (report RP0402 must not be disabled)
238 # Create a graph of external dependencies in the given file (report RP0402 must
242 # Create a graph of internal dependencies in the given file (report RP0402 must
249 # Maximum number of arguments for function / method
252 # Argument names that match this expression will be ignored. Default to name
253 # with leading underscore
254 ignored-argument-names=_.*
256 # Maximum number of locals for function / method body
259 # Maximum number of return / yield for function / method body
262 # Maximum number of branch for function / method body
265 # Maximum number of statements in function / method body
268 # Maximum number of parents for a class (see R0901).
271 # Maximum number of attributes for a class (see R0902).
274 # Minimum number of public methods for a class (see R0903).
277 # Maximum number of public methods for a class (see R0904).
278 max-public-methods=60
283 # Exceptions that will emit a warning when being caught. Defaults to
285 overgeneral-exceptions=Exception
290 # Format style used to check logging format string. `old` means using %
291 # formatting, while `new` is for `{}` formatting.
292 logging-format-style=fstr