|
| 1 | +# lint Python modules using external checkers. |
| 2 | +# |
| 3 | +# This is the main checker controling the other ones and the reports |
| 4 | +# generation. It is itself both a raw checker and an astng checker in order |
| 5 | +# to: |
| 6 | +# * handle message activation / deactivation at the module level |
| 7 | +# * handle some basic but necessary stats'data (number of classes, methods...) |
| 8 | +# |
| 9 | +[MASTER] |
| 10 | + |
| 11 | +# Specify a configuration file. |
| 12 | +#rcfile= |
| 13 | + |
| 14 | +# Python code to execute, usually for sys.path manipulation such as |
| 15 | +# pygtk.require(). |
| 16 | +#init-hook= |
| 17 | + |
| 18 | +# Profiled execution. |
| 19 | +profile=no |
| 20 | + |
| 21 | +# Add <file or directory> to the black list. It should be a base name, not a |
| 22 | +# path. You may set this option multiple times. |
| 23 | +ignore=dist |
| 24 | +ignore=icons |
| 25 | +ignore=.hg |
| 26 | + |
| 27 | +# Pickle collected data for later comparisons. |
| 28 | +persistent=yes |
| 29 | + |
| 30 | +# Set the cache size for astng objects. |
| 31 | +cache-size=500 |
| 32 | + |
| 33 | +# List of plugins (as comma separated values of python modules names) to load, |
| 34 | +# usually to register additional checkers. |
| 35 | +load-plugins= |
| 36 | + |
| 37 | + |
| 38 | +[MESSAGES CONTROL] |
| 39 | + |
| 40 | +# Enable only checker(s) with the given id(s). This option conflicts with the |
| 41 | +# disable-checker option |
| 42 | +#enable-checker= |
| 43 | + |
| 44 | +# Enable all checker(s) except those with the given id(s). This option |
| 45 | +# conflicts with the enable-checker option |
| 46 | +disable-checker=SIMILARITIES |
| 47 | + |
| 48 | +# Enable all messages in the listed categories. |
| 49 | +#enable-msg-cat= |
| 50 | + |
| 51 | +# Disable all messages in the listed categories. |
| 52 | +#disable-msg-cat= |
| 53 | + |
| 54 | +# Enable the message(s) with the given id(s). |
| 55 | +#enable-msg= |
| 56 | + |
| 57 | +# Disable the message(s) with the given id(s). |
| 58 | +disable-msg=W0142,C0111 |
| 59 | + |
| 60 | + |
| 61 | +[REPORTS] |
| 62 | + |
| 63 | +# set the output format. Available formats are text, parseable, colorized, msvs |
| 64 | +# (visual studio) and html |
| 65 | +output-format=text |
| 66 | + |
| 67 | +# Include message's id in output |
| 68 | +include-ids=no |
| 69 | + |
| 70 | +# Put messages in a separate file for each module / package specified on the |
| 71 | +# command line instead of printing them on stdout. Reports (if any) will be |
| 72 | +# written in a file name "pylint_global.[txt|html]". |
| 73 | +files-output=no |
| 74 | + |
| 75 | +# Tells wether to display a full report or only the messages |
| 76 | +reports=yes |
| 77 | + |
| 78 | +# Python expression which should return a note less than 10 (10 is the highest |
| 79 | +# note).You have access to the variables errors warning, statement which |
| 80 | +# respectivly contain the number of errors / warnings messages and the total |
| 81 | +# number of statements analyzed. This is used by the global evaluation report |
| 82 | +# (R0004). |
| 83 | +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) |
| 84 | + |
| 85 | +# Add a comment according to your evaluation note. This is used by the global |
| 86 | +# evaluation report (R0004). |
| 87 | +comment=no |
| 88 | + |
| 89 | +# Enable the report(s) with the given id(s). |
| 90 | +#enable-report= |
| 91 | + |
| 92 | +# Disable the report(s) with the given id(s). |
| 93 | +#disable-report= |
| 94 | + |
| 95 | + |
| 96 | +# checks for : |
| 97 | +# * doc strings |
| 98 | +# * modules / classes / functions / methods / arguments / variables name |
| 99 | +# * number of arguments, local variables, branchs, returns and statements in |
| 100 | +# functions, methods |
| 101 | +# * required module attributes |
| 102 | +# * dangerous default values as arguments |
| 103 | +# * redefinition of function / method / class |
| 104 | +# * uses of the global statement |
| 105 | +# |
| 106 | +[BASIC] |
| 107 | + |
| 108 | +# Required attributes for module, separated by a comma |
| 109 | +required-attributes= |
| 110 | + |
| 111 | +# Regular expression which should only match functions or classes name which do |
| 112 | +# not require a docstring |
| 113 | +#no-docstring-rgx=__.*__ |
| 114 | +no-docstring-rgx=.* |
| 115 | + |
| 116 | +# Regular expression which should only match correct module names |
| 117 | +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ |
| 118 | + |
| 119 | +# Regular expression which should only match correct module level names |
| 120 | +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ |
| 121 | + |
| 122 | +# Regular expression which should only match correct class names |
| 123 | +class-rgx=[A-Z_][a-zA-Z0-9]+$ |
| 124 | + |
| 125 | +# Regular expression which should only match correct function names |
| 126 | +function-rgx=[a-z_][a-z0-9_]{1,30}$ |
| 127 | + |
| 128 | +# Regular expression which should only match correct method names |
| 129 | +method-rgx=[a-z_][a-z0-9_]{1,30}$ |
| 130 | + |
| 131 | +# Regular expression which should only match correct instance attribute names |
| 132 | +attr-rgx=[a-z_][a-z0-9_]{1,30}$ |
| 133 | + |
| 134 | +# Regular expression which should only match correct argument names |
| 135 | +argument-rgx=[a-z_][a-z0-9_]{1,30}$ |
| 136 | + |
| 137 | +# Regular expression which should only match correct variable names |
| 138 | +variable-rgx=[a-z_][a-z0-9_]{1,30}$ |
| 139 | + |
| 140 | +# Regular expression which should only match correct list comprehension / |
| 141 | +# generator expression variable names |
| 142 | +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ |
| 143 | + |
| 144 | +# Good variable names which should always be accepted, separated by a comma |
| 145 | +good-names=i,j,k,ex,Run,_,e |
| 146 | + |
| 147 | +# Bad variable names which should always be refused, separated by a comma |
| 148 | +bad-names=foo,bar,baz,toto,tutu,tata |
| 149 | + |
| 150 | +# List of builtins function names that should not be used, separated by a comma |
| 151 | +bad-functions=map,filter,apply,input |
| 152 | + |
| 153 | + |
| 154 | +# try to find bugs in the code using type inference |
| 155 | +# |
| 156 | +[TYPECHECK] |
| 157 | + |
| 158 | +# Tells wether missing members accessed in mixin class should be ignored. A |
| 159 | +# mixin class is detected if its name ends with "mixin" (case insensitive). |
| 160 | +ignore-mixin-members=yes |
| 161 | + |
| 162 | +# When zope mode is activated, consider the acquired-members option to ignore |
| 163 | +# access to some undefined attributes. |
| 164 | +zope=no |
| 165 | + |
| 166 | +# List of members which are usually get through zope's acquisition mecanism and |
| 167 | +# so shouldn't trigger E0201 when accessed (need zope=yes to be considered). |
| 168 | +acquired-members=REQUEST,acl_users,aq_parent |
| 169 | + |
| 170 | + |
| 171 | +# checks for |
| 172 | +# * unused variables / imports |
| 173 | +# * undefined variables |
| 174 | +# * redefinition of variable from builtins or from an outer scope |
| 175 | +# * use of variable before assigment |
| 176 | +# |
| 177 | +[VARIABLES] |
| 178 | + |
| 179 | +# Tells wether we should check for unused import in __init__ files. |
| 180 | +init-import=no |
| 181 | + |
| 182 | +# A regular expression matching names used for dummy variables (i.e. not used). |
| 183 | +dummy-variables-rgx=_|dummy |
| 184 | + |
| 185 | +# List of additional names supposed to be defined in builtins. Remember that |
| 186 | +# you should avoid to define new builtins when possible. |
| 187 | +additional-builtins= |
| 188 | + |
| 189 | + |
| 190 | +# checks for sign of poor/misdesign: |
| 191 | +# * number of methods, attributes, local variables... |
| 192 | +# * size, complexity of functions, methods |
| 193 | +# |
| 194 | +[DESIGN] |
| 195 | + |
| 196 | +# Maximum number of arguments for function / method |
| 197 | +max-args=5 |
| 198 | + |
| 199 | +# Maximum number of locals for function / method body |
| 200 | +max-locals=15 |
| 201 | + |
| 202 | +# Maximum number of return / yield for function / method body |
| 203 | +max-returns=6 |
| 204 | + |
| 205 | +# Maximum number of branch for function / method body |
| 206 | +max-branchs=12 |
| 207 | + |
| 208 | +# Maximum number of statements in function / method body |
| 209 | +max-statements=50 |
| 210 | + |
| 211 | +# Maximum number of parents for a class (see R0901). |
| 212 | +max-parents=7 |
| 213 | + |
| 214 | +# Maximum number of attributes for a class (see R0902). |
| 215 | +max-attributes=7 |
| 216 | + |
| 217 | +# Minimum number of public methods for a class (see R0903). |
| 218 | +min-public-methods=2 |
| 219 | + |
| 220 | +# Maximum number of public methods for a class (see R0904). |
| 221 | +max-public-methods=20 |
| 222 | + |
| 223 | + |
| 224 | +# checks for : |
| 225 | +# * methods without self as first argument |
| 226 | +# * overridden methods signature |
| 227 | +# * access only to existant members via self |
| 228 | +# * attributes not defined in the __init__ method |
| 229 | +# * supported interfaces implementation |
| 230 | +# * unreachable code |
| 231 | +# |
| 232 | +[CLASSES] |
| 233 | + |
| 234 | +# List of interface methods to ignore, separated by a comma. This is used for |
| 235 | +# instance to not check methods defines in Zope's Interface base class. |
| 236 | +ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by |
| 237 | + |
| 238 | +# List of method names used to declare (i.e. assign) instance attributes. |
| 239 | +defining-attr-methods=__init__,__new__,setUp |
| 240 | + |
| 241 | + |
| 242 | +# checks for |
| 243 | +# * external modules dependencies |
| 244 | +# * relative / wildcard imports |
| 245 | +# * cyclic imports |
| 246 | +# * uses of deprecated modules |
| 247 | +# |
| 248 | +[IMPORTS] |
| 249 | + |
| 250 | +# Deprecated modules which should not be used, separated by a comma |
| 251 | +deprecated-modules=regsub,string,TERMIOS,Bastion,rexec |
| 252 | + |
| 253 | +# Create a graph of every (i.e. internal and external) dependencies in the |
| 254 | +# given file (report R0402 must not be disabled) |
| 255 | +import-graph= |
| 256 | + |
| 257 | +# Create a graph of external dependencies in the given file (report R0402 must |
| 258 | +# not be disabled) |
| 259 | +ext-import-graph= |
| 260 | + |
| 261 | +# Create a graph of internal dependencies in the given file (report R0402 must |
| 262 | +# not be disabled) |
| 263 | +int-import-graph= |
| 264 | + |
| 265 | + |
| 266 | +# checks for: |
| 267 | +# * warning notes in the code like FIXME, XXX |
| 268 | +# * PEP 263: source code with non ascii character but no encoding declaration |
| 269 | +# |
| 270 | +[MISCELLANEOUS] |
| 271 | + |
| 272 | +# List of note tags to take in consideration, separated by a comma. |
| 273 | +notes=FIXME,XXX,TODO |
| 274 | + |
| 275 | + |
| 276 | +# checks for : |
| 277 | +# * unauthorized constructions |
| 278 | +# * strict indentation |
| 279 | +# * line length |
| 280 | +# * use of <> instead of != |
| 281 | +# |
| 282 | +[FORMAT] |
| 283 | + |
| 284 | +# Maximum number of characters on a single line. |
| 285 | +max-line-length=80 |
| 286 | + |
| 287 | +# Maximum number of lines in a module |
| 288 | +max-module-lines=1000 |
| 289 | + |
| 290 | +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 |
| 291 | +# tab). |
| 292 | +indent-string=' ' |
| 293 | + |
| 294 | + |
| 295 | +# checks for similarities and duplicated code. This computation may be |
| 296 | +# memory / CPU intensive, so you should disable it if you experiments some |
| 297 | +# problems. |
| 298 | +# |
| 299 | +[SIMILARITIES] |
| 300 | + |
| 301 | +# Minimum lines number of a similarity. |
| 302 | +min-similarity-lines=4 |
| 303 | + |
| 304 | +# Ignore comments when computing similarities. |
| 305 | +ignore-comments=yes |
| 306 | + |
| 307 | +# Ignore docstrings when computing similarities. |
| 308 | +ignore-docstrings=yes |
0 commit comments