michael@0: [MASTER]
michael@0: 
michael@0: # Specify a configuration file.
michael@0: #rcfile=
michael@0: 
michael@0: # Python code to execute, usually for sys.path manipulation such as
michael@0: # pygtk.require().
michael@0: #init-hook=
michael@0: 
michael@0: # Profiled execution.
michael@0: profile=no
michael@0: 
michael@0: # Add files or directories to the blacklist. They should be base names, not
michael@0: # paths.
michael@0: ignore=CVS
michael@0: 
michael@0: # Pickle collected data for later comparisons.
michael@0: persistent=yes
michael@0: 
michael@0: # List of plugins (as comma separated values of python modules names) to load,
michael@0: # usually to register additional checkers.
michael@0: load-plugins=
michael@0: 
michael@0: 
michael@0: [MESSAGES CONTROL]
michael@0: 
michael@0: # Enable the message, report, category or checker with the given id(s). You can
michael@0: # either give multiple identifier separated by comma (,) or put this option
michael@0: # multiple time.
michael@0: #enable=
michael@0: 
michael@0: # Disable the message, report, category or checker with the given id(s). You
michael@0: # can either give multiple identifier separated by comma (,) or put this option
michael@0: # multiple time (only on the command line, not in the configuration file where
michael@0: # it should appear only once).
michael@0: # C0103: Invalid name "NN" (should match [a-z_][a-z0-9_]{2,30}$)
michael@0: # C0111: Missing docstring
michael@0: # C0302: Too many lines in module (NN)
michael@0: # R0902: Too many instance attributes (N/7)
michael@0: # R0903: Too few public methods (N/2)
michael@0: # R0904: Too many public methods (NN/20)
michael@0: # R0912: Too many branches (NN/12)
michael@0: # R0913: Too many arguments (N/5)
michael@0: # R0914: Too many local variables (NN/15)
michael@0: # R0915: Too many statements (NN/50)
michael@0: # W0141: Used builtin function 'map'
michael@0: # W0142: Used * or ** magic
michael@0: # W0232: Class has no __init__ method
michael@0: # W0511: TODO
michael@0: # W0603: Using the global statement
michael@0: #
michael@0: # These should be enabled eventually:
michael@0: # C0112: Empty docstring
michael@0: # C0301: Line too long (NN/80)
michael@0: # C0321: More than one statement on single line
michael@0: # C0322: Operator not preceded by a space
michael@0: # C0323: Operator not followed by a space
michael@0: # C0324: Comma not followed by a space
michael@0: # E0101: Explicit return in __init__
michael@0: # E0102: function already defined line NN
michael@0: # E1002: Use of super on an old style class
michael@0: # E1101: Instance of 'XX' has no 'YY' member
michael@0: # E1103: Instance of 'XX' has no 'XX' member (but some types could not be inferred)
michael@0: # E0602: Undefined variable 'XX'
michael@0: # F0401: Unable to import 'XX'
michael@0: # R0201: Method could be a function
michael@0: # R0801: Similar lines in N files
michael@0: # W0102: Dangerous default value {} as argument
michael@0: # W0104: Statement seems to have no effect
michael@0: # W0105: String statement has no effect
michael@0: # W0108: Lambda may not be necessary
michael@0: # W0201: Attribute 'XX' defined outside __init__
michael@0: # W0212: Access to a protected member XX of a client class
michael@0: # W0221: Arguments number differs from overridden method
michael@0: # W0223: Method 'XX' is abstract in class 'YY' but is not overridden
michael@0: # W0231: __init__ method from base class 'XX' is not called
michael@0: # W0301: Unnecessary semicolon
michael@0: # W0311: Bad indentation. Found NN spaces, expected NN
michael@0: # W0401: Wildcard import XX
michael@0: # W0402: Uses of a deprecated module 'string'
michael@0: # W0403: Relative import 'XX', should be 'YY.XX'
michael@0: # W0404: Reimport 'XX' (imported line NN)
michael@0: # W0601: Global variable 'XX' undefined at the module level
michael@0: # W0602: Using global for 'XX' but no assignment is done
michael@0: # W0611: Unused import pprint
michael@0: # W0612: Unused variable 'XX'
michael@0: # W0613: Unused argument 'XX'
michael@0: # W0614: Unused import XX from wildcard import
michael@0: # W0621: Redefining name 'XX' from outer scope (line NN)
michael@0: # W0622: Redefining built-in 'NN'
michael@0: # W0631: Using possibly undefined loop variable 'XX'
michael@0: # W0701: Raising a string exception
michael@0: # W0702: No exception type(s) specified
michael@0: disable=C0103,C0111,C0302,R0902,R0903,R0904,R0912,R0913,R0914,R0915,W0141,W0142,W0232,W0511,W0603,C0112,C0301,C0321,C0322,C0323,C0324,E0101,E0102,E1002,E1101,E1103,E0602,F0401,R0201,R0801,W0102,W0104,W0105,W0108,W0201,W0212,W0221,W0223,W0231,W0301,W0311,W0401,W0402,W0403,W0404,W0601,W0602,W0611,W0612,W0613,W0614,W0621,W0622,W0631,W0701,W0702
michael@0: 
michael@0: 
michael@0: [REPORTS]
michael@0: 
michael@0: # Set the output format. Available formats are text, parseable, colorized, msvs
michael@0: # (visual studio) and html
michael@0: output-format=text
michael@0: 
michael@0: # Include message's id in output
michael@0: include-ids=yes
michael@0: 
michael@0: # Put messages in a separate file for each module / package specified on the
michael@0: # command line instead of printing them on stdout. Reports (if any) will be
michael@0: # written in a file name "pylint_global.[txt|html]".
michael@0: files-output=no
michael@0: 
michael@0: # Tells whether to display a full report or only the messages
michael@0: reports=no
michael@0: 
michael@0: # Python expression which should return a note less than 10 (10 is the highest
michael@0: # note). You have access to the variables errors warning, statement which
michael@0: # respectively contain the number of errors / warnings messages and the total
michael@0: # number of statements analyzed. This is used by the global evaluation report
michael@0: # (RP0004).
michael@0: evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
michael@0: 
michael@0: # Add a comment according to your evaluation note. This is used by the global
michael@0: # evaluation report (RP0004).
michael@0: comment=no
michael@0: 
michael@0: 
michael@0: [VARIABLES]
michael@0: 
michael@0: # Tells whether we should check for unused import in __init__ files.
michael@0: init-import=no
michael@0: 
michael@0: # A regular expression matching the beginning of the name of dummy variables
michael@0: # (i.e. not used).
michael@0: dummy-variables-rgx=_|dummy
michael@0: 
michael@0: # List of additional names supposed to be defined in builtins. Remember that
michael@0: # you should avoid to define new builtins when possible.
michael@0: additional-builtins=
michael@0: 
michael@0: 
michael@0: [TYPECHECK]
michael@0: 
michael@0: # Tells whether missing members accessed in mixin class should be ignored. A
michael@0: # mixin class is detected if its name ends with "mixin" (case insensitive).
michael@0: ignore-mixin-members=yes
michael@0: 
michael@0: # List of classes names for which member attributes should not be checked
michael@0: # (useful for classes with attributes dynamically set).
michael@0: ignored-classes=SQLObject
michael@0: 
michael@0: # When zope mode is activated, add a predefined set of Zope acquired attributes
michael@0: # to generated-members.
michael@0: zope=no
michael@0: 
michael@0: # List of members which are set dynamically and missed by pylint inference
michael@0: # system, and so shouldn't trigger E0201 when accessed. Python regular
michael@0: # expressions are accepted.
michael@0: generated-members=REQUEST,acl_users,aq_parent
michael@0: 
michael@0: 
michael@0: [MISCELLANEOUS]
michael@0: 
michael@0: # List of note tags to take in consideration, separated by a comma.
michael@0: notes=FIXME,XXX,TODO
michael@0: 
michael@0: 
michael@0: [SIMILARITIES]
michael@0: 
michael@0: # Minimum lines number of a similarity.
michael@0: min-similarity-lines=4
michael@0: 
michael@0: # Ignore comments when computing similarities.
michael@0: ignore-comments=yes
michael@0: 
michael@0: # Ignore docstrings when computing similarities.
michael@0: ignore-docstrings=yes
michael@0: 
michael@0: 
michael@0: [FORMAT]
michael@0: 
michael@0: # Maximum number of characters on a single line.
michael@0: max-line-length=80
michael@0: 
michael@0: # Maximum number of lines in a module
michael@0: max-module-lines=1000
michael@0: 
michael@0: # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
michael@0: # tab).
michael@0: indent-string='  '
michael@0: 
michael@0: 
michael@0: [BASIC]
michael@0: 
michael@0: # Required attributes for module, separated by a comma
michael@0: required-attributes=
michael@0: 
michael@0: # List of builtins function names that should not be used, separated by a comma
michael@0: bad-functions=map,filter,apply,input
michael@0: 
michael@0: # Regular expression which should only match correct module names
michael@0: module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
michael@0: 
michael@0: # Regular expression which should only match correct module level names
michael@0: const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
michael@0: 
michael@0: # Regular expression which should only match correct class names
michael@0: class-rgx=[A-Z_][a-zA-Z0-9]+$
michael@0: 
michael@0: # Regular expression which should only match correct function names
michael@0: function-rgx=[a-z_][a-z0-9_]{2,30}$
michael@0: 
michael@0: # Regular expression which should only match correct method names
michael@0: method-rgx=[a-z_][a-z0-9_]{2,30}$
michael@0: 
michael@0: # Regular expression which should only match correct instance attribute names
michael@0: attr-rgx=[a-z_][a-z0-9_]{2,30}$
michael@0: 
michael@0: # Regular expression which should only match correct argument names
michael@0: argument-rgx=[a-z_][a-z0-9_]{2,30}$
michael@0: 
michael@0: # Regular expression which should only match correct variable names
michael@0: variable-rgx=[a-z_][a-z0-9_]{2,30}$
michael@0: 
michael@0: # Regular expression which should only match correct list comprehension /
michael@0: # generator expression variable names
michael@0: inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
michael@0: 
michael@0: # Good variable names which should always be accepted, separated by a comma
michael@0: good-names=i,j,k,ex,Run,_
michael@0: 
michael@0: # Bad variable names which should always be refused, separated by a comma
michael@0: bad-names=foo,bar,baz,toto,tutu,tata
michael@0: 
michael@0: # Regular expression which should only match functions or classes name which do
michael@0: # not require a docstring
michael@0: no-docstring-rgx=__.*__
michael@0: 
michael@0: 
michael@0: [DESIGN]
michael@0: 
michael@0: # Maximum number of arguments for function / method
michael@0: max-args=5
michael@0: 
michael@0: # Argument names that match this expression will be ignored. Default to name
michael@0: # with leading underscore
michael@0: ignored-argument-names=_.*
michael@0: 
michael@0: # Maximum number of locals for function / method body
michael@0: max-locals=15
michael@0: 
michael@0: # Maximum number of return / yield for function / method body
michael@0: max-returns=6
michael@0: 
michael@0: # Maximum number of branch for function / method body
michael@0: max-branchs=12
michael@0: 
michael@0: # Maximum number of statements in function / method body
michael@0: max-statements=50
michael@0: 
michael@0: # Maximum number of parents for a class (see R0901).
michael@0: max-parents=7
michael@0: 
michael@0: # Maximum number of attributes for a class (see R0902).
michael@0: max-attributes=7
michael@0: 
michael@0: # Minimum number of public methods for a class (see R0903).
michael@0: min-public-methods=2
michael@0: 
michael@0: # Maximum number of public methods for a class (see R0904).
michael@0: max-public-methods=20
michael@0: 
michael@0: 
michael@0: [CLASSES]
michael@0: 
michael@0: # List of interface methods to ignore, separated by a comma. This is used for
michael@0: # instance to not check methods defines in Zope's Interface base class.
michael@0: ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
michael@0: 
michael@0: # List of method names used to declare (i.e. assign) instance attributes.
michael@0: defining-attr-methods=__init__,__new__,setUp
michael@0: 
michael@0: # List of valid names for the first argument in a class method.
michael@0: valid-classmethod-first-arg=cls
michael@0: 
michael@0: 
michael@0: [IMPORTS]
michael@0: 
michael@0: # Deprecated modules which should not be used, separated by a comma
michael@0: deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
michael@0: 
michael@0: # Create a graph of every (i.e. internal and external) dependencies in the
michael@0: # given file (report RP0402 must not be disabled)
michael@0: import-graph=
michael@0: 
michael@0: # Create a graph of external dependencies in the given file (report RP0402 must
michael@0: # not be disabled)
michael@0: ext-import-graph=
michael@0: 
michael@0: # Create a graph of internal dependencies in the given file (report RP0402 must
michael@0: # not be disabled)
michael@0: int-import-graph=
michael@0: 
michael@0: 
michael@0: [EXCEPTIONS]
michael@0: 
michael@0: # Exceptions that will emit a warning when being caught. Defaults to
michael@0: # "Exception"
michael@0: overgeneral-exceptions=Exception