.pylintrc
changeset 205 975adcb82113
equal deleted inserted replaced
204:c435de184bda 205:975adcb82113
       
     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 # Add files or directories to the blacklist. They should be base names, not
       
    11 # paths.
       
    12 ignore=CVS
       
    13 
       
    14 # Add files or directories matching the regex patterns to the blacklist. The
       
    15 # regex matches against base names, not paths.
       
    16 ignore-patterns=
       
    17 
       
    18 # Pickle collected data for later comparisons.
       
    19 persistent=yes
       
    20 
       
    21 # List of plugins (as comma separated values of python modules names) to load,
       
    22 # usually to register additional checkers.
       
    23 load-plugins=
       
    24 
       
    25 # Use multiple processes to speed up Pylint.
       
    26 jobs=2
       
    27 
       
    28 # Allow loading of arbitrary C extensions. Extensions are imported into the
       
    29 # active Python interpreter and may run arbitrary code.
       
    30 unsafe-load-any-extension=no
       
    31 
       
    32 # A comma-separated list of package or module names from where C extensions may
       
    33 # be loaded. Extensions are loading into the active Python interpreter and may
       
    34 # run arbitrary code
       
    35 extension-pkg-whitelist=
       
    36 
       
    37 # Allow optimization of some AST trees. This will activate a peephole AST
       
    38 # optimizer, which will apply various small optimizations. For instance, it can
       
    39 # be used to obtain the result of joining multiple strings with the addition
       
    40 # operator. Joining a lot of strings can lead to a maximum recursion error in
       
    41 # Pylint and this flag can prevent that. It has one side effect, the resulting
       
    42 # AST will be different than the one from reality. This option is deprecated
       
    43 # and it will be removed in Pylint 2.0.
       
    44 optimize-ast=no
       
    45 
       
    46 
       
    47 [MESSAGES CONTROL]
       
    48 
       
    49 # Only show warnings with the listed confidence levels. Leave empty to show
       
    50 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
       
    51 confidence=
       
    52 
       
    53 # Enable the message, report, category or checker with the given id(s). You can
       
    54 # either give multiple identifier separated by comma (,) or put this option
       
    55 # multiple time (only on the command line, not in the configuration file where
       
    56 # it should appear only once). See also the "--disable" option for examples.
       
    57 #enable=
       
    58 
       
    59 # Disable the message, report, category or checker with the given id(s). You
       
    60 # can either give multiple identifiers separated by comma (,) or put this
       
    61 # option multiple times (only on the command line, not in the configuration
       
    62 # file where it should appear only once).You can also use "--disable=all" to
       
    63 # disable everything first and then reenable specific checks. For example, if
       
    64 # you want to run only the similarities checker, you can use "--disable=all
       
    65 # --enable=similarities". If you want to run only the classes checker, but have
       
    66 # no Warning level messages displayed, use"--disable=all --enable=classes
       
    67 # --disable=W"
       
    68 disable=import-star-module-level,old-octal-literal,oct-method,inherit-non-class,logging-format-interpolation,too-many-ancestors,print-statement,unpacking-in-except,parameter-unpacking,backtick,old-raise-syntax,old-ne-operator,long-suffix,dict-view-method,dict-iter-method,metaclass-assignment,next-method-called,raising-string,indexing-exception,raw_input-builtin,long-builtin,file-builtin,execfile-builtin,coerce-builtin,cmp-builtin,buffer-builtin,basestring-builtin,apply-builtin,filter-builtin-not-iterating,using-cmp-argument,useless-suppression,range-builtin-not-iterating,suppressed-message,no-absolute-import,old-division,cmp-method,reload-builtin,zip-builtin-not-iterating,intern-builtin,unichr-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,input-builtin,round-builtin,hex-method,nonzero-method,map-builtin-not-iterating
       
    69 
       
    70 
       
    71 [REPORTS]
       
    72 
       
    73 # Set the output format. Available formats are text, parseable, colorized, msvs
       
    74 # (visual studio) and html. You can also give a reporter class, eg
       
    75 # mypackage.mymodule.MyReporterClass.
       
    76 output-format=text
       
    77 
       
    78 # Put messages in a separate file for each module / package specified on the
       
    79 # command line instead of printing them on stdout. Reports (if any) will be
       
    80 # written in a file name "pylint_global.[txt|html]". This option is deprecated
       
    81 # and it will be removed in Pylint 2.0.
       
    82 files-output=no
       
    83 
       
    84 # Tells whether to display a full report or only the messages
       
    85 reports=yes
       
    86 
       
    87 # Python expression which should return a note less than 10 (10 is the highest
       
    88 # note). You have access to the variables errors warning, statement which
       
    89 # respectively contain the number of errors / warnings messages and the total
       
    90 # number of statements analyzed. This is used by the global evaluation report
       
    91 # (RP0004).
       
    92 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
       
    93 
       
    94 # Template used to display messages. This is a python new-style format string
       
    95 # used to format the message information. See doc for all details
       
    96 #msg-template=
       
    97 
       
    98 
       
    99 [FORMAT]
       
   100 
       
   101 # Maximum number of characters on a single line.
       
   102 max-line-length=100
       
   103 
       
   104 # Regexp for a line that is allowed to be longer than the limit.
       
   105 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
       
   106 
       
   107 # Allow the body of an if to be on the same line as the test if there is no
       
   108 # else.
       
   109 single-line-if-stmt=no
       
   110 
       
   111 # List of optional constructs for which whitespace checking is disabled. `dict-
       
   112 # separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
       
   113 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
       
   114 # `empty-line` allows space-only lines.
       
   115 no-space-check=trailing-comma,dict-separator
       
   116 
       
   117 # Maximum number of lines in a module
       
   118 max-module-lines=1000
       
   119 
       
   120 # String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
       
   121 # tab).
       
   122 indent-string='    '
       
   123 
       
   124 # Number of spaces of indent required inside a hanging  or continued line.
       
   125 indent-after-paren=4
       
   126 
       
   127 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
       
   128 expected-line-ending-format=
       
   129 
       
   130 
       
   131 [SIMILARITIES]
       
   132 
       
   133 # Minimum lines number of a similarity.
       
   134 min-similarity-lines=10
       
   135 
       
   136 # Ignore comments when computing similarities.
       
   137 ignore-comments=yes
       
   138 
       
   139 # Ignore docstrings when computing similarities.
       
   140 ignore-docstrings=yes
       
   141 
       
   142 # Ignore imports when computing similarities.
       
   143 ignore-imports=yes
       
   144 
       
   145 
       
   146 [TYPECHECK]
       
   147 
       
   148 # Tells whether missing members accessed in mixin class should be ignored. A
       
   149 # mixin class is detected if its name ends with "mixin" (case insensitive).
       
   150 ignore-mixin-members=yes
       
   151 
       
   152 # List of module names for which member attributes should not be checked
       
   153 # (useful for modules/projects where namespaces are manipulated during runtime
       
   154 # and thus existing member attributes cannot be deduced by static analysis. It
       
   155 # supports qualified module names, as well as Unix pattern matching.
       
   156 ignored-modules=
       
   157 
       
   158 # List of class names for which member attributes should not be checked (useful
       
   159 # for classes with dynamically set attributes). This supports the use of
       
   160 # qualified names.
       
   161 ignored-classes=optparse.Values,thread._local,_thread._local
       
   162 
       
   163 # List of members which are set dynamically and missed by pylint inference
       
   164 # system, and so shouldn't trigger E1101 when accessed. Python regular
       
   165 # expressions are accepted.
       
   166 generated-members=
       
   167 
       
   168 # List of decorators that produce context managers, such as
       
   169 # contextlib.contextmanager. Add to this list to register other decorators that
       
   170 # produce valid context managers.
       
   171 contextmanager-decorators=contextlib.contextmanager
       
   172 
       
   173 
       
   174 [MISCELLANEOUS]
       
   175 
       
   176 # List of note tags to take in consideration, separated by a comma.
       
   177 notes=FIXME,XXX,TODO
       
   178 
       
   179 
       
   180 [LOGGING]
       
   181 
       
   182 # Logging modules to check that the string format arguments are in logging
       
   183 # function parameter format
       
   184 logging-modules=logging
       
   185 
       
   186 
       
   187 [VARIABLES]
       
   188 
       
   189 # Tells whether we should check for unused import in __init__ files.
       
   190 init-import=no
       
   191 
       
   192 # A regular expression matching the name of dummy variables (i.e. expectedly
       
   193 # not used).
       
   194 dummy-variables-rgx=(_+[a-zA-Z0-9]*?$)|dummy
       
   195 
       
   196 # List of additional names supposed to be defined in builtins. Remember that
       
   197 # you should avoid to define new builtins when possible.
       
   198 additional-builtins=
       
   199 
       
   200 # List of strings which can identify a callback function by name. A callback
       
   201 # name must start or end with one of those strings.
       
   202 callbacks=cb_,_cb
       
   203 
       
   204 # List of qualified module names which can have objects that can redefine
       
   205 # builtins.
       
   206 redefining-builtins-modules=six.moves,future.builtins
       
   207 
       
   208 
       
   209 [BASIC]
       
   210 
       
   211 # Good variable names which should always be accepted, separated by a comma
       
   212 good-names=i,j,k,ex,Run,_
       
   213 
       
   214 # Bad variable names which should always be refused, separated by a comma
       
   215 bad-names=foo,bar,baz,toto,tutu,tata
       
   216 
       
   217 # Colon-delimited sets of names that determine each other's naming style when
       
   218 # the name regexes allow several styles.
       
   219 name-group=
       
   220 
       
   221 # Include a hint for the correct naming format with invalid-name
       
   222 include-naming-hint=no
       
   223 
       
   224 # List of decorators that produce properties, such as abc.abstractproperty. Add
       
   225 # to this list to register other decorators that produce valid properties.
       
   226 property-classes=abc.abstractproperty
       
   227 
       
   228 # Regular expression matching correct function names
       
   229 function-rgx=[a-z_][a-z0-9_]{2,30}$
       
   230 
       
   231 # Naming hint for function names
       
   232 function-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   233 
       
   234 # Regular expression matching correct variable names
       
   235 variable-rgx=[a-z_][a-z0-9_]{2,30}$
       
   236 
       
   237 # Naming hint for variable names
       
   238 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   239 
       
   240 # Regular expression matching correct constant names
       
   241 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
       
   242 
       
   243 # Naming hint for constant names
       
   244 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
       
   245 
       
   246 # Regular expression matching correct attribute names
       
   247 attr-rgx=[a-z_][a-z0-9_]{2,30}$
       
   248 
       
   249 # Naming hint for attribute names
       
   250 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   251 
       
   252 # Regular expression matching correct argument names
       
   253 argument-rgx=[a-z_][a-z0-9_]{2,30}$
       
   254 
       
   255 # Naming hint for argument names
       
   256 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   257 
       
   258 # Regular expression matching correct class attribute names
       
   259 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
       
   260 
       
   261 # Naming hint for class attribute names
       
   262 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
       
   263 
       
   264 # Regular expression matching correct inline iteration names
       
   265 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
       
   266 
       
   267 # Naming hint for inline iteration names
       
   268 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
       
   269 
       
   270 # Regular expression matching correct class names
       
   271 class-rgx=[A-Z_][a-zA-Z0-9]+$
       
   272 
       
   273 # Naming hint for class names
       
   274 class-name-hint=[A-Z_][a-zA-Z0-9]+$
       
   275 
       
   276 # Regular expression matching correct module names
       
   277 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
       
   278 
       
   279 # Naming hint for module names
       
   280 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
       
   281 
       
   282 # Regular expression matching correct method names
       
   283 method-rgx=[a-z_][a-z0-9_]{2,30}$
       
   284 
       
   285 # Naming hint for method names
       
   286 method-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   287 
       
   288 # Regular expression which should only match function or class names that do
       
   289 # not require a docstring.
       
   290 no-docstring-rgx=^_
       
   291 
       
   292 # Minimum line length for functions/classes that require docstrings, shorter
       
   293 # ones are exempt.
       
   294 docstring-min-length=-1
       
   295 
       
   296 
       
   297 [ELIF]
       
   298 
       
   299 # Maximum number of nested blocks for function / method body
       
   300 max-nested-blocks=5
       
   301 
       
   302 
       
   303 [SPELLING]
       
   304 
       
   305 # Spelling dictionary name. Available dictionaries: none. To make it working
       
   306 # install python-enchant package.
       
   307 spelling-dict=
       
   308 
       
   309 # List of comma separated words that should not be checked.
       
   310 spelling-ignore-words=
       
   311 
       
   312 # A path to a file that contains private dictionary; one word per line.
       
   313 spelling-private-dict-file=
       
   314 
       
   315 # Tells whether to store unknown words to indicated private dictionary in
       
   316 # --spelling-private-dict-file option instead of raising a message.
       
   317 spelling-store-unknown-words=no
       
   318 
       
   319 
       
   320 [IMPORTS]
       
   321 
       
   322 # Deprecated modules which should not be used, separated by a comma
       
   323 deprecated-modules=regsub,TERMIOS,Bastion,rexec
       
   324 
       
   325 # Create a graph of every (i.e. internal and external) dependencies in the
       
   326 # given file (report RP0402 must not be disabled)
       
   327 import-graph=
       
   328 
       
   329 # Create a graph of external dependencies in the given file (report RP0402 must
       
   330 # not be disabled)
       
   331 ext-import-graph=
       
   332 
       
   333 # Create a graph of internal dependencies in the given file (report RP0402 must
       
   334 # not be disabled)
       
   335 int-import-graph=
       
   336 
       
   337 # Force import order to recognize a module as part of the standard
       
   338 # compatibility libraries.
       
   339 known-standard-library=
       
   340 
       
   341 # Force import order to recognize a module as part of a third party library.
       
   342 known-third-party=enchant
       
   343 
       
   344 # Analyse import fallback blocks. This can be used to support both Python 2 and
       
   345 # 3 compatible code, which means that the block might have code that exists
       
   346 # only in one or another interpreter, leading to false positives when analysed.
       
   347 analyse-fallback-blocks=no
       
   348 
       
   349 
       
   350 [DESIGN]
       
   351 
       
   352 # Maximum number of arguments for function / method
       
   353 max-args=5
       
   354 
       
   355 # Argument names that match this expression will be ignored. Default to name
       
   356 # with leading underscore
       
   357 ignored-argument-names=_.*
       
   358 
       
   359 # Maximum number of locals for function / method body
       
   360 max-locals=15
       
   361 
       
   362 # Maximum number of return / yield for function / method body
       
   363 max-returns=6
       
   364 
       
   365 # Maximum number of branch for function / method body
       
   366 max-branches=12
       
   367 
       
   368 # Maximum number of statements in function / method body
       
   369 max-statements=50
       
   370 
       
   371 # Maximum number of parents for a class (see R0901).
       
   372 max-parents=7
       
   373 
       
   374 # Maximum number of attributes for a class (see R0902).
       
   375 max-attributes=7
       
   376 
       
   377 # Minimum number of public methods for a class (see R0903).
       
   378 min-public-methods=0
       
   379 
       
   380 # Maximum number of public methods for a class (see R0904).
       
   381 max-public-methods=20
       
   382 
       
   383 # Maximum number of boolean expressions in a if statement
       
   384 max-bool-expr=5
       
   385 
       
   386 
       
   387 [CLASSES]
       
   388 
       
   389 # List of method names used to declare (i.e. assign) instance attributes.
       
   390 defining-attr-methods=__init__,__new__,setUp
       
   391 
       
   392 # List of valid names for the first argument in a class method.
       
   393 valid-classmethod-first-arg=cls
       
   394 
       
   395 # List of valid names for the first argument in a metaclass class method.
       
   396 valid-metaclass-classmethod-first-arg=mcs
       
   397 
       
   398 # List of member names, which should be excluded from the protected access
       
   399 # warning.
       
   400 exclude-protected=_asdict,_fields,_replace,_source,_make
       
   401 
       
   402 
       
   403 [EXCEPTIONS]
       
   404 
       
   405 # Exceptions that will emit a warning when being caught. Defaults to
       
   406 # "Exception"
       
   407 overgeneral-exceptions=Exception