buildframework/helium/config/pylintrc.txt
changeset 1 be27ed110b50
equal deleted inserted replaced
0:044383f39525 1:be27ed110b50
       
     1 
       
     2 [MASTER]
       
     3 
       
     4 # Add <file or directory> to the black list. It should be a base name, not a
       
     5 # path. You may set this option multiple times.
       
     6 ignore=CVS
       
     7 
       
     8 # Pickle collected data for later comparisons.
       
     9 persistent=yes
       
    10 
       
    11 # Set the cache size for astng objects.
       
    12 cache-size=500
       
    13 
       
    14 # List of plugins (as comma separated values of python modules names) to load,
       
    15 # usually to register additional checkers.
       
    16 load-plugins=
       
    17 
       
    18 
       
    19 [MESSAGES CONTROL]
       
    20 
       
    21 # Enable only checker(s) with the given id(s). This option conflicts with the
       
    22 # disable-checker option
       
    23 #enable-checker=
       
    24 
       
    25 # Enable all checker(s) except those with the given id(s). This option
       
    26 # conflicts with the enable-checker option
       
    27 #disable-checker=
       
    28 
       
    29 # Enable all messages in the listed categories.
       
    30 #enable-msg-cat=
       
    31 
       
    32 # Disable all messages in the listed categories.
       
    33 #disable-msg-cat=
       
    34 
       
    35 # Enable the message(s) with the given id(s).
       
    36 #enable-msg=
       
    37 
       
    38 # Disable the message(s) with the given id(s).
       
    39 disable-msg=C0301,W0401,W0611,W0614,R0801,W0402,R0914
       
    40 
       
    41 
       
    42 [REPORTS]
       
    43 
       
    44 # set the output format. Available formats are text, parseable, colorized, msvs
       
    45 # (visual studio) and html
       
    46 output-format=text
       
    47 
       
    48 # Include message's id in output
       
    49 include-ids=yes
       
    50 
       
    51 # Put messages in a separate file for each module / package specified on the
       
    52 # command line instead of printing them on stdout. Reports (if any) will be
       
    53 # written in a file name "pylint_global.[txt|html]".
       
    54 files-output=no
       
    55 
       
    56 # Tells wether to display a full report or only the messages
       
    57 reports=yes
       
    58 
       
    59 # Python expression which should return a note less than 10 (10 is the highest
       
    60 # note).You have access to the variables errors warning, statement which
       
    61 # respectivly contain the number of errors / warnings messages and the total
       
    62 # number of statements analyzed. This is used by the global evaluation report
       
    63 # (R0004).
       
    64 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
       
    65 
       
    66 # Add a comment according to your evaluation note. This is used by the global
       
    67 # evaluation report (R0004).
       
    68 comment=no
       
    69 
       
    70 # Enable the report(s) with the given id(s).
       
    71 #enable-report=
       
    72 
       
    73 # Disable the report(s) with the given id(s).
       
    74 #disable-report=
       
    75 
       
    76 
       
    77 # checks for :
       
    78 # * doc strings
       
    79 # * modules / classes / functions / methods / arguments / variables name
       
    80 # * number of arguments, local variables, branchs, returns and statements in
       
    81 # functions, methods
       
    82 # * required module attributes
       
    83 # * dangerous default values as arguments
       
    84 # * redefinition of function / method / class
       
    85 # * uses of the global statement
       
    86 # 
       
    87 [BASIC]
       
    88 
       
    89 # Required attributes for module, separated by a comma
       
    90 required-attributes=
       
    91 
       
    92 # Regular expression which should only match functions or classes name which do
       
    93 # not require a docstring
       
    94 no-docstring-rgx=__.*__
       
    95 
       
    96 # Regular expression which should only match correct module names
       
    97 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
       
    98 
       
    99 # Regular expression which should only match correct module level names
       
   100 const-rgx=(([A-Z_][A-Z1-9_]*)|(__.*__)|(_[a-zA-Z0-9_]{2,40}))$
       
   101 
       
   102 # Regular expression which should only match correct class names
       
   103 class-rgx=[A-Z_][a-zA-Z0-9]+$
       
   104 
       
   105 # Regular expression which should only match correct function names
       
   106 function-rgx=[a-z_][a-zA-Z0-9_]{2,40}$
       
   107 
       
   108 # Regular expression which should only match correct method names
       
   109 method-rgx=[a-z_][a-zA-Z0-9_]{2,40}$
       
   110 
       
   111 # Regular expression which should only match correct instance attribute names
       
   112 attr-rgx=[a-z_][a-zA-Z0-9_]{2,40}$
       
   113 
       
   114 # Regular expression which should only match correct argument names
       
   115 argument-rgx=[a-z_][a-zA-Z0-9_]{2,30}$
       
   116 
       
   117 # Regular expression which should only match correct variable names
       
   118 variable-rgx=[a-z_][a-zA-Z0-9_]{2,30}$
       
   119 
       
   120 # Regular expression which should only match correct list comprehension /
       
   121 # generator expression variable names
       
   122 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
       
   123 
       
   124 # Good variable names which should always be accepted, separated by a comma
       
   125 good-names=i,j,k,ex,Run,_
       
   126 
       
   127 # Bad variable names which should always be refused, separated by a comma
       
   128 bad-names=foo,bar,baz,toto,tutu,tata
       
   129 
       
   130 # List of builtins function names that should not be used, separated by a comma
       
   131 bad-functions=map,filter,apply,input
       
   132 
       
   133 
       
   134 # try to find bugs in the code using type inference
       
   135 # 
       
   136 [TYPECHECK]
       
   137 
       
   138 # Tells wether missing members accessed in mixin class should be ignored. A
       
   139 # mixin class is detected if its name ends with "mixin" (case insensitive).
       
   140 ignore-mixin-members=yes
       
   141 
       
   142 # When zope mode is activated, consider the acquired-members option to ignore
       
   143 # access to some undefined attributes.
       
   144 zope=no
       
   145 
       
   146 # List of members which are usually get through zope's acquisition mecanism and
       
   147 # so shouldn't trigger E0201 when accessed (need zope=yes to be considered).
       
   148 acquired-members=REQUEST,acl_users,aq_parent
       
   149 
       
   150 
       
   151 # checks for
       
   152 # * unused variables / imports
       
   153 # * undefined variables
       
   154 # * redefinition of variable from builtins or from an outer scope
       
   155 # * use of variable before assigment
       
   156 # 
       
   157 [VARIABLES]
       
   158 
       
   159 # Tells wether we should check for unused import in __init__ files.
       
   160 init-import=no
       
   161 
       
   162 # A regular expression matching names used for dummy variables (i.e. not used).
       
   163 dummy-variables-rgx=_|dummy
       
   164 
       
   165 # List of additional names supposed to be defined in builtins. Remember that
       
   166 # you should avoid to define new builtins when possible.
       
   167 additional-builtins=
       
   168 
       
   169 
       
   170 # checks for :
       
   171 # * methods without self as first argument
       
   172 # * overridden methods signature
       
   173 # * access only to existant members via self
       
   174 # * attributes not defined in the __init__ method
       
   175 # * supported interfaces implementation
       
   176 # * unreachable code
       
   177 # 
       
   178 [CLASSES]
       
   179 
       
   180 # List of interface methods to ignore, separated by a comma. This is used for
       
   181 # instance to not check methods defines in Zope's Interface base class.
       
   182 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
       
   183 
       
   184 # List of method names used to declare (i.e. assign) instance attributes.
       
   185 defining-attr-methods=__init__,__new__,setUp
       
   186 
       
   187 
       
   188 # checks for sign of poor/misdesign:
       
   189 # * number of methods, attributes, local variables...
       
   190 # * size, complexity of functions, methods
       
   191 # 
       
   192 [DESIGN]
       
   193 
       
   194 # Maximum number of arguments for function / method
       
   195 max-args=5
       
   196 
       
   197 # Maximum number of locals for function / method body
       
   198 max-locals=15
       
   199 
       
   200 # Maximum number of return / yield for function / method body
       
   201 max-returns=6
       
   202 
       
   203 # Maximum number of branch for function / method body
       
   204 max-branchs=12
       
   205 
       
   206 # Maximum number of statements in function / method body
       
   207 max-statements=50
       
   208 
       
   209 # Maximum number of parents for a class (see R0901).
       
   210 max-parents=7
       
   211 
       
   212 # Maximum number of attributes for a class (see R0902).
       
   213 max-attributes=7
       
   214 
       
   215 # Minimum number of public methods for a class (see R0903).
       
   216 min-public-methods=2
       
   217 
       
   218 # Maximum number of public methods for a class (see R0904).
       
   219 max-public-methods=20
       
   220 
       
   221 
       
   222 # checks for
       
   223 # * external modules dependencies
       
   224 # * relative / wildcard imports
       
   225 # * cyclic imports
       
   226 # * uses of deprecated modules
       
   227 # 
       
   228 [IMPORTS]
       
   229 
       
   230 # Deprecated modules which should not be used, separated by a comma
       
   231 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
       
   232 
       
   233 # Create a graph of every (i.e. internal and external) dependencies in the
       
   234 # given file (report R0402 must not be disabled)
       
   235 import-graph=
       
   236 
       
   237 # Create a graph of external dependencies in the given file (report R0402 must
       
   238 # not be disabled)
       
   239 ext-import-graph=
       
   240 
       
   241 # Create a graph of internal dependencies in the given file (report R0402 must
       
   242 # not be disabled)
       
   243 int-import-graph=
       
   244 
       
   245 
       
   246 # checks for :
       
   247 # * unauthorized constructions
       
   248 # * strict indentation
       
   249 # * line length
       
   250 # * use of <> instead of !=
       
   251 # 
       
   252 [FORMAT]
       
   253 
       
   254 # Maximum number of characters on a single line.
       
   255 max-line-length=80
       
   256 
       
   257 # Maximum number of lines in a module
       
   258 max-module-lines=1000
       
   259 
       
   260 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
       
   261 # tab).
       
   262 indent-string='    '
       
   263 
       
   264 
       
   265 # checks for:
       
   266 # * warning notes in the code like FIXME, XXX
       
   267 # * PEP 263: source code with non ascii character but no encoding declaration
       
   268 # 
       
   269 [MISCELLANEOUS]
       
   270 
       
   271 # List of note tags to take in consideration, separated by a comma.
       
   272 notes=FIXME,XXX,TODO
       
   273 
       
   274 
       
   275 # checks for similarities and duplicated code. This computation may be
       
   276 # memory / CPU intensive, so you should disable it if you experiments some
       
   277 # problems.
       
   278 # 
       
   279 [SIMILARITIES]
       
   280 
       
   281 # Minimum lines number of a similarity.
       
   282 min-similarity-lines=4
       
   283 
       
   284 # Ignore comments when computing similarities.
       
   285 ignore-comments=yes
       
   286 
       
   287 # Ignore docstrings when computing similarities.
       
   288 ignore-docstrings=yes