diff --git a/.pylintrc b/.pylintrc index 6d2d51a..72011d6 100644 --- a/.pylintrc +++ b/.pylintrc @@ -7,12 +7,9 @@ # pygtk.require(). #init-hook= -# Profiled execution. -profile=no - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS,doc,html,pid,log,etc +# Add to the black list. It should be a base name, not a +# path. You may set this option multiple times. +ignore = .git # Pickle collected data for later comparisons. persistent=yes @@ -21,35 +18,54 @@ persistent=yes # usually to register additional checkers. load-plugins= +# For some reason, Pylint cannot check members of these modules. +extension-pkg-whitelist = numpy,scipy + [MESSAGES CONTROL] +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + # 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. See also the "--disable" option for examples. +# multiple time. #enable= # Disable the message, report, category or checker with the given id(s). You -# 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=C0301,C0103,W0614,W0403,W0142,R0903,W0212,W0401,R0904,R0913,E1103 - +# can either give multiple identifier separated by comma (,) or put this option +# multiple time. +disable=missing-docstring + ,locally-disabled + ,locally-enabled + ,fixme + ,no-member + ,bad-whitespace + ,wrong-import-position + ,ungrouped-imports + ,import-self + ,bad-continuation + ,protected-access + ,unused-argument + ,duplicate-code + ,attribute-defined-outside-init + ,access-member-before-definition + ,no-self-use + ,broad-except + ,unneeded-not + ,unidiomatic-typecheck + ,undefined-loop-variable + ,redefined-variable-type + ,deprecated-lambda [REPORTS] # Set the output format. Available formats are text, parseable, colorized, msvs -# (visual studio) and html. You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=colorized +# (visual studio) and html +#output-format=parseable -# Include message's id in output -include-ids=yes +msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg} # 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 @@ -63,112 +79,86 @@ reports=no # note). You have access to the variables errors warning, statement which # respectively contain the number of errors / warnings messages and the total # number of statements analyzed. This is used by the global evaluation report -# (RP0004). +# (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 (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= +[VARIABLES] +# Tells whether we should check for unused import in __init__ files. +init-import=no -[TYPECHECK] +# A regular expression matching names used for dummy variables (i.e. not used). +dummy-variables-rgx=_|dummy -# Tells whether 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 dynamically set). -ignored-classes=SQLObject - -# When zope mode is activated, add a predefined set of Zope acquired attributes -# to generated-members. -zope=no - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E0201 when accessed. Python regular -# expressions are accepted. -generated-members=REQUEST,acl_users,aq_parent +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= [BASIC] -# Required attributes for module, separated by a comma -required-attributes= - # List of builtins function names that should not be used, separated by a comma -bad-functions=map,filter,apply,input +#bad-functions=map,filter,apply,input +bad-functions=apply,input # Regular expression which should only match correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +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-Z0-9_]*)|(__.*__))$ +const-rgx=(([A-Za-z_][A-Za-z0-9_]*)|(__.*__))$ # Regular expression which should only match correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=([A-Za-z_])[a-zA-Z0-9_]+$ + +# Regular expression which should only match correct class names +class-attribute-rgx=[A-Z][A-Z0-9_]+|[a-z_][a-zA-Z0-9_]+$ # Regular expression which should only match correct function names -function-rgx=[a-z_][a-z0-9_]{2,30}$ +function-rgx=[A-Za-z_][A-Za-z0-9_]{0,30}$ # Regular expression which should only match correct method names -method-rgx=[a-z_][a-z0-9_]{2,30}$ +method-rgx=[A-Za-z_][A-Za-z0-9_]{0,40}$ # Regular expression which should only match correct instance attribute names -attr-rgx=[a-z_][a-z0-9_]{2,30}$ +attr-rgx=[a-z_][A-Za-z0-9_]{0,30}$ # Regular expression which should only match correct argument names -argument-rgx=[a-z_][a-z0-9_]{2,30}$ +argument-rgx=[a-z_][a-z0-9_]{0,30}$ # Regular expression which should only match correct variable names -variable-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression which should only match correct attribute names in class -# bodies -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ +variable-rgx=[a-z_][a-zA-Z0-9_]{0,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,_ +good-names=i,j,k,ex,Run,_,a,b,c,d,m,n,u,v,w,x,y,z,e # 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 function or class names that do -# not require a docstring. +# Regular expression which should only match functions or classes name which do +# not require a docstring no-docstring-rgx=__.*__ -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=3 - [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO,HACK +notes=FIXME,XXX,TODO [FORMAT] # Maximum number of characters on a single line. -max-line-length=80 +max-line-length=132 -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\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=no - -# List of optional constructs for which whitespace checking is disabled +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. no-space-check=trailing-comma,dict-separator # Maximum number of lines in a module @@ -190,56 +180,60 @@ ignore-comments=yes # Ignore docstrings when computing similarities. ignore-docstrings=yes -# Ignore imports when computing similarities. -ignore-imports=no +[TYPECHECK] -[VARIABLES] +# Tells whether 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 -# Tells whether we should check for unused import in __init__ files. -init-import=no +# List of classes names for which member attributes should not be checked +# (useful for classes with attributes dynamically set). +ignored-classes=SQLObject,numpy,CommandLineCell -# A regular expression matching the beginning of the name of 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= +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E0201 when accessed. +generated-members=REQUEST,acl_users,aq_parent [DESIGN] # Maximum number of arguments for function / method -max-args=5 +max-args=15 # Argument names that match this expression will be ignored. Default to name # with leading underscore ignored-argument-names=_.* # Maximum number of locals for function / method body -max-locals=15 +max-locals=50 # Maximum number of return / yield for function / method body -max-returns=6 +max-returns=10 # Maximum number of branch for function / method body -max-branches=12 +max-branches=40 # Maximum number of statements in function / method body -max-statements=50 +max-statements=150 # Maximum number of parents for a class (see R0901). -max-parents=7 +max-parents=10 # Maximum number of attributes for a class (see R0902). -max-attributes=7 +max-attributes=50 # Minimum number of public methods for a class (see R0903). -min-public-methods=2 +min-public-methods=0 # Maximum number of public methods for a class (see R0904). -max-public-methods=20 +max-public-methods=100 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=7 + +# Maximum nesting depth +max-nested-blocks=6 [IMPORTS] @@ -262,22 +256,5 @@ 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 - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/Makefile b/Makefile index ccb4332..0c1dabb 100644 --- a/Makefile +++ b/Makefile @@ -31,6 +31,6 @@ doc: $(MAKE) -C doc html lint: - pylint -j $(shell nproc) -f colorized -r n --rcfile=pylintrc secop secop_* test + pylint -j $(shell nproc) -f colorized -r n --rcfile=.pylintrc secop secop_* test .PHONY: doc clean test test-verbose test-coverage demo lint diff --git a/pylintrc b/pylintrc deleted file mode 100644 index d60e1af..0000000 --- a/pylintrc +++ /dev/null @@ -1,260 +0,0 @@ -[MASTER] - -# Specify a configuration file. -#rcfile= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Add to the black list. It should be a base name, not a -# path. You may set this option multiple times. -ignore = .git - -# Pickle collected data for later comparisons. -persistent=yes - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# For some reason, Pylint cannot check members of these modules. -extension-pkg-whitelist = numpy,scipy - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# 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. -#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. -disable=missing-docstring - ,locally-disabled - ,locally-enabled - ,fixme - ,no-member - ,bad-whitespace - ,wrong-import-position - ,ungrouped-imports - ,import-self - ,bad-continuation - ,protected-access - ,unused-argument - ,duplicate-code - ,attribute-defined-outside-init - ,access-member-before-definition - ,no-self-use - ,broad-except - ,unneeded-not - ,unidiomatic-typecheck - ,undefined-loop-variable - ,redefined-variable-type - ,deprecated-lambda - -[REPORTS] - -# Set the output format. Available formats are text, parseable, colorized, msvs -# (visual studio) and html -#output-format=parseable - -msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg} - -# 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 whether 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 -# respectively 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) - - -[VARIABLES] - -# Tells whether 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= - - -[BASIC] - -# List of builtins function names that should not be used, separated by a comma -#bad-functions=map,filter,apply,input -bad-functions=apply,input - -# 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-Za-z_][A-Za-z0-9_]*)|(__.*__))$ - -# Regular expression which should only match correct class names -class-rgx=([A-Za-z_])[a-zA-Z0-9_]+$ - -# Regular expression which should only match correct class names -class-attribute-rgx=[A-Z][A-Z0-9_]+|[a-z_][a-zA-Z0-9_]+$ - -# Regular expression which should only match correct function names -function-rgx=[A-Za-z_][A-Za-z0-9_]{0,30}$ - -# Regular expression which should only match correct method names -method-rgx=[A-Za-z_][A-Za-z0-9_]{0,40}$ - -# Regular expression which should only match correct instance attribute names -attr-rgx=[a-z_][A-Za-z0-9_]{0,30}$ - -# Regular expression which should only match correct argument names -argument-rgx=[a-z_][a-z0-9_]{0,30}$ - -# Regular expression which should only match correct variable names -variable-rgx=[a-z_][a-z0-9_]{0,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,_,a,b,c,d,m,n,u,v,w,x,y,z,e - -# 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 functions or classes name which do -# not require a docstring -no-docstring-rgx=__.*__ - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO - - -[FORMAT] - -# Maximum number of characters on a single line. -max-line-length=132 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# 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=' ' - - -[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 - - -[TYPECHECK] - -# Tells whether 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 dynamically set). -ignored-classes=SQLObject,numpy,CommandLineCell - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E0201 when accessed. -generated-members=REQUEST,acl_users,aq_parent - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=15 - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.* - -# Maximum number of locals for function / method body -max-locals=50 - -# Maximum number of return / yield for function / method body -max-returns=10 - -# Maximum number of branch for function / method body -max-branches=40 - -# Maximum number of statements in function / method body -max-statements=150 - -# Maximum number of parents for a class (see R0901). -max-parents=10 - -# Maximum number of attributes for a class (see R0902). -max-attributes=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=0 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=100 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=7 - -# Maximum nesting depth -max-nested-blocks=6 - - -[IMPORTS] - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=regsub,TERMIOS,Bastion,rexec - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp