src/pylint.rc

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