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