pylintrc

   1 # Copyright 2014-2015, 6WIND S.A.
   2
   3 [MASTER]
   4
   5 # Specify a configuration file.
   6 #rcfile=
   7
   8 # Python code to execute, usually for sys.path manipulation such as
   9 # pygtk.require().
  10 #init-hook=
  11
  12 # Profiled execution.
  13 profile=no
  14
  15 # Add files or directories to the blacklist. They should be base names, not
  16 # paths.
  17 ignore=CVS,.git
  18
  19 # Pickle collected data for later comparisons.
  20 persistent=yes
  21
  22 # List of plugins (as comma separated values of python modules names) to load,
  23 # usually to register additional checkers.
  24 load-plugins=
  25
  26
  27 [MESSAGES CONTROL]
  28
  29 # Enable the message, report, category or checker with the given id(s). You can
  30 # either give multiple identifier separated by comma (,) or put this option
  31 # multiple time.
  32 #enable=
  33
  34 # Disable the message, report, category or checker with the given id(s). You
  35 # can either give multiple identifier separated by comma (,) or put this option
  36 # multiple time (only on the command line, not in the configuration file where
  37 # it should appear only once).
  38 disable=attribute-defined-outside-init,
  39         bare-except,
  40         cyclic-import,
  41         duplicate-code,
  42         fixme,
  43         interface-not-implemented,
  44         line-too-long,
  45         locally-disabled,
  46         missing-docstring,
  47         no-member,
  48         no-self-use,
  49         super-init-not-called,
  50         unused-argument,
  51
  52
  53 [REPORTS]
  54
  55 # Set the output format. Available formats are text, parseable, colorized, msvs
  56 # (visual studio) and html
  57 output-format=text
  58
  59 # Put messages in a separate file for each module / package specified on the
  60 # command line instead of printing them on stdout. Reports (if any) will be
  61 # written in a file name "pylint_global.[txt|html]".
  62 files-output=no
  63
  64 # Tells whether to display a full report or only the messages
  65 reports=no
  66
  67 # Python expression which should return a note less than 10 (10 is the highest
  68 # note). You have access to the variables errors warning, statement which
  69 # respectively contain the number of errors / warnings messages and the total
  70 # number of statements analyzed. This is used by the global evaluation report
  71 # (RP0004).
  72 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
  73
  74 # Add a comment according to your evaluation note. This is used by the global
  75 # evaluation report (RP0004).
  76 comment=no
  77
  78 msg-template={path}:{line} {msg} [{symbol}]
  79
  80 [TYPECHECK]
  81
  82 # Tells whether missing members accessed in mixin class should be ignored. A
  83 # mixin class is detected if its name ends with "mixin" (case insensitive).
  84 ignore-mixin-members=yes
  85
  86 # List of classes names for which member attributes should not be checked
  87 # (useful for classes with attributes dynamically set).
  88 ignored-classes=SQLObject
  89
  90 # When zope mode is activated, add a predefined set of Zope acquired attributes
  91 # to generated-members.
  92 zope=no
  93
  94 # List of members which are set dynamically and missed by pylint inference
  95 # system, and so shouldn't trigger E0201 when accessed. Python regular
  96 # expressions are accepted.
  97 generated-members=REQUEST,acl_users,aq_parent
  98
  99
 100 [BASIC]
 101
 102 # Required attributes for module, separated by a comma
 103 required-attributes=
 104
 105 # List of builtins function names that should not be used, separated by a comma
 106 bad-functions=map,filter,apply,input
 107
 108 # Regular expression which should only match correct module names
 109 module-rgx=[a-z_][a-z0-9_]*$
 110
 111 # Regular expression which should only match correct module level names
 112 const-rgx=[A-Z_][A-Z0-9_]*|__all__$
 113
 114 # Regular expression which should only match correct class names
 115 class-rgx=[A-Z_][a-zA-Z0-9]+$
 116
 117 # Regular expression which should only match correct function names
 118 function-rgx=[a-z_][a-z0-9_]{2,30}$
 119
 120 # Regular expression which should only match correct method names
 121 method-rgx=[a-z_][a-z0-9_]{2,30}$
 122
 123 # Regular expression which should only match correct instance attribute names
 124 attr-rgx=[a-z_][a-z0-9_]{0,30}$
 125
 126 # Regular expression which should only match correct argument names
 127 argument-rgx=[a-z_][a-z0-9_]{0,30}$
 128
 129 # Regular expression which should only match correct variable names
 130 variable-rgx=[a-z_][a-z0-9_]{0,30}$
 131
 132 # Regular expression which should only match correct list comprehension /
 133 # generator expression variable names
 134 inlinevar-rgx=[a-z_][a-z0-9_]*$
 135
 136 # Good variable names which should always be accepted, separated by a comma
 137 good-names=i,j,k,ex,Run,_
 138
 139 # Bad variable names which should always be refused, separated by a comma
 140 bad-names=foo,bar,baz,toto,tutu,tata
 141
 142 # Regular expression which should only match functions or classes name which do
 143 # not require a docstring
 144 no-docstring-rgx=__.*__
 145
 146
 147 [FORMAT]
 148
 149 # Maximum number of characters on a single line.
 150 max-line-length=80
 151
 152 # Maximum number of lines in a module
 153 max-module-lines=1500
 154
 155 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
 156 # tab).
 157 indent-string='    '
 158
 159 # List of optional constructs for which whitespace checking is disabled
 160 no-space-check=
 161
 162
 163 [SIMILARITIES]
 164
 165 # Minimum lines number of a similarity.
 166 min-similarity-lines=4
 167
 168 # Ignore comments when computing similarities.
 169 ignore-comments=yes
 170
 171 # Ignore docstrings when computing similarities.
 172 ignore-docstrings=yes
 173
 174
 175 [MISCELLANEOUS]
 176
 177 # List of note tags to take in consideration, separated by a comma.
 178 notes=FIXME,XXX,TODO
 179
 180
 181 [VARIABLES]
 182
 183 # Tells whether we should check for unused import in __init__ files.
 184 init-import=yes
 185
 186 # A regular expression matching the beginning of the name of dummy variables
 187 # (i.e. not used).
 188 dummy-variables-rgx=_|dummy
 189
 190 # List of additional names supposed to be defined in builtins. Remember that
 191 # you should avoid to define new builtins when possible.
 192 additional-builtins=
 193
 194
 195 [IMPORTS]
 196
 197 # Deprecated modules which should not be used, separated by a comma
 198 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
 199
 200 # Create a graph of every (i.e. internal and external) dependencies in the
 201 # given file (report RP0402 must not be disabled)
 202 import-graph=
 203
 204 # Create a graph of external dependencies in the given file (report RP0402 must
 205 # not be disabled)
 206 ext-import-graph=
 207
 208 # Create a graph of internal dependencies in the given file (report RP0402 must
 209 # not be disabled)
 210 int-import-graph=
 211
 212
 213 [DESIGN]
 214
 215 # Maximum number of arguments for function / method
 216 max-args=15
 217
 218 # Argument names that match this expression will be ignored. Default to name
 219 # with leading underscore
 220 ignored-argument-names=_.*
 221
 222 # Maximum number of locals for function / method body
 223 max-locals=20
 224
 225 # Maximum number of return / yield for function / method body
 226 max-returns=6
 227
 228 # Maximum number of branch for function / method body
 229 max-branches=20
 230
 231 # Maximum number of statements in function / method body
 232 max-statements=80
 233
 234 # Maximum number of parents for a class (see R0901).
 235 max-parents=7
 236
 237 # Maximum number of attributes for a class (see R0902).
 238 max-attributes=30
 239
 240 # Minimum number of public methods for a class (see R0903).
 241 min-public-methods=0
 242
 243 # Maximum number of public methods for a class (see R0904).
 244 max-public-methods=100
 245
 246
 247 [CLASSES]
 248
 249 # List of interface methods to ignore, separated by a comma. This is used for
 250 # instance to not check methods defines in Zope's Interface base class.
 251 #ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
 252
 253 # List of method names used to declare (i.e. assign) instance attributes.
 254 defining-attr-methods=__init__,__new__
 255
 256 # List of valid names for the first argument in a class method.
 257 valid-classmethod-first-arg=cls
 258
 259
 260 [EXCEPTIONS]
 261
 262 # Exceptions that will emit a warning when being caught. Defaults to
 263 # "Exception"
 264 overgeneral-exceptions=Exception