• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[MASTER]
2
3# Specify a configuration file.
4#rcfile=
5
6# Python code to execute, usually for sys.path manipulation such as
7# pygtk.require().
8#init-hook=
9
10# Profiled execution.
11profile=no
12
13# Add files or directories to the blacklist. They should be base names, not
14# paths.
15ignore=CVS
16
17# Pickle collected data for later comparisons.
18persistent=yes
19
20# List of plugins (as comma separated values of python modules names) to load,
21# usually to register additional checkers.
22load-plugins=
23
24
25[MESSAGES CONTROL]
26
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
29# multiple time. See also the "--disable" option for examples.
30#enable=
31
32# Disable the message, report, category or checker with the given id(s). You
33# can either give multiple identifiers separated by comma (,) or put this
34# option multiple times (only on the command line, not in the configuration
35# file where it should appear only once).You can also use "--disable=all" to
36# disable everything first and then reenable specific checks. For example, if
37# you want to run only the similarities checker, you can use "--disable=all
38# --enable=similarities". If you want to run only the classes checker, but have
39# no Warning level messages displayed, use"--disable=all --enable=classes
40# --disable=W"
41disable=missing-docstring,invalid-name,no-self-use,fixme,design
42
43
44[REPORTS]
45
46# Set the output format. Available formats are text, parseable, colorized, msvs
47# (visual studio) and html. You can also give a reporter class, eg
48# mypackage.mymodule.MyReporterClass.
49output-format=text
50
51# Put messages in a separate file for each module / package specified on the
52# command line instead of printing them on stdout. Reports (if any) will be
53# written in a file name "pylint_global.[txt|html]".
54files-output=no
55
56# Tells whether to display a full report or only the messages
57reports=yes
58
59# Python expression which should return a note less than 10 (10 is the highest
60# note). You have access to the variables errors warning, statement which
61# respectively contain the number of errors / warnings messages and the total
62# number of statements analyzed. This is used by the global evaluation report
63# (RP0004).
64evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
65
66# Add a comment according to your evaluation note. This is used by the global
67# evaluation report (RP0004).
68comment=no
69
70# Template used to display messages. This is a python new-style format string
71# used to format the message information. See doc for all details
72#msg-template=
73
74
75[BASIC]
76
77# Required attributes for module, separated by a comma
78required-attributes=
79
80# List of builtins function names that should not be used, separated by a comma
81bad-functions=map,filter,apply,input
82
83# Regular expression which should only match correct module names
84module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
85
86# Regular expression which should only match correct module level names
87const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
88
89# Regular expression which should only match correct class names
90class-rgx=[A-Z_][a-zA-Z0-9]+$
91
92# Regular expression which should only match correct function names
93function-rgx=[a-z_][a-z0-9_]{2,30}$
94
95# Regular expression which should only match correct method names
96method-rgx=[a-z_][a-z0-9_]{2,30}$
97
98# Regular expression which should only match correct instance attribute names
99attr-rgx=[a-z_][a-z0-9_]{2,30}$
100
101# Regular expression which should only match correct argument names
102argument-rgx=[a-z_][a-z0-9_]{2,30}$
103
104# Regular expression which should only match correct variable names
105variable-rgx=[a-z_][a-z0-9_]{2,30}$
106
107# Regular expression which should only match correct attribute names in class
108# bodies
109class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
110
111# Regular expression which should only match correct list comprehension /
112# generator expression variable names
113inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
114
115# Good variable names which should always be accepted, separated by a comma
116good-names=i,j,k,ex,Run,_
117
118# Bad variable names which should always be refused, separated by a comma
119bad-names=foo,bar,baz,toto,tutu,tata
120
121# Regular expression which should only match function or class names that do
122# not require a docstring.
123no-docstring-rgx=__.*__
124
125# Minimum line length for functions/classes that require docstrings, shorter
126# ones are exempt.
127docstring-min-length=-1
128
129
130[TYPECHECK]
131
132# Tells whether missing members accessed in mixin class should be ignored. A
133# mixin class is detected if its name ends with "mixin" (case insensitive).
134ignore-mixin-members=yes
135
136# List of classes names for which member attributes should not be checked
137# (useful for classes with attributes dynamically set).
138ignored-classes=SQLObject
139
140# When zope mode is activated, add a predefined set of Zope acquired attributes
141# to generated-members.
142zope=no
143
144# List of members which are set dynamically and missed by pylint inference
145# system, and so shouldn't trigger E0201 when accessed. Python regular
146# expressions are accepted.
147generated-members=REQUEST,acl_users,aq_parent
148
149
150[MISCELLANEOUS]
151
152# List of note tags to take in consideration, separated by a comma.
153notes=FIXME,XXX,TODO
154
155
156[SIMILARITIES]
157
158# Minimum lines number of a similarity.
159min-similarity-lines=4
160
161# Ignore comments when computing similarities.
162ignore-comments=yes
163
164# Ignore docstrings when computing similarities.
165ignore-docstrings=yes
166
167# Ignore imports when computing similarities.
168ignore-imports=no
169
170
171[VARIABLES]
172
173# Tells whether we should check for unused import in __init__ files.
174init-import=no
175
176# A regular expression matching the beginning of the name of dummy variables
177# (i.e. not used).
178dummy-variables-rgx=_$|dummy
179
180# List of additional names supposed to be defined in builtins. Remember that
181# you should avoid to define new builtins when possible.
182additional-builtins=
183
184
185[FORMAT]
186
187# Maximum number of characters on a single line.
188max-line-length=100
189
190# Regexp for a line that is allowed to be longer than the limit.
191ignore-long-lines=^\s*(# )?<?https?://\S+>?$
192
193# Allow the body of an if to be on the same line as the test if there is no
194# else.
195single-line-if-stmt=no
196
197# List of optional constructs for which whitespace checking is disabled
198no-space-check=trailing-comma,dict-separator
199
200# Maximum number of lines in a module
201max-module-lines=1000
202
203# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
204# tab).
205indent-string='  '
206
207
208[IMPORTS]
209
210# Deprecated modules which should not be used, separated by a comma
211deprecated-modules=regsub,TERMIOS,Bastion,rexec
212
213# Create a graph of every (i.e. internal and external) dependencies in the
214# given file (report RP0402 must not be disabled)
215import-graph=
216
217# Create a graph of external dependencies in the given file (report RP0402 must
218# not be disabled)
219ext-import-graph=
220
221# Create a graph of internal dependencies in the given file (report RP0402 must
222# not be disabled)
223int-import-graph=
224
225
226[DESIGN]
227
228# Maximum number of arguments for function / method
229max-args=5
230
231# Argument names that match this expression will be ignored. Default to name
232# with leading underscore
233ignored-argument-names=_.*
234
235# Maximum number of locals for function / method body
236max-locals=15
237
238# Maximum number of return / yield for function / method body
239max-returns=6
240
241# Maximum number of branch for function / method body
242max-branches=12
243
244# Maximum number of statements in function / method body
245max-statements=50
246
247# Maximum number of parents for a class (see R0901).
248max-parents=7
249
250# Maximum number of attributes for a class (see R0902).
251max-attributes=7
252
253# Minimum number of public methods for a class (see R0903).
254min-public-methods=2
255
256# Maximum number of public methods for a class (see R0904).
257max-public-methods=20
258
259
260[CLASSES]
261
262# List of interface methods to ignore, separated by a comma. This is used for
263# instance to not check methods defines in Zope's Interface base class.
264ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
265
266# List of method names used to declare (i.e. assign) instance attributes.
267defining-attr-methods=__init__,__new__,setUp
268
269# List of valid names for the first argument in a class method.
270valid-classmethod-first-arg=cls
271
272# List of valid names for the first argument in a metaclass class method.
273valid-metaclass-classmethod-first-arg=mcs
274
275
276[EXCEPTIONS]
277
278# Exceptions that will emit a warning when being caught. Defaults to
279# "Exception"
280overgeneral-exceptions=Exception
281