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 # Include message's id in output
71 # Put messages in a separate file for each module / package specified on the
72 # command line instead of printing them on stdout. Reports (if any) will be
73 # written in a file name "pylint_global.[txt|html]".
76 # Tells whether to display a full report or only the messages
80 # Python expression which should return a note less than 10 (10 is the highest
81 # note). You have access to the variables errors warning, statement which
82 # respectively contain the number of errors / warnings messages and the total
83 # number of statements analyzed. This is used by the global evaluation report
85 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
87 # Add a comment according to your evaluation note. This is used by the global
88 # evaluation report (RP0004).
94 # Tells whether we should check for unused import in __init__ files.
97 # A regular expression matching the beginning of the name of dummy variables
99 dummy-variables-rgx=_|dummy
101 # List of additional names supposed to be defined in builtins. Remember that
102 # you should avoid to define new builtins when possible.
108 # Tells whether missing members accessed in mixin class should be ignored. A
109 # mixin class is detected if its name ends with "mixin" (case insensitive).
110 ignore-mixin-members=yes
112 # List of classes names for which member attributes should not be checked
113 # (useful for classes with attributes dynamically set).
116 # When zope mode is activated, add a predefined set of Zope acquired attributes
117 # to generated-members.
120 # List of members which are set dynamically and missed by pylint inference
121 # system, and so shouldn't trigger E0201 when accessed. Python regular
122 # expressions are accepted.
128 # List of note tags to take in consideration, separated by a comma.
134 # Minimum lines number of a similarity.
135 min-similarity-lines=4
137 # Ignore comments when computing similarities.
140 # Ignore docstrings when computing similarities.
141 ignore-docstrings=yes
146 # Maximum number of characters on a single line.
147 # max-line-length=200
149 # Maximum number of lines in a module
150 # max-module-lines=1000
152 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
160 # Required attributes for module, separated by a comma
163 # List of builtins function names that should not be used, separated by a comma
164 bad-functions=map,filter,apply,input
166 # Regular expression which should only match correct module names
167 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
169 # Regular expression which should only match correct module level names
170 const-rgx=(([a-zA-Z_][a-zA-Z0-9_]*)|(__.*__))$
172 # Regular expression which should only match correct class names
173 class-rgx=[A-Z_][a-zA-Z0-9]+$
175 # Regular expression which should only match correct function names
176 function-rgx=[a-z_][a-z0-9_]{0,40}$
178 # Regular expression which should only match correct method names
179 method-rgx=[a-z_][a-z0-9_]{0,48}$
181 # Regular expression which should only match correct instance attribute names
182 attr-rgx=[a-z_][a-z0-9_]{0,30}$
184 # Regular expression which should only match correct argument names
185 argument-rgx=[a-z_][a-z0-9_]{0,30}$
187 # Regular expression which should only match correct variable names
188 variable-rgx=[a-zA-Z0-9_]{0,30}$
190 # Regular expression which should only match correct list comprehension /
191 # generator expression variable names
192 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
194 # Good variable names which should always be accepted, separated by a comma
195 good-names=i,j,k,ex,Run,_
197 # Bad variable names which should always be refused, separated by a comma
198 bad-names=foo,bar,baz,toto,tutu,tata
200 # Regular expression which should only match functions or classes name which do
201 # not require a docstring
202 no-docstring-rgx=__.*__
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=100
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
254 # Deprecated modules which should not be used, separated by a comma
255 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
257 # Create a graph of every (i.e. internal and external) dependencies in the
258 # given file (report RP0402 must not be disabled)
261 # Create a graph of external dependencies in the given file (report RP0402 must
265 # Create a graph of internal dependencies in the given file (report RP0402 must
272 # Exceptions that will emit a warning when being caught. Defaults to
274 overgeneral-exceptions=Exception