.pylintrc
changeset 1458 fe2ec4cb6183
child 1466 f1c220ead0d7
equal deleted inserted replaced
1457:055ea84a196e 1458:fe2ec4cb6183
       
     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=pylint_django
       
    23 
       
    24 
       
    25 # Use multiple processes to speed up Pylint.
       
    26 jobs=1
       
    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=lxml
       
    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.
       
    43 optimize-ast=no
       
    44 
       
    45 
       
    46 [REPORTS]
       
    47 
       
    48 # Set the output format. Available formats are text, parseable, colorized, msvs
       
    49 # (visual studio) and html. You can also give a reporter class, eg
       
    50 # mypackage.mymodule.MyReporterClass.
       
    51 output-format=text
       
    52 
       
    53 # Put messages in a separate file for each module / package specified on the
       
    54 # command line instead of printing them on stdout. Reports (if any) will be
       
    55 # written in a file name "pylint_global.[txt|html]".
       
    56 files-output=no
       
    57 
       
    58 # Tells whether to display a full report or only the messages
       
    59 reports=yes
       
    60 
       
    61 # Python expression which should return a note less than 10 (10 is the highest
       
    62 # note). You have access to the variables errors warning, statement which
       
    63 # respectively contain the number of errors / warnings messages and the total
       
    64 # number of statements analyzed. This is used by the global evaluation report
       
    65 # (RP0004).
       
    66 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
       
    67 
       
    68 # Add a comment according to your evaluation note. This is used by the global
       
    69 # evaluation report (RP0004).
       
    70 comment=no
       
    71 
       
    72 # Template used to display messages. This is a python new-style format string
       
    73 # used to format the message information. See doc for all details
       
    74 #msg-template=
       
    75 
       
    76 
       
    77 [MESSAGES CONTROL]
       
    78 
       
    79 # Only show warnings with the listed confidence levels. Leave empty to show
       
    80 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
       
    81 confidence=
       
    82 
       
    83 # Enable the message, report, category or checker with the given id(s). You can
       
    84 # either give multiple identifier separated by comma (,) or put this option
       
    85 # multiple time. See also the "--disable" option for examples.
       
    86 #enable=
       
    87 
       
    88 # Disable the message, report, category or checker with the given id(s). You
       
    89 # can either give multiple identifiers separated by comma (,) or put this
       
    90 # option multiple times (only on the command line, not in the configuration
       
    91 # file where it should appear only once).You can also use "--disable=all" to
       
    92 # disable everything first and then reenable specific checks. For example, if
       
    93 # you want to run only the similarities checker, you can use "--disable=all
       
    94 # --enable=similarities". If you want to run only the classes checker, but have
       
    95 # no Warning level messages displayed, use"--disable=all --enable=classes
       
    96 # --disable=W"
       
    97 disable=W1640,E1607,W1629,W1618,W1606,W1604,I0021,W1612,E1603,E1602,W1626,W1637,W1622,W1617,W1630,W1628,W1624,I0020,E1601,E1605,E1604,W1625,W1623,W1635,W1615,W1614,W1632,W1609,W1601,W1605,W1619,W1610,W1636,W1633,W1611,W1603,W1621,W1613,W0704,W1607,W1620,W1634,W1608,W1602,W1638,W1616,W1639,E1608,E1606,W1627,C0111,C0325,R0912,R0914
       
    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
       
   107 
       
   108 # Good variable names which should always be accepted, separated by a comma
       
   109 good-names=i,j,k,ex,Run,_
       
   110 
       
   111 # Bad variable names which should always be refused, separated by a comma
       
   112 bad-names=foo,bar,baz,toto,tutu,tata
       
   113 
       
   114 # Colon-delimited sets of names that determine each other's naming style when
       
   115 # the name regexes allow several styles.
       
   116 name-group=
       
   117 
       
   118 # Include a hint for the correct naming format with invalid-name
       
   119 include-naming-hint=no
       
   120 
       
   121 # Regular expression matching correct function names
       
   122 function-rgx=[a-z_][a-z0-9_]{2,30}$
       
   123 
       
   124 # Naming hint for function names
       
   125 function-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   126 
       
   127 # Regular expression matching correct constant names
       
   128 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
       
   129 
       
   130 # Naming hint for constant names
       
   131 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
       
   132 
       
   133 # Regular expression matching correct inline iteration names
       
   134 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
       
   135 
       
   136 # Naming hint for inline iteration names
       
   137 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
       
   138 
       
   139 # Regular expression matching correct module names
       
   140 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
       
   141 
       
   142 # Naming hint for module names
       
   143 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
       
   144 
       
   145 # Regular expression matching correct argument names
       
   146 argument-rgx=[a-z_][a-z0-9_]{2,30}$
       
   147 
       
   148 # Naming hint for argument names
       
   149 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   150 
       
   151 # Regular expression matching correct method names
       
   152 method-rgx=[a-z_][a-z0-9_]{2,30}$
       
   153 
       
   154 # Naming hint for method names
       
   155 method-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   156 
       
   157 # Regular expression matching correct variable names
       
   158 variable-rgx=[a-z_][a-z0-9_]{2,30}$
       
   159 
       
   160 # Naming hint for variable names
       
   161 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   162 
       
   163 # Regular expression matching correct class names
       
   164 class-rgx=[A-Z_][a-zA-Z0-9]+$
       
   165 
       
   166 # Naming hint for class names
       
   167 class-name-hint=[A-Z_][a-zA-Z0-9]+$
       
   168 
       
   169 # Regular expression matching correct class attribute names
       
   170 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
       
   171 
       
   172 # Naming hint for class attribute names
       
   173 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
       
   174 
       
   175 # Regular expression matching correct attribute names
       
   176 attr-rgx=[a-z_][a-z0-9_]{2,30}$
       
   177 
       
   178 # Naming hint for attribute names
       
   179 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
       
   180 
       
   181 # Regular expression which should only match function or class names that do
       
   182 # not require a docstring.
       
   183 no-docstring-rgx=__.*__
       
   184 
       
   185 # Minimum line length for functions/classes that require docstrings, shorter
       
   186 # ones are exempt.
       
   187 docstring-min-length=-1
       
   188 
       
   189 
       
   190 [FORMAT]
       
   191 
       
   192 # Maximum number of characters on a single line.
       
   193 max-line-length=100
       
   194 
       
   195 # Regexp for a line that is allowed to be longer than the limit.
       
   196 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
       
   197 
       
   198 # Allow the body of an if to be on the same line as the test if there is no
       
   199 # else.
       
   200 single-line-if-stmt=no
       
   201 
       
   202 # List of optional constructs for which whitespace checking is disabled
       
   203 no-space-check=trailing-comma,dict-separator
       
   204 
       
   205 # Maximum number of lines in a module
       
   206 max-module-lines=1000
       
   207 
       
   208 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
       
   209 # tab).
       
   210 indent-string='    '
       
   211 
       
   212 # Number of spaces of indent required inside a hanging or continued line.
       
   213 indent-after-paren=4
       
   214 
       
   215 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
       
   216 expected-line-ending-format=
       
   217 
       
   218 
       
   219 [LOGGING]
       
   220 
       
   221 # Logging modules to check that the string format arguments are in logging
       
   222 # function parameter format
       
   223 logging-modules=logging
       
   224 
       
   225 
       
   226 [MISCELLANEOUS]
       
   227 
       
   228 # List of note tags to take in consideration, separated by a comma.
       
   229 notes=FIXME,XXX,TODO
       
   230 
       
   231 
       
   232 [SIMILARITIES]
       
   233 
       
   234 # Minimum lines number of a similarity.
       
   235 min-similarity-lines=4
       
   236 
       
   237 # Ignore comments when computing similarities.
       
   238 ignore-comments=yes
       
   239 
       
   240 # Ignore docstrings when computing similarities.
       
   241 ignore-docstrings=yes
       
   242 
       
   243 # Ignore imports when computing similarities.
       
   244 ignore-imports=no
       
   245 
       
   246 
       
   247 [SPELLING]
       
   248 
       
   249 # Spelling dictionary name. Available dictionaries: none. To make it working
       
   250 # install python-enchant package.
       
   251 spelling-dict=
       
   252 
       
   253 # List of comma separated words that should not be checked.
       
   254 spelling-ignore-words=
       
   255 
       
   256 # A path to a file that contains private dictionary; one word per line.
       
   257 spelling-private-dict-file=
       
   258 
       
   259 # Tells whether to store unknown words to indicated private dictionary in
       
   260 # --spelling-private-dict-file option instead of raising a message.
       
   261 spelling-store-unknown-words=no
       
   262 
       
   263 
       
   264 [TYPECHECK]
       
   265 
       
   266 # Tells whether missing members accessed in mixin class should be ignored. A
       
   267 # mixin class is detected if its name ends with "mixin" (case insensitive).
       
   268 ignore-mixin-members=yes
       
   269 
       
   270 # List of module names for which member attributes should not be checked
       
   271 # (useful for modules/projects where namespaces are manipulated during runtime
       
   272 # and thus existing member attributes cannot be deduced by static analysis
       
   273 ignored-modules=
       
   274 
       
   275 # List of classes names for which member attributes should not be checked
       
   276 # (useful for classes with attributes dynamically set).
       
   277 ignored-classes=SQLObject
       
   278 
       
   279 # When zope mode is activated, add a predefined set of Zope acquired attributes
       
   280 # to generated-members.
       
   281 zope=no
       
   282 
       
   283 # List of members which are set dynamically and missed by pylint inference
       
   284 # system, and so shouldn't trigger E0201 when accessed. Python regular
       
   285 # expressions are accepted.
       
   286 generated-members=REQUEST,acl_users,aq_parent,objects
       
   287 
       
   288 
       
   289 [VARIABLES]
       
   290 
       
   291 # Tells whether we should check for unused import in __init__ files.
       
   292 init-import=no
       
   293 
       
   294 # A regular expression matching the name of dummy variables (i.e. expectedly
       
   295 # not used).
       
   296 dummy-variables-rgx=_$|dummy
       
   297 
       
   298 # List of additional names supposed to be defined in builtins. Remember that
       
   299 # you should avoid to define new builtins when possible.
       
   300 additional-builtins=
       
   301 
       
   302 # List of strings which can identify a callback function by name. A callback
       
   303 # name must start or end with one of those strings.
       
   304 callbacks=cb_,_cb
       
   305 
       
   306 
       
   307 [CLASSES]
       
   308 
       
   309 # List of interface methods to ignore, separated by a comma. This is used for
       
   310 # instance to not check methods defines in Zope's Interface base class.
       
   311 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
       
   312 
       
   313 # List of method names used to declare (i.e. assign) instance attributes.
       
   314 defining-attr-methods=__init__,__new__,setUp
       
   315 
       
   316 # List of valid names for the first argument in a class method.
       
   317 valid-classmethod-first-arg=cls
       
   318 
       
   319 # List of valid names for the first argument in a metaclass class method.
       
   320 valid-metaclass-classmethod-first-arg=mcs
       
   321 
       
   322 # List of member names, which should be excluded from the protected access
       
   323 # warning.
       
   324 exclude-protected=_asdict,_fields,_replace,_source,_make
       
   325 
       
   326 
       
   327 [DESIGN]
       
   328 
       
   329 # Maximum number of arguments for function / method
       
   330 max-args=5
       
   331 
       
   332 # Argument names that match this expression will be ignored. Default to name
       
   333 # with leading underscore
       
   334 ignored-argument-names=_.*
       
   335 
       
   336 # Maximum number of locals for function / method body
       
   337 max-locals=15
       
   338 
       
   339 # Maximum number of return / yield for function / method body
       
   340 max-returns=6
       
   341 
       
   342 # Maximum number of branch for function / method body
       
   343 max-branches=12
       
   344 
       
   345 # Maximum number of statements in function / method body
       
   346 max-statements=50
       
   347 
       
   348 # Maximum number of parents for a class (see R0901).
       
   349 max-parents=7
       
   350 
       
   351 # Maximum number of attributes for a class (see R0902).
       
   352 max-attributes=7
       
   353 
       
   354 # Minimum number of public methods for a class (see R0903).
       
   355 min-public-methods=2
       
   356 
       
   357 # Maximum number of public methods for a class (see R0904).
       
   358 max-public-methods=20
       
   359 
       
   360 
       
   361 [IMPORTS]
       
   362 
       
   363 # Deprecated modules which should not be used, separated by a comma
       
   364 deprecated-modules=stringprep,optparse
       
   365 
       
   366 # Create a graph of every (i.e. internal and external) dependencies in the
       
   367 # given file (report RP0402 must not be disabled)
       
   368 import-graph=
       
   369 
       
   370 # Create a graph of external dependencies in the given file (report RP0402 must
       
   371 # not be disabled)
       
   372 ext-import-graph=
       
   373 
       
   374 # Create a graph of internal dependencies in the given file (report RP0402 must
       
   375 # not be disabled)
       
   376 int-import-graph=
       
   377 
       
   378 
       
   379 [EXCEPTIONS]
       
   380 
       
   381 # Exceptions that will emit a warning when being caught. Defaults to
       
   382 # "Exception"
       
   383 overgeneral-exceptions=Exception