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