Chris Liechti | b30d90a | 2016-04-23 23:36:43 +0200 | [diff] [blame] | 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. See also the "--disable" option for examples. |
| 51 | #enable= |
| 52 | |
| 53 | # Disable the message, report, category or checker with the given id(s). You |
| 54 | # can either give multiple identifiers separated by comma (,) or put this |
| 55 | # option multiple times (only on the command line, not in the configuration |
| 56 | # file where it should appear only once).You can also use "--disable=all" to |
| 57 | # disable everything first and then reenable specific checks. For example, if |
| 58 | # you want to run only the similarities checker, you can use "--disable=all |
| 59 | # --enable=similarities". If you want to run only the classes checker, but have |
| 60 | # no Warning level messages displayed, use"--disable=all --enable=classes |
| 61 | # --disable=W" |
| 62 | disable=import-star-module-level,old-octal-literal,oct-method,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 |
| 63 | |
| 64 | |
| 65 | [REPORTS] |
| 66 | |
| 67 | # Set the output format. Available formats are text, parseable, colorized, msvs |
| 68 | # (visual studio) and html. You can also give a reporter class, eg |
| 69 | # mypackage.mymodule.MyReporterClass. |
| 70 | output-format=text |
| 71 | |
| 72 | # Put messages in a separate file for each module / package specified on the |
| 73 | # command line instead of printing them on stdout. Reports (if any) will be |
| 74 | # written in a file name "pylint_global.[txt|html]". |
| 75 | files-output=no |
| 76 | |
| 77 | # Tells whether to display a full report or only the messages |
| 78 | reports=no |
| 79 | |
| 80 | # Python expression which should return a note less than 10 (10 is the highest |
| 81 | # note). You have access to the variables errors warning, statement which |
| 82 | # respectively contain the number of errors / warnings messages and the total |
| 83 | # number of statements analyzed. This is used by the global evaluation report |
| 84 | # (RP0004). |
| 85 | evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) |
| 86 | |
| 87 | # Template used to display messages. This is a python new-style format string |
| 88 | # used to format the message information. See doc for all details |
| 89 | msg-template={path}:{line}: {msg_id} {symbol}, {obj} {msg} |
| 90 | |
| 91 | |
| 92 | [SIMILARITIES] |
| 93 | |
| 94 | # Minimum lines number of a similarity. |
| 95 | min-similarity-lines=4 |
| 96 | |
| 97 | # Ignore comments when computing similarities. |
| 98 | ignore-comments=yes |
| 99 | |
| 100 | # Ignore docstrings when computing similarities. |
| 101 | ignore-docstrings=yes |
| 102 | |
| 103 | # Ignore imports when computing similarities. |
| 104 | ignore-imports=no |
| 105 | |
| 106 | |
| 107 | [MISCELLANEOUS] |
| 108 | |
| 109 | # List of note tags to take in consideration, separated by a comma. |
| 110 | notes=FIXME,XXX,TODO |
| 111 | |
| 112 | |
| 113 | [FORMAT] |
| 114 | |
| 115 | # Maximum number of characters on a single line. |
| 116 | max-line-length=120 |
| 117 | |
| 118 | # Regexp for a line that is allowed to be longer than the limit. |
| 119 | ignore-long-lines=^\s*(# )?<?https?://\S+>?$ |
| 120 | |
| 121 | # Allow the body of an if to be on the same line as the test if there is no |
| 122 | # else. |
| 123 | single-line-if-stmt=no |
| 124 | |
| 125 | # List of optional constructs for which whitespace checking is disabled. `dict- |
| 126 | # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. |
| 127 | # `trailing-comma` allows a space between comma and closing bracket: (a, ). |
| 128 | # `empty-line` allows space-only lines. |
| 129 | no-space-check=trailing-comma,dict-separator |
| 130 | |
| 131 | # Maximum number of lines in a module |
| 132 | max-module-lines=1000 |
| 133 | |
| 134 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 |
| 135 | # tab). |
| 136 | indent-string=' ' |
| 137 | |
| 138 | # Number of spaces of indent required inside a hanging or continued line. |
| 139 | indent-after-paren=4 |
| 140 | |
| 141 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. |
| 142 | expected-line-ending-format= |
| 143 | |
| 144 | |
| 145 | [LOGGING] |
| 146 | |
| 147 | # Logging modules to check that the string format arguments are in logging |
| 148 | # function parameter format |
| 149 | logging-modules=logging |
| 150 | |
| 151 | |
| 152 | [BASIC] |
| 153 | |
| 154 | # List of builtins function names that should not be used, separated by a comma |
| 155 | bad-functions=map,filter,input |
| 156 | |
| 157 | # Good variable names which should always be accepted, separated by a comma |
| 158 | good-names=i,j,k,ex,Run,_,n,z,c,b,e,ri,cd |
| 159 | |
| 160 | # Bad variable names which should always be refused, separated by a comma |
| 161 | bad-names=foo,bar,baz,toto,tutu,tata |
| 162 | |
| 163 | # Colon-delimited sets of names that determine each other's naming style when |
| 164 | # the name regexes allow several styles. |
| 165 | name-group= |
| 166 | |
| 167 | # Include a hint for the correct naming format with invalid-name |
| 168 | include-naming-hint=no |
| 169 | |
| 170 | # Regular expression matching correct function names |
| 171 | function-rgx=[a-z_][a-z0-9_]{2,30}$ |
| 172 | |
| 173 | # Naming hint for function names |
| 174 | function-name-hint=[a-z_][a-z0-9_]{2,30}$ |
| 175 | |
| 176 | # Regular expression matching correct variable names |
| 177 | variable-rgx=[a-z_][a-z0-9_]{2,30}$ |
| 178 | |
| 179 | # Naming hint for variable names |
| 180 | variable-name-hint=[a-z_][a-z0-9_]{2,30}$ |
| 181 | |
| 182 | # Regular expression matching correct constant names |
| 183 | const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ |
| 184 | |
| 185 | # Naming hint for constant names |
| 186 | const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ |
| 187 | |
| 188 | # Regular expression matching correct attribute names |
| 189 | attr-rgx=[a-z_][a-z0-9_]{2,30}$ |
| 190 | |
| 191 | # Naming hint for attribute names |
| 192 | attr-name-hint=[a-z_][a-z0-9_]{2,30}$ |
| 193 | |
| 194 | # Regular expression matching correct argument names |
| 195 | argument-rgx=[a-z_][a-z0-9_]{2,30}$ |
| 196 | |
| 197 | # Naming hint for argument names |
| 198 | argument-name-hint=[a-z_][a-z0-9_]{2,30}$ |
| 199 | |
| 200 | # Regular expression matching correct class attribute names |
| 201 | class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ |
| 202 | |
| 203 | # Naming hint for class attribute names |
| 204 | class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ |
| 205 | |
| 206 | # Regular expression matching correct inline iteration names |
| 207 | inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ |
| 208 | |
| 209 | # Naming hint for inline iteration names |
| 210 | inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ |
| 211 | |
| 212 | # Regular expression matching correct class names |
| 213 | class-rgx=[A-Z_][a-zA-Z0-9]+$ |
| 214 | |
| 215 | # Naming hint for class names |
| 216 | class-name-hint=[A-Z_][a-zA-Z0-9]+$ |
| 217 | |
| 218 | # Regular expression matching correct module names |
| 219 | module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ |
| 220 | |
| 221 | # Naming hint for module names |
| 222 | module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ |
| 223 | |
| 224 | # Regular expression matching correct method names |
| 225 | method-rgx=[a-z_][a-z0-9_]{2,30}$ |
| 226 | |
| 227 | # Naming hint for method names |
| 228 | method-name-hint=[a-z_][a-z0-9_]{2,30}$ |
| 229 | |
| 230 | # Regular expression which should only match function or class names that do |
| 231 | # not require a docstring. |
| 232 | no-docstring-rgx=^_ |
| 233 | |
| 234 | # Minimum line length for functions/classes that require docstrings, shorter |
| 235 | # ones are exempt. |
| 236 | docstring-min-length=-1 |
| 237 | |
| 238 | |
| 239 | [ELIF] |
| 240 | |
| 241 | # Maximum number of nested blocks for function / method body |
| 242 | max-nested-blocks=5 |
| 243 | |
| 244 | |
| 245 | [SPELLING] |
| 246 | |
| 247 | # Spelling dictionary name. Available dictionaries: none. To make it working |
| 248 | # install python-enchant package. |
| 249 | spelling-dict= |
| 250 | |
| 251 | # List of comma separated words that should not be checked. |
| 252 | spelling-ignore-words= |
| 253 | |
| 254 | # A path to a file that contains private dictionary; one word per line. |
| 255 | spelling-private-dict-file= |
| 256 | |
| 257 | # Tells whether to store unknown words to indicated private dictionary in |
| 258 | # --spelling-private-dict-file option instead of raising a message. |
| 259 | spelling-store-unknown-words=no |
| 260 | |
| 261 | |
| 262 | [TYPECHECK] |
| 263 | |
| 264 | # Tells whether missing members accessed in mixin class should be ignored. A |
| 265 | # mixin class is detected if its name ends with "mixin" (case insensitive). |
| 266 | ignore-mixin-members=yes |
| 267 | |
| 268 | # List of module names for which member attributes should not be checked |
| 269 | # (useful for modules/projects where namespaces are manipulated during runtime |
| 270 | # and thus existing member attributes cannot be deduced by static analysis. It |
| 271 | # supports qualified module names, as well as Unix pattern matching. |
| 272 | ignored-modules=urllib,asyncio,msvcrt,queue,socket |
| 273 | |
| 274 | # List of classes names for which member attributes should not be checked |
| 275 | # (useful for classes with attributes dynamically set). This supports can work |
| 276 | # with qualified names. |
| 277 | ignored-classes= |
| 278 | |
| 279 | # List of members which are set dynamically and missed by pylint inference |
| 280 | # system, and so shouldn't trigger E1101 when accessed. Python regular |
| 281 | # expressions are accepted. |
| 282 | generated-members= |
| 283 | |
| 284 | |
| 285 | [VARIABLES] |
| 286 | |
| 287 | # Tells whether we should check for unused import in __init__ files. |
| 288 | init-import=no |
| 289 | |
| 290 | # A regular expression matching the name of dummy variables (i.e. expectedly |
| 291 | # not used). |
| 292 | dummy-variables-rgx=_$|dummy |
| 293 | |
| 294 | # List of additional names supposed to be defined in builtins. Remember that |
| 295 | # you should avoid to define new builtins when possible. |
| 296 | additional-builtins= |
| 297 | |
| 298 | # List of strings which can identify a callback function by name. A callback |
| 299 | # name must start or end with one of those strings. |
| 300 | callbacks=cb_,_cb |
| 301 | |
| 302 | |
| 303 | [DESIGN] |
| 304 | |
| 305 | # Maximum number of arguments for function / method |
| 306 | max-args=5 |
| 307 | |
| 308 | # Argument names that match this expression will be ignored. Default to name |
| 309 | # with leading underscore |
| 310 | ignored-argument-names=_.* |
| 311 | |
| 312 | # Maximum number of locals for function / method body |
| 313 | max-locals=15 |
| 314 | |
| 315 | # Maximum number of return / yield for function / method body |
| 316 | max-returns=6 |
| 317 | |
| 318 | # Maximum number of branch for function / method body |
| 319 | max-branches=12 |
| 320 | |
| 321 | # Maximum number of statements in function / method body |
| 322 | max-statements=60 |
| 323 | |
| 324 | # Maximum number of parents for a class (see R0901). |
| 325 | max-parents=7 |
| 326 | |
| 327 | # Maximum number of attributes for a class (see R0902). |
| 328 | max-attributes=12 |
| 329 | |
| 330 | # Minimum number of public methods for a class (see R0903). |
| 331 | min-public-methods=2 |
| 332 | |
| 333 | # Maximum number of public methods for a class (see R0904). |
| 334 | max-public-methods=20 |
| 335 | |
| 336 | # Maximum number of boolean expressions in a if statement |
| 337 | max-bool-expr=5 |
| 338 | |
| 339 | |
| 340 | [IMPORTS] |
| 341 | |
| 342 | # Deprecated modules which should not be used, separated by a comma |
| 343 | deprecated-modules=regsub,TERMIOS,Bastion,rexec |
| 344 | |
| 345 | # Create a graph of every (i.e. internal and external) dependencies in the |
| 346 | # given file (report RP0402 must not be disabled) |
| 347 | import-graph= |
| 348 | |
| 349 | # Create a graph of external dependencies in the given file (report RP0402 must |
| 350 | # not be disabled) |
| 351 | ext-import-graph= |
| 352 | |
| 353 | # Create a graph of internal dependencies in the given file (report RP0402 must |
| 354 | # not be disabled) |
| 355 | int-import-graph= |
| 356 | |
| 357 | |
| 358 | [CLASSES] |
| 359 | |
| 360 | # List of method names used to declare (i.e. assign) instance attributes. |
| 361 | defining-attr-methods=__init__,__new__,setUp |
| 362 | |
| 363 | # List of valid names for the first argument in a class method. |
| 364 | valid-classmethod-first-arg=cls |
| 365 | |
| 366 | # List of valid names for the first argument in a metaclass class method. |
| 367 | valid-metaclass-classmethod-first-arg=mcs |
| 368 | |
| 369 | # List of member names, which should be excluded from the protected access |
| 370 | # warning. |
| 371 | exclude-protected=_asdict,_fields,_replace,_source,_make |
| 372 | |
| 373 | |
| 374 | [EXCEPTIONS] |
| 375 | |
| 376 | # Exceptions that will emit a warning when being caught. Defaults to |
| 377 | # "Exception" |
| 378 | overgeneral-exceptions=Exception |