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