~sambuddhabasu1/mailman/fix_mailman_run

~sambuddhabasu1/mailman/fix_mailman_run_error

Viewing changes to pylint.rc

Committer: Barry Warsaw
Date: 2009-06-30 10:14:49 UTC
Revision ID: barry@list.org-20090630101449-hn6q37pycyughgpa

Integrate pylint and Sphinx documentation buildout targets.

* bin/lint.sh runs the linter (be very afraid)
* bin/docs runs Sphinx over the documentation (needs refining)

src/sphinxconf.py is an ugly hack to hook the buildout recipe so that we can
ignore text files in our tree that are not documentation.

files added:
.buildout

.buildout/bin

.buildout/bin/lint.sh.in

pylint.rc

src/mailman/docs/README.txt

src/sphinxconf.py

files modified:
buildout.cfg

setup.py

Show diffs side-by-side

added added

removed removed

pylint.rc

# lint Python modules using external checkers.

# This is the main checker controlling the other ones and the reports

# generation. It is itself both a raw checker and an astng checker in order

# to:

# * handle message activation / deactivation at the module level

# * handle some basic but necessary stats'data (number of classes, methods...)

[MASTER]

# Specify a configuration file.

#rcfile=

# Python code to execute, usually for sys.path manipulation such as

# pygtk.require().

#init-hook=

# Profiled execution.

profile=no

# Add <file or directory> to the black list. It should be a base name, not a

# path. You may set this option multiple times.

ignore=CVS

# Pickle collected data for later comparisons.

persistent=no

# Set the cache size for astng objects.

cache-size=500

# List of plugins (as comma separated values of python modules names) to load,

# usually to register additional checkers.

load-plugins=

[MESSAGES CONTROL]

# Enable only checker(s) with the given id(s). This option conflicts with the

# disable-checker option

#enable-checker=

# Enable all checker(s) except those with the given id(s). This option

# conflicts with the enable-checker option

#disable-checker=

# Enable all messages in the listed categories.

#enable-msg-cat=

# Disable all messages in the listed categories.

#disable-msg-cat=

# Enable the message(s) with the given id(s).

#enable-msg=

# Disable the message(s) with the given id(s).

# I0011: *Locally disabling %s*

disable-msg=I0011

[REPORTS]

# Set the output format. Available formats are text, parseable, colorized, msvs

# (visual studio) and html

output-format=parseable

# Include message's id in output

include-ids=yes

# Put messages in a separate file for each module / package specified on the

# command line instead of printing them on stdout. Reports (if any) will be

# written in a file name "pylint_global.[txt|html]".

files-output=no

# Tells wether to display a full report or only the messages

reports=no

# Python expression which should return a note less than 10 (10 is the highest

# note). You have access to the variables errors warning, statement which

# respectivly contain the number of errors / warnings messages and the total

# number of statements analyzed. This is used by the global evaluation report

# (R0004).

evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)

# Add a comment according to your evaluation note. This is used by the global

# evaluation report (R0004).

comment=no

# Enable the report(s) with the given id(s).

#enable-report=

# Disable the report(s) with the given id(s).

#disable-report=

# checks for :

# * doc strings

# * modules / classes / functions / methods / arguments / variables name

# * number of arguments, local variables, branchs, returns and statements in

# functions, methods

100

# * required module attributes

101

# * dangerous default values as arguments

102

# * redefinition of function / method / class

103

# * uses of the global statement

104

105

[BASIC]

106

107

# Required attributes for module, separated by a comma

108

required-attributes=

109

110

# Regular expression which should only match functions or classes name which do

111

# not require a docstring

112

no-docstring-rgx=__.*__

113

114

# Regular expression which should only match correct module names

115

module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$

116

117

# Regular expression which should only match correct module level names

118

const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$

119

120

# Regular expression which should only match correct class names

121

class-rgx=[A-Z_][a-zA-Z0-9]+$

122

123

# Regular expression which should only match correct function names

124

function-rgx=[a-z_][a-z0-9_]{2,30}$

125

126

# Regular expression which should only match correct method names

127

method-rgx=[a-z_][a-z0-9_]{2,30}$

128

129

# Regular expression which should only match correct instance attribute names

130

attr-rgx=[a-z_][a-z0-9_]{2,30}$

131

132

# Regular expression which should only match correct argument names

133

argument-rgx=[a-z_][a-z0-9_]{2,30}$

134

135

# Regular expression which should only match correct variable names

136

variable-rgx=[a-z_][a-z0-9_]{2,30}$

137

138

# Regular expression which should only match correct list comprehension /

139

# generator expression variable names

140

inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$

141

142

# Good variable names which should always be accepted, separated by a comma

143

good-names=i,j,k,ex,Run,_

144

145

# Bad variable names which should always be refused, separated by a comma

146

bad-names=foo,bar,baz,toto,tutu,tata

147

148

# List of builtins function names that should not be used, separated by a comma

149

bad-functions=map,filter,apply,input

150

151

152

# try to find bugs in the code using type inference

153

154

[TYPECHECK]

155

156

# Tells wether missing members accessed in mixin class should be ignored. A

157

# mixin class is detected if its name ends with "mixin" (case insensitive).

158

ignore-mixin-members=yes

159

160

# List of classes names for which member attributes should not be checked

161

# (useful for classes with attributes dynamicaly set).

162

ignored-classes=SQLObject

163

164

# When zope mode is activated, add a predefined set of Zope acquired attributes

165

# to generated-members.

166

zope=no

167

168

# List of members which are set dynamically and missed by pylint inference

169

# system, and so shouldn't trigger E0201 when accessed.

170

generated-members=REQUEST,acl_users,aq_parent

171

172

173

# checks for

174

# * unused variables / imports

175

# * undefined variables

176

# * redefinition of variable from builtins or from an outer scope

177

# * use of variable before assigment

178

179

[VARIABLES]

180

181

# Tells wether we should check for unused import in __init__ files.

182

init-import=no

183

184

# A regular expression matching names used for dummy variables (i.e. not used).

185

dummy-variables-rgx=_|dummy

186

187

# List of additional names supposed to be defined in builtins. Remember that

188

# you should avoid to define new builtins when possible.

189

additional-builtins=

190

191

192

# checks for :

193

# * methods without self as first argument

194

# * overridden methods signature

195

# * access only to existant members via self

196

# * attributes not defined in the __init__ method

197

# * supported interfaces implementation

198

# * unreachable code

199

200

[CLASSES]

201

202

# List of interface methods to ignore, separated by a comma. This is used for

203

# instance to not check methods defines in Zope's Interface base class.

204

ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by

205

206

# List of method names used to declare (i.e. assign) instance attributes.

207

defining-attr-methods=__init__,__new__,setUp

208

209

210

# checks for sign of poor/misdesign:

211

# * number of methods, attributes, local variables...

212

# * size, complexity of functions, methods

213

214

[DESIGN]

215

216

# Maximum number of arguments for function / method

217

max-args=5

218

219

# Maximum number of locals for function / method body

220

max-locals=15

221

222

# Maximum number of return / yield for function / method body

223

max-returns=6

224

225

# Maximum number of branch for function / method body

226

max-branchs=12

227

228

# Maximum number of statements in function / method body

229

max-statements=50

230

231

# Maximum number of parents for a class (see R0901).

232

max-parents=7

233

234

# Maximum number of attributes for a class (see R0902).

235

max-attributes=7

236

237

# Minimum number of public methods for a class (see R0903).

238

min-public-methods=2

239

240

# Maximum number of public methods for a class (see R0904).

241

max-public-methods=50

242

243

244

# checks for

245

# * external modules dependencies

246

# * relative / wildcard imports

247

# * cyclic imports

248

# * uses of deprecated modules

249

250

[IMPORTS]

251

252

# Deprecated modules which should not be used, separated by a comma

253

deprecated-modules=regsub,string,TERMIOS,Bastion,rexec

254

255

# Create a graph of every (i.e. internal and external) dependencies in the

256

# given file (report R0402 must not be disabled)

257

import-graph=

258

259

# Create a graph of external dependencies in the given file (report R0402 must

260

# not be disabled)

261

ext-import-graph=

262

263

# Create a graph of internal dependencies in the given file (report R0402 must

264

# not be disabled)

265

int-import-graph=

266

267

268

# checks for :

269

# * unauthorized constructions

270

# * strict indentation

271

# * line length

272

# * use of <> instead of !=

273

274

[FORMAT]

275

276

# Maximum number of characters on a single line.

277

max-line-length=80

278

279

# Maximum number of lines in a module

280

max-module-lines=1000

281

282

# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1

283

# tab).

284

indent-string=' '

285

286

287

# checks for:

288

# * warning notes in the code like FIXME, XXX

289

# * PEP 263: source code with non ascii character but no encoding declaration

290

291

[MISCELLANEOUS]

292

293

# List of note tags to take in consideration, separated by a comma.

294

notes=FIXME,XXX,TODO

295

296

297

# checks for similarities and duplicated code. This computation may be

298

# memory / CPU intensive, so you should disable it if you experiments some

299

# problems.

300

301

[SIMILARITIES]

302

303

# Minimum lines number of a similarity.

304

min-similarity-lines=4

305

306

# Ignore comments when computing similarities.

307

ignore-comments=yes

308

309

# Ignore docstrings when computing similarities.

310

ignore-docstrings=yes

Older »