# This is a configuration file for pylint to be used for checking the

# quality of the Melange code

# 

# just run:

#   scripts/pylint/do_pylint.sh

[MASTER]

# 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=.svn

# Pickle collected data for later comparisons.

persistent=yes

# 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=design

# 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).

# List of all available ids: http://www.logilab.org/card/pylintfeatures

# Potential messages that might be added later include:

# C0302,R0201

# Disabled messages:

# W0613: Unused argument %r Used when a function or method argument is not used.

# W0622: Redefining built-in %r Used when a variable or function override a built-in.

# W0232: Class has no __init__ method Used when a class has no __init__ method, neither 

#        its parent classes.

# W0142: Used * or * magic* Used when a function or method is called using *args or **kwargs

#        to dispatch arguments. This doesn't improve readility and should be used with care.

# W0102: Dangerous default value %s as argument Used when a mutable value as list or dictionary 

#        is detected in a default value for an argument.

# W0212: Access to a protected member %s of a client class Used when a protected member 

#        (i.e. class member with a name beginning with an underscore) is access outside the class 

#        or a descendant of the class where it's defined.

# R0201: Method could be a function. Used when a method doesn't use its bound instance, and so 

#        could be written as a function.

# R0801: Similar lines in %s files. Indicates that a set of similar lines has been detected 

#        among multiple file. This usually means that the code should be refactored to avoid this

#        duplication.

# E1103: %s %r has no %r member (but some types could not be inferred) Used when a variable is 

#        accessed for an unexistant member, but astng was not able to interpret all possible 

#        types of this variable.

# E1101: %s %r has no %r member Used when a variable is accessed for an unexistant member.

# C0302: Too many lines in module (%s) Used when a module has too much lines, reducing 

#        its readibility.

# W0602: Using global for %r but no assigment is done Used when a variable is defined through 

#        the "global" statement but no assigment to this variable is done.

# W0603: Using the global statement Used when you use the "global" statement to update 

#        a global variable. PyLint just try to discourage this usage. That doesn't mean 

#        you can not use it !

# W0704: Except doesn't do anything Used when an except clause does nothing but "pass" 

#        and there is no "else" clause.

# I0011: Locally disabling %s Used when an inline option disable a message or a messages category.

disable-msg=W0613,W0622,W0232,W0142,W0102,W0212,R0201,R0801,E1103,E1101,C0302,W0602,W0603,W0704,I0011

[REPORTS]

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

# (visual studio) and html

output-format=text

# 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=yes

# 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

# * required module attributes

# * dangerous default values as arguments

# * redefinition of function / method / class

# * uses of the global statement

# 

[BASIC]

# Required attributes for module, separated by a comma

required-attributes=

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

# not require a docstring

no-docstring-rgx=__.*__

# Regular expression which should only match correct module names

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

# Regular expression which should only match correct module level names

const-rgx=(([A-Z_][A-Z1-9_]*)|(__.*__)|([a-z_][a-z0-9_]*))$

# Regular expression which should only match correct class names

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

# Regular expression which should only match correct function names

function-rgx=[a-z_][a-zA-Z0-9_]{2,40}$

# Regular expression which should only match correct method names

method-rgx=[a-z_][a-zA-Z0-9_]{2,40}$

# Regular expression which should only match correct instance attribute names

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

#alternative

#attr-rgx=([a-z_][a-z0-9_]{2,30}|([a-z_][a-zA-Z0-9]{2,30}))$

# Regular expression which should only match correct argument names

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

# Regular expression which should only match correct variable names

variable-rgx=[a-z_][a-zA-Z0-9_]{1,30}$

# Regular expression which should only match correct list comprehension /

# generator expression variable names

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

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

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

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

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

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

bad-functions=map,filter,apply,input

# try to find bugs in the code using type inference

# 

[TYPECHECK]

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

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

ignore-mixin-members=yes

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

# (useful for classes with attributes dynamicaly set).

ignored-classes=SQLObject

# When zope mode is activated, consider the acquired-members option to ignore

# access to some undefined attributes.

zope=no

# List of members which are usually get through zope's acquisition mecanism and

# so shouldn't trigger E0201 when accessed (need zope=yes to be considered).

acquired-members=REQUEST,acl_users,aq_parent

# checks for

# * unused variables / imports

# * undefined variables

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

# * use of variable before assigment

# 

[VARIABLES]

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

init-import=no

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

dummy-variables-rgx=_|dummy

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

# you should avoid to define new builtins when possible.

additional-builtins=

# checks for :

# * methods without self as first argument

# * overridden methods signature

# * access only to existant members via self

# * attributes not defined in the __init__ method

# * supported interfaces implementation

# * unreachable code

# 

[CLASSES]

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

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

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

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

defining-attr-methods=__init__,__new__,setUp

# checks for

# * external modules dependencies

# * relative / wildcard imports

# * cyclic imports

# * uses of deprecated modules

# 

[IMPORTS]

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

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

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

# given file (report R0402 must not be disabled)

import-graph=

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

# not be disabled)

ext-import-graph=

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

# not be disabled)

int-import-graph=

# checks for :

# * unauthorized constructions

# * strict indentation

# * line length

# * use of <> instead of !=

# 

[FORMAT]

# Maximum number of characters on a single line.

max-line-length=80

# Maximum number of lines in a module

max-module-lines=1000

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

# tab).

indent-string='  '

# checks for:

# * warning notes in the code like TODO

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

# 

[MISCELLANEOUS]

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

notes=TODO

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

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

# problems.

# 

[SIMILARITIES]

# Minimum lines number of a similarity.

min-similarity-lines=4

# Ignore comments when computing similarities.

ignore-comments=yes

# Ignore docstrings when computing similarities.

ignore-docstrings=yes