src/PythonAPI/pylintrc

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