5 # Specify a configuration file.
8 # Python code to execute, usually for sys.path manipulation such as
15 # Add <file or directory> to the black list. It should be a base name, not a
16 # path. You may set this option multiple times.
19 # Pickle collected data for later comparisons.
22 # List of plugins (as comma separated values of python modules names) to load,
23 # usually to register additional checkers.
29 # Enable the message, report, category or checker with the given id(s). You can
30 # either give multiple identifier separated by comma (,) or put this option
34 # Disable the message, report, category or checker with the given id(s). You
35 # can either give multiple identifier separated by comma (,) or put this option
36 # multiple time (only on the command line, not in the configuration file where
37 # it should appear only once).
39 # :W0704: *Except doesn't do anything*
40 # :W0231: *__init__ method from base class %r is not called*
41 # :R0903: *Too few public methods (%s/%s)*
42 disable=W0704,W0231,R0903
47 # Set the output format. Available formats are text, parseable, colorized, msvs
48 # (visual studio) and html
49 # was output-format=text
50 output-format=colorized
52 # Include message's id in output
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).
78 # Minimum lines number of a similarity.
79 min-similarity-lines=4
81 # Ignore comments when computing similarities.
84 # Ignore docstrings when computing similarities.
90 # Tells whether we should check for unused import in __init__ files.
93 # A regular expression matching the beginning of the name of dummy variables
95 dummy-variables-rgx=_|dummy
97 # List of additional names supposed to be defined in builtins. Remember that
98 # you should avoid to define new builtins when possible.
104 # List of note tags to take in consideration, separated by a comma.
110 # Tells whether missing members accessed in mixin class should be ignored. A
111 # mixin class is detected if its name ends with "mixin" (case insensitive).
112 ignore-mixin-members=yes
114 # List of classes names for which member attributes should not be checked
115 # (useful for classes with attributes dynamically set).
116 ignored-classes=SQLObject
118 # When zope mode is activated, add a predefined set of Zope acquired attributes
119 # to generated-members.
122 # List of members which are set dynamically and missed by pylint inference
123 # system, and so shouldn't trigger E0201 when accessed.
124 generated-members=REQUEST,acl_users,aq_parent
129 # Maximum number of characters on a single line.
132 # Maximum number of lines in a module
133 max-module-lines=1000
135 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
137 # was indent-string=' '
143 # Required attributes for module, separated by a comma
146 # List of builtins function names that should not be used, separated by a comma
147 bad-functions=map,filter,apply,input
149 # Regular expression which should only match correct module names
150 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
152 # Regular expression which should only match correct module level names
153 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
155 # Regular expression which should only match correct class names
156 class-rgx=[A-Z_][a-zA-Z0-9]+$
158 # Regular expression which should only match correct function names
159 function-rgx=[a-z_][a-z0-9_]{2,30}$
161 # Regular expression which should only match correct method names
162 method-rgx=[a-z_][a-z0-9_]{2,30}$
164 # Regular expression which should only match correct instance attribute names
165 # was attr-rgx=[a-z_][a-z0-9_]{2,30}$
166 attr-rgx=[a-z_][a-z0-9_]{1,30}$
168 # Regular expression which should only match correct argument names
169 # was argument-rgx=[a-z_][a-z0-9_]{2,30}$
170 argument-rgx=[a-z_][a-z0-9_]{1,30}$
172 # Regular expression which should only match correct variable names
173 # was variable-rgx=[a-z_][a-z0-9_]{2,30}$
174 variable-rgx=[a-z_][a-z0-9_]{1,30}$
176 # Regular expression which should only match correct list comprehension /
177 # generator expression variable names
178 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
180 # Good variable names which should always be accepted, separated by a comma
181 good-names=i,j,k,ex,Run,_
183 # Bad variable names which should always be refused, separated by a comma
184 bad-names=foo,bar,baz,toto,tutu,tata
186 # Regular expression which should only match functions or classes name which do
187 # not require a docstring
188 # was no-docstring-rgx=__.*__
194 # Deprecated modules which should not be used, separated by a comma
195 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
197 # Create a graph of every (i.e. internal and external) dependencies in the
198 # given file (report RP0402 must not be disabled)
201 # Create a graph of external dependencies in the given file (report RP0402 must
205 # Create a graph of internal dependencies in the given file (report RP0402 must
212 # Maximum number of arguments for function / method
216 # Argument names that match this expression will be ignored. Default to name
217 # with leading underscore
218 ignored-argument-names=_.*
220 # Maximum number of locals for function / method body
223 # Maximum number of return / yield for function / method body
227 # Maximum number of branch for function / method body
230 # Maximum number of statements in function / method body
233 # Maximum number of parents for a class (see R0901).
236 # Maximum number of attributes for a class (see R0902).
237 # was max-attributes=7
240 # Minimum number of public methods for a class (see R0903).
243 # Maximum number of public methods for a class (see R0904).
244 max-public-methods=20
249 # List of interface methods to ignore, separated by a comma. This is used for
250 # instance to not check methods defines in Zope's Interface base class.
251 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
253 # List of method names used to declare (i.e. assign) instance attributes.
254 defining-attr-methods=__init__,__new__,setUp