linkchecker/config/pylintrc
2004-08-16 19:16:30 +00:00

215 lines
7.6 KiB
INI

# lint Python modules using external checkers.
#
[MASTER]
# Add <file> (may be a directory) to the black list. It should be a base name,
# not a path. You may set this option multiple times.
ignore=CVS,httplib2.py
# Pickle collected data for later comparisons.
persistent=yes
# Tells wether to display a full report or only the messages
reports=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
# Python expression which should return a note less than 10 (10 is the highest
# note).You have access to the variables errors, warnings, statements 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 * errors + warnings) / statements) * 10)'
# Add a comment according to your evaluation note. This is used by the global
# evaluation report (R0004).
comment=no
# Include message's id in output
include-ids=no
# checks for
# * external modules dependancies
# * relative / wildcard imports
# * cyclic imports
# * uses of deprecated modules
#
[IMPORTS]
# Enable / disable this checker
enable-imports=yes
# Deprecated modules which should not be used, separated by a comma
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
# 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]
# Enable / disable this checker
enable-basic=yes
# Maximum number of arguments for function / method
max-args=10
# Maximum number of locals for function / method body
max-locals=15
# Maximum number of return / yield for function / method body
max-returns=6
# Maximum number of branch for function / method body
max-branchs=12
# Maximum number of statements in function / method body
max-statements=50
# 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=__.*__
# Minimal length for module / class / function / method / argument / variable
# names
min-name-length=1
# 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 class names
class-rgx=[A-Z][a-zA-Z0-9]+$
# Regular expression which should only match correct function names
function-rgx=[a-z_][a-z0-9_]*$
# Regular expression which should only match correct method names
method-rgx=[a-z_][a-z0-9_]*$
# Regular expression which should only match correct argument names
argument-rgx=[a-z_][a-z0-9_]*$
# Regular expression which should only match correct variable names
variable-rgx=[a-z_][a-z0-9_]*$
# Good variable names which should always be accepted, separated by a comma
good-names=
# 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
# checks for
# * unused variables / imports
# * undefined variables
# * redefinition of variable from builtins or from an outer scope
# * use of variable before assigment
#
[VARIABLES]
# Enable / disable this checker
enable-variables=yes
# Tells wether we should check for unused import in __init__ files.
init-import=no
# checks for :
# * methods without self as first argument
# * overriden methods signature
# * access only to existant members via self
# * attributes not defined in the __init__ method
# * supported interfaces implementation
# * unreachable code
#
[CLASSES]
# Enable / disable this checker
enable-classes=yes
# 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
# 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
# checks for
# * excepts without exception filter
# * string exceptions
#
[EXCEPTIONS]
# Enable / disable this checker
enable-exceptions=yes
# does not check anything but gives some raw metrics :
# * total number of lines
# * total number of code lines
# * total number of docstring lines
# * total number of comments lines
# * total number of empty lines
#
[METRICS]
# Enable / disable this checker
enable-metrics=yes
# checks for:
# * source code with non ascii characters but no encoding declaration (PEP
# 263)
# * warning notes in the code like FIXME, XXX
#
[MISCELLANEOUS]
# Enable / disable this checker
enable-miscellaneous=yes
# List of note tags to take in consideration, separated by a comma. Default to
# FIXME, XXX, TODO
notes=FIXME,XXX,TODO
# checks for :
# * unauthorized constructions
# * strict indentation
# * line length
# * use of <>
#
[FORMAT]
# Enable / disable this checker
enable-format=yes
# 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=' '