1 # Copyright 2014 Google Inc. All rights reserved.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
17 # Specify a configuration file.
20 # Python code to execute, usually for sys.path manipulation such as
27 # Add files or directories to the blacklist. They should be base names, not
31 # Pickle collected data for later comparisons.
34 # List of plugins (as comma separated values of python modules names) to load,
35 # usually to register additional checkers.
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
46 # Disable the message, report, category or checker with the given id(s). You
47 # can either give multiple identifier separated by comma (,) or put this option
48 # multiple time (only on the command line, not in the configuration file where
49 # it should appear only once).
51 # C0111: Missing docstring
52 # I0011: Locally disabling WNNNN
53 # R0201: Method could be a function
54 # R0801: Similar lines
55 # W0141: Used builtin function 'map'
56 # W0142: Used * or ** magic
58 # W0703: Catch "Exception"
59 disable=C0111,I0011,R0201,R0801,W0141,W0142,W0511,W0703
64 # Set the output format. Available formats are text, parseable, colorized, msvs
65 # (visual studio) and html
68 # Put messages in a separate file for each module / package specified on the
69 # command line instead of printing them on stdout. Reports (if any) will be
70 # written in a file name "pylint_global.[txt|html]".
73 # Tells whether to display a full report or only the messages
77 # Python expression which should return a note less than 10 (10 is the highest
78 # note). You have access to the variables errors warning, statement which
79 # respectively contain the number of errors / warnings messages and the total
80 # number of statements analyzed. This is used by the global evaluation report
82 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
84 # Add a comment according to your evaluation note. This is used by the global
85 # evaluation report (RP0004).
91 # Tells whether we should check for unused import in __init__ files.
94 # A regular expression matching the beginning of the name of dummy variables
96 dummy-variables-rgx=_|dummy
98 # List of additional names supposed to be defined in builtins. Remember that
99 # you should avoid to define new builtins when possible.
105 # Tells whether missing members accessed in mixin class should be ignored. A
106 # mixin class is detected if its name ends with "mixin" (case insensitive).
107 ignore-mixin-members=yes
109 # List of classes names for which member attributes should not be checked
110 # (useful for classes with attributes dynamically set).
113 # When zope mode is activated, add a predefined set of Zope acquired attributes
114 # to generated-members.
117 # List of members which are set dynamically and missed by pylint inference
118 # system, and so shouldn't trigger E0201 when accessed. Python regular
119 # expressions are accepted.
125 # List of note tags to take in consideration, separated by a comma.
131 # Minimum lines number of a similarity.
132 min-similarity-lines=4
134 # Ignore comments when computing similarities.
137 # Ignore docstrings when computing similarities.
138 ignore-docstrings=yes
143 # Maximum number of characters on a single line.
144 # max-line-length=200
146 # Maximum number of lines in a module
147 # max-module-lines=1000
149 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
157 # Required attributes for module, separated by a comma
160 # List of builtins function names that should not be used, separated by a comma
161 bad-functions=map,filter,apply,input
163 # Regular expression which should only match correct module names
164 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
166 # Regular expression which should only match correct module level names
167 const-rgx=(([a-zA-Z_][a-zA-Z0-9_]*)|(__.*__))$
169 # Regular expression which should only match correct class names
170 class-rgx=[A-Z_][a-zA-Z0-9]+$
172 # Regular expression which should only match correct function names
173 function-rgx=[a-z_][a-z0-9_]{0,40}$
175 # Regular expression which should only match correct method names
176 method-rgx=[a-z_][a-z0-9_]{0,48}$
178 # Regular expression which should only match correct instance attribute names
179 attr-rgx=[a-z_][a-z0-9_]{0,30}$
181 # Regular expression which should only match correct argument names
182 argument-rgx=[a-z_][a-z0-9_]{0,30}$
184 # Regular expression which should only match correct variable names
185 variable-rgx=[a-zA-Z0-9_]{0,30}$
187 # Regular expression which should only match correct list comprehension /
188 # generator expression variable names
189 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
191 # Good variable names which should always be accepted, separated by a comma
192 good-names=i,j,k,ex,Run,_
194 # Bad variable names which should always be refused, separated by a comma
195 bad-names=foo,bar,baz,toto,tutu,tata
197 # Regular expression which should only match functions or classes name which do
198 # not require a docstring
199 no-docstring-rgx=__.*__
204 # Maximum number of arguments for function / method
207 # Argument names that match this expression will be ignored. Default to name
208 # with leading underscore
209 ignored-argument-names=_.*
211 # Maximum number of locals for function / method body
214 # Maximum number of return / yield for function / method body
217 # Maximum number of branch for function / method body
220 # Maximum number of statements in function / method body
223 # Maximum number of parents for a class (see R0901).
226 # Maximum number of attributes for a class (see R0902).
229 # Minimum number of public methods for a class (see R0903).
232 # Maximum number of public methods for a class (see R0904).
233 max-public-methods=100
238 # List of interface methods to ignore, separated by a comma. This is used for
239 # instance to not check methods defines in Zope's Interface base class.
240 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
242 # List of method names used to declare (i.e. assign) instance attributes.
243 defining-attr-methods=__init__,__new__,setUp
245 # List of valid names for the first argument in a class method.
246 valid-classmethod-first-arg=cls
251 # Deprecated modules which should not be used, separated by a comma
252 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
254 # Create a graph of every (i.e. internal and external) dependencies in the
255 # given file (report RP0402 must not be disabled)
258 # Create a graph of external dependencies in the given file (report RP0402 must
262 # Create a graph of internal dependencies in the given file (report RP0402 must
269 # Exceptions that will emit a warning when being caught. Defaults to
271 overgeneral-exceptions=Exception