1 # lint Python modules using external checkers.
3 # This is the main checker controling the other ones and the reports
4 # generation. It is itself both a raw checker and an astng checker in order
6 # * handle message activation / deactivation at the module level
7 # * handle some basic but necessary stats'data (number of classes, methods...)
11 # Specify a configuration file.
17 # Add <file or directory> to the black list. It should be a base name, not a
18 # path. You may set this option multiple times.
24 # Pickle collected data for later comparisons.
27 # Set the cache size for astng objects.
30 # List of plugins (as comma separated values of python modules names) to load,
31 # usually to register additional checkers.
37 # Display a help message for the given message id and exit. The value may be a
38 # comma separated list of message ids.
44 # Enable only checker(s) with the given id(s). This option conflict with the
45 # disable-checker option
48 # Enable all checker(s) except those with the given id(s). This option conflict
49 # with the disable-checker option
52 # Enable all messages in the listed categories.
55 # Disable all messages in the listed categories.
58 # Enable the message(s) with the given id(s).
61 # Disable the message(s) with the given id(s).
67 # set the output format. Available formats are text, parseable, colorized and
71 # Include message's id in output
74 # Put messages in a separate file for each module / package specified on the
75 # command line instead of printing them on stdout. Reports (if any) will be
76 # written in a file name "pylint_global.[txt|html]".
79 # Tells wether to display a full report or only the messages
82 # Python expression which should return a note less than 10 (10 is the highest
83 # note).You have access to the variables errors warning, statement which
84 # respectivly contain the number of errors / warnings messages and the total
85 # number of statements analyzed. This is used by the global evaluation report
87 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
89 # Add a comment according to your evaluation note. This is used by the global
90 # evaluation report (R0004).
93 # Enable the report(s) with the given id(s).
96 # Disable the report(s) with the given id(s).
102 # * modules / classes / functions / methods / arguments / variables name
103 # * number of arguments, local variables, branchs, returns and statements in
105 # * required module attributes
106 # * dangerous default values as arguments
107 # * redefinition of function / method / class
108 # * uses of the global statement
112 # Required attributes for module, separated by a comma
115 # Regular expression which should only match functions or classes name which do
116 # not require a docstring
117 no-docstring-rgx=__.*__
119 # Regular expression which should only match correct module names
120 module-rgx=(([a-z_][a-z0-9_-]*)|([A-Z][a-zA-Z0-9]+))$
122 # Regular expression which should only match correct module level names
123 const-rgx=(([A-Z_][A-Z1-9_]*)|(__.*__))$
125 # Regular expression which should only match correct class names
126 class-rgx=[A-Z_][a-zA-Z0-9]+$
128 # Regular expression which should only match correct function names
129 function-rgx=[A-Za-z_][A-Za-z0-9_]{2,30}$
131 # Regular expression which should only match correct method names
132 method-rgx=[A-Za-z_][A-Za-z0-9_]{2,30}$
134 # Regular expression which should only match correct instance attribute names
135 attr-rgx=[a-z_][a-z0-9_]{2,30}$
137 # Regular expression which should only match correct argument names
138 argument-rgx=[a-z_][a-z0-9_]{2,30}$
140 # Regular expression which should only match correct variable names
141 variable-rgx=[a-z_][a-z0-9_]{2,30}$
143 # Regular expression which should only match correct list comprehension /
144 # generator expression variable names
145 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
147 # Good variable names which should always be accepted, separated by a comma
148 good-names=i,j,k,f,ex,Run,_
150 # Bad variable names which should always be refused, separated by a comma
151 bad-names=foo,bar,baz,toto,tutu,tata
153 # List of builtins function names that should not be used, separated by a comma
154 bad-functions=map,filter,apply,input
158 # * unused variables / imports
159 # * undefined variables
160 # * redefinition of variable from builtins or from an outer scope
161 # * use of variable before assigment
165 # Tells wether we should check for unused import in __init__ files.
168 # A regular expression matching names used for dummy variables (i.e. not used).
169 dummy-variables-rgx=_|dummy|event|evt|busy
171 # List of additional names supposed to be defined in builtins. Remember that
172 # you should avoid to define new builtins when possible.
173 additional-builtins=_
176 # try to find bugs in the code using type inference
180 # Tells wether missing members accessed in mixin class should be ignored. A
181 # mixin class is detected if its name ends with "mixin" (case insensitive).
182 ignore-mixin-members=yes
184 # When zope mode is activated, consider the acquired-members option to ignore
185 # access to some undefined attributes.
188 # List of members which are usually get through zope's acquisition mecanism and
189 # so shouldn't trigger E0201 when accessed (need zope=yes to be considered).
190 acquired-members=REQUEST,acl_users,aq_parent
194 # * methods without self as first argument
195 # * overridden methods signature
196 # * access only to existant members via self
197 # * attributes not defined in the __init__ method
198 # * supported interfaces implementation
203 # List of interface methods to ignore, separated by a comma. This is used for
204 # instance to not check methods defines in Zope's Interface base class.
205 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
207 # List of method names used to declare (i.e. assign) instance attributes.
208 defining-attr-methods=__init__,__new__,setUp
211 # checks for sign of poor/misdesign:
212 # * number of methods, attributes, local variables...
213 # * size, complexity of functions, methods
217 # Maximum number of arguments for function / method
220 # Maximum number of locals for function / method body
223 # Maximum number of return / yield for function / method body
226 # Maximum number of branch for function / method body
229 # Maximum number of statements in function / method body
232 # Maximum number of parents for a class (see R0901).
235 # Maximum number of attributes for a class (see R0902).
238 # Minimum number of public methods for a class (see R0903).
241 # Maximum number of public methods for a class (see R0904).
242 max-public-methods=20
246 # * external modules dependencies
247 # * relative / wildcard imports
249 # * uses of deprecated modules
253 # Deprecated modules which should not be used, separated by a comma
254 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
256 # Create a graph of every (i.e. internal and external) dependencies in the
257 # given file (report R0402 must not be disabled)
260 # Create a graph of external dependencies in the given file (report R0402 must
264 # Create a graph of internal dependencies in the given file (report R0402 must
269 # checks for similarities and duplicated code. This computation may be
270 # memory / CPU intensive, so you should disable it if you experiments some
275 # Minimum lines number of a similarity.
276 min-similarity-lines=4
278 # Ignore comments when computing similarities.
281 # Ignore docstrings when computing similarities.
282 ignore-docstrings=yes
286 # * warning notes in the code like FIXME, XXX
287 # * PEP 263: source code with non ascii character but no encoding declaration
291 # List of note tags to take in consideration, separated by a comma.
292 notes=FIXME,XXX,TODO,@todo,\todo
296 # * unauthorized constructions
297 # * strict indentation
299 # * use of <> instead of !=
303 # Maximum number of characters on a single line.
306 # Maximum number of lines in a module
307 max-module-lines=1000
309 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1