1
# This is a configuration file for pylint.
3
# (C) 2011-2013 by the GRASS Development Team
5
# This program is free software under the GNU General Public License
6
# (>=v2). Read the file COPYING that comes with GRASS for details.
8
# author: Vaclav Petras <wenzeslaus gmail.com>
10
# This configuration should work for all Python library, Python scripts and
12
# Example for gui/wxpython:
13
# pylint --rcfile=../../tools/pylintrc.txt -f parseable -r n -i y lmgr/
15
# A lot of errors need to be ignored now to avoid a large number of messages.
16
# Files need to be fixed one by one (partialy without this configuration).
18
# Save this file ~/.pylintrc on Linux
23
# Specify a configuration file.
26
# Python code to execute, usually for sys.path manipulation such as
33
# Add files or directories to the blacklist. They should be base names, not
37
# Pickle collected data for later comparisons.
40
# List of plugins (as comma separated values of python modules names) to load,
41
# usually to register additional checkers.
47
# Enable the message, report, category or checker with the given id(s). You can
48
# either give multiple identifier separated by comma (,) or put this option
52
# Disable the message, report, category or checker with the given id(s). You
53
# can either give multiple identifier separated by comma (,) or put this option
54
# multiple time (only on the command line, not in the configuration file where
55
# it should appear only once).
56
disable=E1103,W0141,W0201,W0311,W0312,W0612,W0613,W0614,W0622,R0201,R0901,R0904,C0103,C0111,C0322,C0323,C0324,F0401
58
# E1103: caused probably by wxPython
59
# W0613: unused arg -> solve somewhere here using event
60
# C0103: names not defined
61
# W0201: define methods used for init
62
# W0622: Redefining built-in %r: needs complex solution
64
# E1101: %s %r has no %r member: why?
65
# R0201: can be solved
66
# F0401: somthing is possible to import only in grass
71
# Set the output format. Available formats are text, parseable, colorized, msvs
72
# (visual studio) and html
75
# Include message's id in output
78
# Put messages in a separate file for each module / package specified on the
79
# command line instead of printing them on stdout. Reports (if any) will be
80
# written in a file name "pylint_global.[txt|html]".
83
# Tells whether to display a full report or only the messages
86
# Python expression which should return a note less than 10 (10 is the highest
87
# note). You have access to the variables errors warning, statement which
88
# respectively contain the number of errors / warnings messages and the total
89
# number of statements analyzed. This is used by the global evaluation report
91
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
93
# Add a comment according to your evaluation note. This is used by the global
94
# evaluation report (RP0004).
100
# Tells whether we should check for unused import in __init__ files.
103
# A regular expression matching the beginning of the name of dummy variables
105
dummy-variables-rgx=dummy|unused
107
# List of additional names supposed to be defined in builtins. Remember that
108
# you should avoid to define new builtins when possible.
109
additional-builtins=_
114
# Required attributes for module, separated by a comma
117
# List of builtins function names that should not be used, separated by a comma
118
bad-functions=map,filter,apply,input
120
# Regular expression which should only match correct module names
121
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
123
# Regular expression which should only match correct module level names
124
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
126
# Regular expression which should only match correct class names
127
class-rgx=[A-Z_][a-zA-Z0-9]+$
129
# Regular expression which should only match correct function names
130
function-rgx=[a-z_][a-zA-Z0-9_]{2,30}$
132
# Regular expression which should only match correct method names
133
method-rgx=[a-zA-Z_][a-zA-Z0-9_]{2,30}$
135
# Regular expression which should only match correct instance attribute names
136
attr-rgx=[a-z_][a-zA-Z0-9_]{2,30}$
138
# Regular expression which should only match correct argument names
139
argument-rgx=[a-z_][a-zA-Z0-9_]{2,30}$
141
# Regular expression which should only match correct variable names
142
variable-rgx=[a-z_][a-zA-Z0-9_]{2,30}$|[a-z]
144
# Regular expression which should only match correct list comprehension /
145
# generator expression variable names
146
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
148
# Good variable names which should always be accepted, separated by a comma
149
good-names=i,j,_,x,y,z,N,E,S,W,id
151
# Bad variable names which should always be refused, separated by a comma
152
bad-names=foo,bar,baz,toto,tutu,tata
154
# Regular expression which should only match functions or classes name which do
155
# not require a docstring
156
no-docstring-rgx=__.*__
161
# List of note tags to take in consideration, separated by a comma.
162
notes=FIXME,TODO,\\todo,@todo
164
# general regexp for convention, warning etc. would be great
168
# Tells whether missing members accessed in mixin class should be ignored. A
169
# mixin class is detected if its name ends with "mixin" (case insensitive).
170
ignore-mixin-members=yes
172
# List of classes names for which member attributes should not be checked
173
# (useful for classes with attributes dynamically set).
174
ignored-classes=SQLObject
176
# When zope mode is activated, add a predefined set of Zope acquired attributes
177
# to generated-members.
180
# List of members which are set dynamically and missed by pylint inference
181
# system, and so shouldn't trigger E0201 when accessed. Python regular
182
# expressions are accepted.
183
generated-members=REQUEST,acl_users,aq_parent
188
# Maximum number of characters on a single line.
192
# Maximum number of lines in a module
193
# Increased from 1000.
194
max-module-lines=2000
196
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
203
# Minimum lines number of a similarity.
204
min-similarity-lines=4
206
# Ignore comments when computing similarities.
209
# Ignore docstrings when computing similarities.
210
ignore-docstrings=yes
215
# Maximum number of arguments for function / method
219
# Argument names that match this expression will be ignored. Default to name
220
# with leading underscore
221
ignored-argument-names=_.*|event
223
# Maximum number of locals for function / method body
227
# Maximum number of return / yield for function / method body
230
# Maximum number of branch for function / method body
234
# Maximum number of statements in function / method body
237
# Maximum number of parents for a class (see R0901).
240
# Maximum number of attributes for a class (see R0902).
244
# Minimum number of public methods for a class (see R0903).
247
# Maximum number of public methods for a class (see R0904).
249
max-public-methods=30
254
# Deprecated modules which should not be used, separated by a comma
255
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
257
# Create a graph of every (i.e. internal and external) dependencies in the
258
# given file (report RP0402 must not be disabled)
261
# Create a graph of external dependencies in the given file (report RP0402 must
265
# Create a graph of internal dependencies in the given file (report RP0402 must
272
# List of interface methods to ignore, separated by a comma. This is used for
273
# instance to not check methods defines in Zope's Interface base class.
274
ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
276
# List of method names used to declare (i.e. assign) instance attributes.
277
defining-attr-methods=__init__,__new__,setUp
279
# List of valid names for the first argument in a class method.
280
valid-classmethod-first-arg=cls
285
# Exceptions that will emit a warning when being caught. Defaults to
287
overgeneral-exceptions=Exception