source: pylintrc

Last change on this file was 1704:97e1e1d0456c, checked in by Stefan Schwarzer <sschwarzer@…>, 9 months ago
Add `locally-disabled` to checks to exclude These messages clutter the output.
File size: 8.0 KB
Line 
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"
41#disable=
42disable=bad-continuation, locally-disabled, invalid-name, star-args
43
44
45[REPORTS]
46
47# Set the output format. Available formats are text, parseable, colorized, msvs
48# (visual studio) and html. You can also give a reporter class, eg
49# mypackage.mymodule.MyReporterClass.
50output-format=text
51
52# Include message's id in output
53include-ids=no
54
55# Include symbolic ids of messages in output
56symbols=no
57
58# Put messages in a separate file for each module / package specified on the
59# command line instead of printing them on stdout. Reports (if any) will be
60# written in a file name "pylint_global.[txt|html]".
61files-output=no
62
63# Tells whether to display a full report or only the messages
64reports=no
65
66# Python expression which should return a note less than 10 (10 is the highest
67# note). You have access to the variables errors warning, statement which
68# respectively contain the number of errors / warnings messages and the total
69# number of statements analyzed. This is used by the global evaluation report
70# (RP0004).
71evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
72
73# Add a comment according to your evaluation note. This is used by the global
74# evaluation report (RP0004).
75comment=no
76
77
78[FORMAT]
79
80# Maximum number of characters on a single line.
81max-line-length=79
82
83# Maximum number of lines in a module
84max-module-lines=1000
85
86# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
87# tab).
88indent-string='    '
89
90# Regexp for a line that is allowed to be longer than the limit.
91ignore-long-lines=^\s*(# )?<?https?://\S+>?$
92
93[BASIC]
94
95# Required attributes for module, separated by a comma
96required-attributes=
97
98# List of builtins function names that should not be used, separated by a comma
99bad-functions=map,filter,apply,input
100
101# Regular expression which should only match correct module names
102module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
103
104# Regular expression which should only match correct module level names
105const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
106
107# Regular expression which should only match correct class names
108class-rgx=[A-Z_][a-zA-Z0-9]+$
109
110# Regular expression which should only match correct function names
111function-rgx=[a-z_][a-z0-9_]{2,30}$
112
113# Regular expression which should only match correct method names
114method-rgx=[a-z_][a-z0-9_]{2,30}$
115
116# Regular expression which should only match correct instance attribute names
117attr-rgx=[a-z_][a-z0-9_]{2,30}$
118
119# Regular expression which should only match correct argument names
120argument-rgx=[a-z_][a-z0-9_]{2,30}$
121
122# Regular expression which should only match correct variable names
123variable-rgx=[a-z_][a-z0-9_]{2,30}$
124
125# Regular expression which should only match correct list comprehension /
126# generator expression variable names
127inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
128
129# Good variable names which should always be accepted, separated by a comma
130good-names=i,j,k,ex,Run,_
131
132# Bad variable names which should always be refused, separated by a comma
133bad-names=foo,bar,baz,toto,tutu,tata
134
135# Regular expression which should only match functions or classes name which do
136# not require a docstring
137no-docstring-rgx=__.*__
138
139
140[SIMILARITIES]
141
142# Minimum lines number of a similarity.
143min-similarity-lines=4
144
145# Ignore comments when computing similarities.
146ignore-comments=yes
147
148# Ignore docstrings when computing similarities.
149ignore-docstrings=yes
150
151# Ignore imports when computing similarities.
152ignore-imports=no
153
154
155[MISCELLANEOUS]
156
157# List of note tags to take in consideration, separated by a comma.
158notes=FIXME,XXX,TODO
159
160
161[TYPECHECK]
162
163# Tells whether missing members accessed in mixin class should be ignored. A
164# mixin class is detected if its name ends with "mixin" (case insensitive).
165ignore-mixin-members=yes
166
167# List of classes names for which member attributes should not be checked
168# (useful for classes with attributes dynamically set).
169ignored-classes=SQLObject
170
171# When zope mode is activated, add a predefined set of Zope acquired attributes
172# to generated-members.
173zope=no
174
175# List of members which are set dynamically and missed by pylint inference
176# system, and so shouldn't trigger E0201 when accessed. Python regular
177# expressions are accepted.
178generated-members=REQUEST,acl_users,aq_parent
179
180
181[VARIABLES]
182
183# Tells whether we should check for unused import in __init__ files.
184init-import=no
185
186# A regular expression matching the beginning of the name of dummy variables
187# (i.e. not used).
188dummy-variables-rgx=_|dummy
189
190# List of additional names supposed to be defined in builtins. Remember that
191# you should avoid to define new builtins when possible.
192additional-builtins=
193
194
195[IMPORTS]
196
197# Deprecated modules which should not be used, separated by a comma
198deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
199
200# Create a graph of every (i.e. internal and external) dependencies in the
201# given file (report RP0402 must not be disabled)
202import-graph=
203
204# Create a graph of external dependencies in the given file (report RP0402 must
205# not be disabled)
206ext-import-graph=
207
208# Create a graph of internal dependencies in the given file (report RP0402 must
209# not be disabled)
210int-import-graph=
211
212
213[DESIGN]
214
215# Maximum number of arguments for function / method
216max-args=5
217
218# Argument names that match this expression will be ignored. Default to name
219# with leading underscore
220ignored-argument-names=_.*
221
222# Maximum number of locals for function / method body
223max-locals=15
224
225# Maximum number of return / yield for function / method body
226max-returns=6
227
228# Maximum number of branch for function / method body
229max-branchs=12
230
231# Maximum number of statements in function / method body
232max-statements=50
233
234# Maximum number of parents for a class (see R0901).
235max-parents=7
236
237# Maximum number of attributes for a class (see R0902).
238max-attributes=7
239
240# Minimum number of public methods for a class (see R0903).
241min-public-methods=2
242
243# Maximum number of public methods for a class (see R0904).
244max-public-methods=20
245
246
247[CLASSES]
248
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.
251ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
252
253# List of method names used to declare (i.e. assign) instance attributes.
254defining-attr-methods=__init__,__new__,setUp
255
256# List of valid names for the first argument in a class method.
257valid-classmethod-first-arg=cls
258
259# List of valid names for the first argument in a metaclass class method.
260valid-metaclass-classmethod-first-arg=mcs
261
262
263[EXCEPTIONS]
264
265# Exceptions that will emit a warning when being caught. Defaults to
266# "Exception"
267overgeneral-exceptions=Exception
Note: See TracBrowser for help on using the repository browser.