1 # Copyright 2014-2015, 6WIND S.A.
5 # Specify a configuration file.
8 # Python code to execute, usually for sys.path manipulation such as
15 # Add files or directories to the blacklist. They should be base names, not
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).
38 disable=attribute-defined-outside-init,
43 interface-not-implemented,
49 super-init-not-called,
55 # Set the output format. Available formats are text, parseable, colorized, msvs
56 # (visual studio) and html
59 # Put messages in a separate file for each module / package specified on the
60 # command line instead of printing them on stdout. Reports (if any) will be
61 # written in a file name "pylint_global.[txt|html]".
64 # Tells whether to display a full report or only the messages
67 # Python expression which should return a note less than 10 (10 is the highest
68 # note). You have access to the variables errors warning, statement which
69 # respectively contain the number of errors / warnings messages and the total
70 # number of statements analyzed. This is used by the global evaluation report
72 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
74 # Add a comment according to your evaluation note. This is used by the global
75 # evaluation report (RP0004).
78 msg-template={path}:{line} {msg} [{symbol}]
82 # Tells whether missing members accessed in mixin class should be ignored. A
83 # mixin class is detected if its name ends with "mixin" (case insensitive).
84 ignore-mixin-members=yes
86 # List of classes names for which member attributes should not be checked
87 # (useful for classes with attributes dynamically set).
88 ignored-classes=SQLObject
90 # When zope mode is activated, add a predefined set of Zope acquired attributes
91 # to generated-members.
94 # List of members which are set dynamically and missed by pylint inference
95 # system, and so shouldn't trigger E0201 when accessed. Python regular
96 # expressions are accepted.
97 generated-members=REQUEST,acl_users,aq_parent
102 # Required attributes for module, separated by a comma
105 # List of builtins function names that should not be used, separated by a comma
106 bad-functions=map,filter,apply,input
108 # Regular expression which should only match correct module names
109 module-rgx=[a-z_][a-z0-9_]*$
111 # Regular expression which should only match correct module level names
112 const-rgx=[A-Z_][A-Z0-9_]*|__all__$
114 # Regular expression which should only match correct class names
115 class-rgx=[A-Z_][a-zA-Z0-9]+$
117 # Regular expression which should only match correct function names
118 function-rgx=[a-z_][a-z0-9_]{2,30}$
120 # Regular expression which should only match correct method names
121 method-rgx=[a-z_][a-z0-9_]{2,30}$
123 # Regular expression which should only match correct instance attribute names
124 attr-rgx=[a-z_][a-z0-9_]{0,30}$
126 # Regular expression which should only match correct argument names
127 argument-rgx=[a-z_][a-z0-9_]{0,30}$
129 # Regular expression which should only match correct variable names
130 variable-rgx=[a-z_][a-z0-9_]{0,30}$
132 # Regular expression which should only match correct list comprehension /
133 # generator expression variable names
134 inlinevar-rgx=[a-z_][a-z0-9_]*$
136 # Good variable names which should always be accepted, separated by a comma
137 good-names=i,j,k,ex,Run,_
139 # Bad variable names which should always be refused, separated by a comma
140 bad-names=foo,bar,baz,toto,tutu,tata
142 # Regular expression which should only match functions or classes name which do
143 # not require a docstring
144 no-docstring-rgx=__.*__
149 # Maximum number of characters on a single line.
152 # Maximum number of lines in a module
153 max-module-lines=1500
155 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
159 # List of optional constructs for which whitespace checking is disabled
165 # Minimum lines number of a similarity.
166 min-similarity-lines=4
168 # Ignore comments when computing similarities.
171 # Ignore docstrings when computing similarities.
172 ignore-docstrings=yes
177 # List of note tags to take in consideration, separated by a comma.
183 # Tells whether we should check for unused import in __init__ files.
186 # A regular expression matching the beginning of the name of dummy variables
188 dummy-variables-rgx=_|dummy
190 # List of additional names supposed to be defined in builtins. Remember that
191 # you should avoid to define new builtins when possible.
197 # Deprecated modules which should not be used, separated by a comma
198 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
200 # Create a graph of every (i.e. internal and external) dependencies in the
201 # given file (report RP0402 must not be disabled)
204 # Create a graph of external dependencies in the given file (report RP0402 must
208 # Create a graph of internal dependencies in the given file (report RP0402 must
215 # Maximum number of arguments for function / method
218 # Argument names that match this expression will be ignored. Default to name
219 # with leading underscore
220 ignored-argument-names=_.*
222 # Maximum number of locals for function / method body
225 # Maximum number of return / yield for function / method body
228 # Maximum number of branch for function / method body
231 # Maximum number of statements in function / method body
234 # Maximum number of parents for a class (see R0901).
237 # Maximum number of attributes for a class (see R0902).
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=100
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__
256 # List of valid names for the first argument in a class method.
257 valid-classmethod-first-arg=cls
262 # Exceptions that will emit a warning when being caught. Defaults to
264 overgeneral-exceptions=Exception