3 # Specify a configuration file.
6 # Python code to execute, usually for sys.path manipulation such as
13 # Add <file or directory> to the black list. It should be a base name, not a
14 # path. You may set this option multiple times.
17 # Pickle collected data for later comparisons.
20 # List of plugins (as comma separated values of python modules names) to load,
21 # usually to register additional checkers.
27 # Enable the message, report, category or checker with the given id(s). You can
28 # either give multiple identifier separated by comma (,) or put this option
32 # Disable the message, report, category or checker with the given id(s). You
33 # can either give multiple identifier separated by comma (,) or put this option
34 # multiple time (only on the command line, not in the configuration file where
35 # it should appear only once).
36 # E1103: X has no Y member (but some types could not be inferred)
37 # W0212: Access to a protected member of X class
38 # W0223: Method Y is abstract in class X but not overridden
39 # C0103: Invalid name "%s" (should match %s)
40 # C0111: Missing docstring
41 # W0142: Used * or ** magic
42 # R0201: Method could be a function
43 # R0915: Too many statements
44 # I0011: Locally disabling ... (don't need to see things we've explicitly disabled)
45 disable=E1103,W0212,W0223,C0111,W0142,R0201,R0915,I0011,C0103
50 # Set the output format. Available formats are text, parseable, colorized, msvs
51 # (visual studio) and html
54 # Include message's id in output
57 # Put messages in a separate file for each module / package specified on the
58 # command line instead of printing them on stdout. Reports (if any) will be
59 # written in a file name "pylint_global.[txt|html]".
62 # Tells whether to display a full report or only the messages
65 # Python expression which should return a note less than 10 (10 is the highest
66 # note). You have access to the variables errors warning, statement which
67 # respectively contain the number of errors / warnings messages and the total
68 # number of statements analyzed. This is used by the global evaluation report
70 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
72 # Add a comment according to your evaluation note. This is used by the global
73 # evaluation report (RP0004).
79 # Required attributes for module, separated by a comma
82 # List of builtins function names that should not be used, separated by a comma
83 bad-functions=apply,input
85 # Regular expression which should only match correct module names
86 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
88 # Regular expression which should only match correct module level names
89 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
91 # Regular expression which should only match correct class names
92 class-rgx=[A-Z_][a-zA-Z0-9]+$
94 # Regular expression which should only match correct function names
95 function-rgx=[a-z_][a-z0-9_]{2,30}$
97 # Regular expression which should only match correct method names
98 method-rgx=[a-z_][a-z0-9_]{2,30}$
100 # Regular expression which should only match correct instance attribute names
101 attr-rgx=[a-z_][a-z0-9_]{2,30}$
103 # Regular expression which should only match correct argument names
104 argument-rgx=[a-z_][a-z0-9_]{2,30}$
106 # Regular expression which should only match correct variable names
107 variable-rgx=[a-z_][a-z0-9_]{2,30}$
109 # Regular expression which should only match correct list comprehension /
110 # generator expression variable names
111 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
113 # Good variable names which should always be accepted, separated by a comma
114 good-names=i,j,k,c,g,ex,Run,_
116 # Bad variable names which should always be refused, separated by a comma
117 bad-names=foo,bar,baz,toto,tutu,tata
119 # Regular expression which should only match functions or classes name which do
120 # not require a docstring
121 no-docstring-rgx=__.*__
126 # Maximum number of characters on a single line.
129 # Maximum number of lines in a module
130 max-module-lines=1000
132 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
139 # List of note tags to take in consideration, separated by a comma.
145 # Minimum lines number of a similarity.
146 min-similarity-lines=4
148 # Ignore comments when computing similarities.
151 # Ignore docstrings when computing similarities.
152 ignore-docstrings=yes
157 # Tells whether missing members accessed in mixin class should be ignored. A
158 # mixin class is detected if its name ends with "mixin" (case insensitive).
159 ignore-mixin-members=yes
161 # List of classes names for which member attributes should not be checked
162 # (useful for classes with attributes dynamically set).
163 ignored-classes=SQLObject
165 # When zope mode is activated, add a predefined set of Zope acquired attributes
166 # to generated-members.
169 # List of members which are set dynamically and missed by pylint inference
170 # system, and so shouldn't trigger E0201 when accessed.
171 generated-members=REQUEST,acl_users,aq_parent
176 # Tells whether we should check for unused import in __init__ files.
179 # A regular expression matching the beginning of the name of dummy variables
181 dummy-variables-rgx=unused|dummy
183 # List of additional names supposed to be defined in builtins. Remember that
184 # you should avoid to define new builtins when possible.
190 # List of interface methods to ignore, separated by a comma. This is used for
191 # instance to not check methods defines in Zope's Interface base class.
192 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
194 # List of method names used to declare (i.e. assign) instance attributes.
195 defining-attr-methods=__init__,__new__,setUp
200 # Maximum number of arguments for function / method
203 # Argument names that match this expression will be ignored. Default to name
204 # with leading underscore
205 ignored-argument-names=_.*
207 # Maximum number of locals for function / method body
210 # Maximum number of return / yield for function / method body
213 # Maximum number of branch for function / method body
216 # Maximum number of statements in function / method body
219 # Maximum number of parents for a class (see R0901).
222 # Maximum number of attributes for a class (see R0902).
225 # Minimum number of public methods for a class (see R0903).
228 # Maximum number of public methods for a class (see R0904).
229 max-public-methods=20
234 # Deprecated modules which should not be used, separated by a comma
235 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
237 # Create a graph of every (i.e. internal and external) dependencies in the
238 # given file (report RP0402 must not be disabled)
241 # Create a graph of external dependencies in the given file (report RP0402 must
245 # Create a graph of internal dependencies in the given file (report RP0402 must