commit f4d755483f5b6d2695410d1ae7c855ea13724279 Author: Isis Lovecruft <isis@torproject.org> Date: Thu Jul 3 14:24:00 2014 +0000 Run `pylint --rcfile=.pylintrc --generate-rcfile > .pylintrc`. This refreshes the pylint config file with new settings from upgrading to version 1.1.0. --- .pylintrc | 213 ++++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 149 insertions(+), 64 deletions(-) diff --git a/.pylintrc b/.pylintrc index 6ba152c..0952d2e 100644 --- a/.pylintrc +++ b/.pylintrc @@ -5,6 +5,7 @@ # Python code to execute, usually for sys.path manipulation such as # pygtk.require(). +#init-hook='import sys,os; venv = os.environ.get("VIRTUAL_ENV"); v = os.path.join(venv, "lib", "python" + str(sys.version_info.major) + "." + str(sys.version_info.micro), "site-packages") if venv is not None else None; sys.path.insert(0, v);' init-hook="import sys,os;a=os.getcwd();print a;sys.path.insert(0, os.path.join(a, 'lib'));" # Profiled execution. @@ -26,20 +27,26 @@ load-plugins= # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option -# multiple time. +# multiple time. See also the "--disable" option for examples. #enable= # Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). -disable=W1201,W1401 +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +disable=W1201,W1401,F0401 [REPORTS] # Set the output format. Available formats are text, parseable, colorized, msvs -# (visual studio) and html +# (visual studio) and html. You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. output-format=text # Include message's id in output @@ -64,6 +71,58 @@ evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / stateme # evaluation report (RP0004). comment=no +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + + +[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 + +# Ignore imports when computing similarities. +ignore-imports=no + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[FORMAT] + +# Maximum number of characters on a single line. +max-line-length=79 + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )?<?https?://\S+>?$ + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=yes + +# List of optional constructs for which whitespace checking is disabled +no-space-check=trailing-comma,dict-separator + +# Maximum number of lines in a module +max-module-lines=1500 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + [BASIC] @@ -71,70 +130,88 @@ comment=no required-attributes= # List of builtins function names that should not be used, separated by a comma -bad-functions=map,filter,apply,input +bad-functions=filter,apply,input -# Regular expression which should only match correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +# Good variable names which should always be accepted, separated by a comma +good-names=i,j,k,ex,Run,_,err,exc,func,fn,fh -# Regular expression which should only match correct module level names -const-rgx=(([a-zA-Z0-9_]*)|(__.*__))$ +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata -# Regular expression which should only match correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= -# Regular expression which should only match correct function names +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Regular expression matching correct function names function-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ -# Regular expression which should only match correct method names -method-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ +# Naming hint for function names +function-name-hint=[a-z_][a-z0-9_]{2,30}$ -# Regular expression which should only match correct instance attribute names -attr-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ +# Regular expression matching correct variable names +variable-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ -# Regular expression which should only match correct argument names -argument-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ +# Naming hint for variable names +variable-name-hint=[a-z_][a-z0-9_]{2,30}$ -# Regular expression which should only match correct variable names -variable-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ +# Regular expression matching correct constant names +const-rgx=(([a-zA-Z0-9_]*)|(__.*__))$ -# Regular expression which should only match correct list comprehension / -# generator expression variable names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ -# Good variable names which should always be accepted, separated by a comma -good-names=i,j,k,ex,Run,_,err,exc,func,fn,fh +# Regular expression matching correct attribute names +attr-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata +# Naming hint for attribute names +attr-name-hint=[a-z_][a-z0-9_]{2,30}$ -# Regular expression which should only match functions or classes name which do -# not require a docstring -no-docstring-rgx=__.*__ +# Regular expression matching correct argument names +argument-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ +# Naming hint for argument names +argument-name-hint=[a-z_][a-z0-9_]{2,30}$ -[FORMAT] +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Maximum number of characters on a single line. -max-line-length=79 +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Maximum number of lines in a module -max-module-lines=1500 +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ +# Regular expression matching correct class names +class-rgx=[A-Z_][a-zA-Z0-9]+$ -[SIMILARITIES] +# Naming hint for class names +class-name-hint=[A-Z_][a-zA-Z0-9]+$ -# Minimum lines number of a similarity. -min-similarity-lines=4 +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ -# Ignore comments when computing similarities. -ignore-comments=yes +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ -# Ignore docstrings when computing similarities. -ignore-docstrings=yes +# Regular expression matching correct method names +method-rgx=[a-z_][a-zA-Z0-9_]{1,30}$ + +# Naming hint for method names +method-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=__.*__ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 [TYPECHECK] @@ -143,6 +220,11 @@ ignore-docstrings=yes # mixin class is detected if its name ends with "mixin" (case insensitive). ignore-mixin-members=yes +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus extisting member attributes cannot be deduced by static analysis +ignored-modules=twisted.internet.reactor + # List of classes names for which member attributes should not be checked # (useful for classes with attributes dynamically set). ignored-classes=SQLObject @@ -162,8 +244,8 @@ generated-members=REQUEST,acl_users,aq_parent # Tells whether we should check for unused import in __init__ files. init-import=yes -# A regular expression matching the beginning of the name of dummy variables -# (i.e. not used). +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). dummy-variables-rgx=_|dummy # List of additional names supposed to be defined in builtins. Remember that @@ -177,6 +259,22 @@ additional-builtins= notes=FIXME,XXX,DOC +[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 + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + [IMPORTS] # Deprecated modules which should not be used, separated by a comma @@ -184,7 +282,7 @@ deprecated-modules=regsub,string,TERMIOS,Bastion,rexec,sha # Create a graph of every (i.e. internal and external) dependencies in the # given file (report RP0402 must not be disabled) -#import-graph=pylint-import-graph.plain +import-graph= # Create a graph of external dependencies in the given file (report RP0402 must # not be disabled) @@ -195,19 +293,6 @@ ext-import-graph= int-import-graph= -[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 - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - - [DESIGN] # Maximum number of arguments for function / method @@ -224,7 +309,7 @@ max-locals=15 max-returns=6 # Maximum number of branch for function / method body -max-branchs=12 +max-branches=12 # Maximum number of statements in function / method body max-statements=50