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.
27 # Enable the message, report, category or checker with the given id(s). You can
28 # either give multiple identifier separated by comma (,) or put this option
32 # Disable the message, report, category or checker with the given id(s). You
33 # can either give multiple identifier separated by comma (,) or put this option
34 # multiple time (only on the command line, not in the configuration file where
35 # it should appear only once).
41 # Set the output format. Available formats are text, parseable, colorized, msvs
42 # (visual studio) and html. You can also give a reporter class, eg
43 # mypackage.mymodule.MyReporterClass.
44 output-format=parseable
46 # Include message's id in output
49 # Include symbolic ids of messages in output
52 # Put messages in a separate file for each module / package specified on the
53 # command line instead of printing them on stdout. Reports (if any) will be
54 # written in a file name "pylint_global.[txt|html]".
57 # Tells whether to display a full report or only the messages
60 # Python expression which should return a note less than 10 (10 is the highest
61 # note). You have access to the variables errors warning, statement which
62 # respectively contain the number of errors / warnings messages and the total
63 # number of statements analyzed. This is used by the global evaluation report
65 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
67 # Add a comment according to your evaluation note. This is used by the global
68 # evaluation report (RP0004).
74 # List of note tags to take in consideration, separated by a comma.
80 # Required attributes for module, separated by a comma
83 # List of builtins function names that should not be used, separated by a comma
84 bad-functions=map,filter,apply,input
86 # Regular expression which should only match correct module names
87 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
89 # Regular expression which should only match correct module level names
90 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
92 # Regular expression which should only match correct class names
93 class-rgx=[A-Z_][a-zA-Z0-9]+$
95 # Regular expression which should only match correct function names
96 function-rgx=[a-z_][a-z0-9_]{2,30}$
98 # Regular expression which should only match correct method names
99 method-rgx=[a-z_][a-z0-9_]{2,30}|visit_[A-Za-z]+$
101 # Regular expression which should only match correct instance attribute names
102 attr-rgx=[a-z_][a-z0-9_]{2,30}$
104 # Regular expression which should only match correct argument names
105 argument-rgx=[a-z_][a-z0-9_]{2,30}$
107 # Regular expression which should only match correct variable names
108 variable-rgx=[a-z_][a-z0-9_]{2,30}$
110 # Regular expression which should only match correct list comprehension /
111 # generator expression variable names
112 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
114 # Good variable names which should always be accepted, separated by a comma
115 good-names=i,j,k,ex,Run,_
117 # Bad variable names which should always be refused, separated by a comma
118 bad-names=foo,bar,baz,toto,tutu,tata
120 # Regular expression which should only match functions or classes name which do
121 # not require a docstring
122 no-docstring-rgx=__.*__
127 # Maximum number of characters on a single line.
130 # Maximum number of lines in a module
131 max-module-lines=15000
133 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
140 # Minimum lines number of a similarity.
141 min-similarity-lines=4
143 # Ignore comments when computing similarities.
146 # Ignore docstrings when computing similarities.
147 ignore-docstrings=yes
149 # Ignore imports when computing similarities.
155 # Tells whether missing members accessed in mixin class should be ignored. A
156 # mixin class is detected if its name ends with "mixin" (case insensitive).
157 ignore-mixin-members=yes
159 # List of classes names for which member attributes should not be checked
160 # (useful for classes with attributes dynamically set).
161 ignored-classes=SQLObject
163 # When zope mode is activated, add a predefined set of Zope acquired attributes
164 # to generated-members.
167 # List of members which are set dynamically and missed by pylint inference
168 # system, and so shouldn't trigger E0201 when accessed. Python regular
169 # expressions are accepted.
170 generated-members=REQUEST,acl_users,aq_parent
175 # Tells whether we should check for unused import in __init__ files.
178 # A regular expression matching the beginning of the name of dummy variables
180 dummy-variables-rgx=_|dummy
182 # List of additional names supposed to be defined in builtins. Remember that
183 # you should avoid to define new builtins when possible.
189 # Deprecated modules which should not be used, separated by a comma
190 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
192 # Create a graph of every (i.e. internal and external) dependencies in the
193 # given file (report RP0402 must not be disabled)
196 # Create a graph of external dependencies in the given file (report RP0402 must
200 # Create a graph of internal dependencies in the given file (report RP0402 must
207 # Maximum number of arguments for function / method
210 # Argument names that match this expression will be ignored. Default to name
211 # with leading underscore
212 ignored-argument-names=_.*
214 # Maximum number of locals for function / method body
217 # Maximum number of return / yield for function / method body
220 # Maximum number of branch for function / method body
223 # Maximum number of statements in function / method body
226 # Maximum number of parents for a class (see R0901).
229 # Maximum number of attributes for a class (see R0902).
232 # Minimum number of public methods for a class (see R0903).
235 # Maximum number of public methods for a class (see R0904).
236 max-public-methods=20
241 # List of interface methods to ignore, separated by a comma. This is used for
242 # instance to not check methods defines in Zope's Interface base class.
243 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
245 # List of method names used to declare (i.e. assign) instance attributes.
246 defining-attr-methods=__init__,__new__,setUp
248 # List of valid names for the first argument in a class method.
249 valid-classmethod-first-arg=cls
251 # List of valid names for the first argument in a metaclass class method.
252 valid-metaclass-classmethod-first-arg=mcs
257 # Exceptions that will emit a warning when being caught. Defaults to
259 overgeneral-exceptions=Exception