| 1 |
# This Pylint rcfile contains a best-effort configuration to uphold the |
| 2 |
# best-practices and style described in the Google Python style guide: |
| 3 |
# https://google.github.io/styleguide/pyguide.html |
| 4 |
# |
| 5 |
# Its canonical open-source location is: |
| 6 |
# https://google.github.io/styleguide/pylintrc |
| 7 |
|
| 8 |
[MASTER] |
| 9 |
|
| 10 |
# Files or directories to be skipped. They should be base names, not paths. |
| 11 |
ignore=third_party |
| 12 |
|
| 13 |
# Files or directories matching the regex patterns are skipped. The regex |
| 14 |
# matches against base names, not paths. |
| 15 |
ignore-patterns= |
| 16 |
|
| 17 |
# Pickle collected data for later comparisons. |
| 18 |
persistent=no |
| 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 |
|
| 24 |
# Use multiple processes to speed up Pylint. |
| 25 |
jobs=4 |
| 26 |
|
| 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 |
| 30 |
|
| 31 |
|
| 32 |
[MESSAGES CONTROL] |
| 33 |
|
| 34 |
# Only show warnings with the listed confidence levels. Leave empty to show |
| 35 |
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED |
| 36 |
confidence= |
| 37 |
|
| 38 |
# Enable the message, report, category or checker with the given id(s). You can |
| 39 |
# either give multiple identifier separated by comma (,) or put this option |
| 40 |
# multiple time (only on the command line, not in the configuration file where |
| 41 |
# it should appear only once). See also the "--disable" option for examples. |
| 42 |
#enable= |
| 43 |
|
| 44 |
# Disable the message, report, category or checker with the given id(s). You |
| 45 |
# can either give multiple identifiers separated by comma (,) or put this |
| 46 |
# option multiple times (only on the command line, not in the configuration |
| 47 |
# file where it should appear only once).You can also use "--disable=all" to |
| 48 |
# disable everything first and then reenable specific checks. For example, if |
| 49 |
# you want to run only the similarities checker, you can use "--disable=all |
| 50 |
# --enable=similarities". If you want to run only the classes checker, but have |
| 51 |
# no Warning level messages displayed, use"--disable=all --enable=classes |
| 52 |
# --disable=W" |
| 53 |
disable=abstract-method, |
| 54 |
apply-builtin, |
| 55 |
arguments-differ, |
| 56 |
attribute-defined-outside-init, |
| 57 |
backtick, |
| 58 |
bad-option-value, |
| 59 |
basestring-builtin, |
| 60 |
buffer-builtin, |
| 61 |
c-extension-no-member, |
| 62 |
consider-using-enumerate, |
| 63 |
cmp-builtin, |
| 64 |
cmp-method, |
| 65 |
coerce-builtin, |
| 66 |
coerce-method, |
| 67 |
delslice-method, |
| 68 |
div-method, |
| 69 |
duplicate-code, |
| 70 |
eq-without-hash, |
| 71 |
execfile-builtin, |
| 72 |
file-builtin, |
| 73 |
filter-builtin-not-iterating, |
| 74 |
fixme, |
| 75 |
getslice-method, |
| 76 |
global-statement, |
| 77 |
hex-method, |
| 78 |
idiv-method, |
| 79 |
implicit-str-concat, |
| 80 |
import-error, |
| 81 |
import-self, |
| 82 |
import-star-module-level, |
| 83 |
inconsistent-return-statements, |
| 84 |
input-builtin, |
| 85 |
intern-builtin, |
| 86 |
invalid-str-codec, |
| 87 |
locally-disabled, |
| 88 |
long-builtin, |
| 89 |
long-suffix, |
| 90 |
map-builtin-not-iterating, |
| 91 |
misplaced-comparison-constant, |
| 92 |
missing-function-docstring, |
| 93 |
metaclass-assignment, |
| 94 |
next-method-called, |
| 95 |
next-method-defined, |
| 96 |
no-absolute-import, |
| 97 |
no-else-break, |
| 98 |
no-else-continue, |
| 99 |
no-else-raise, |
| 100 |
no-else-return, |
| 101 |
no-init, # added |
| 102 |
no-member, |
| 103 |
no-name-in-module, |
| 104 |
no-self-use, |
| 105 |
nonzero-method, |
| 106 |
oct-method, |
| 107 |
old-division, |
| 108 |
old-ne-operator, |
| 109 |
old-octal-literal, |
| 110 |
old-raise-syntax, |
| 111 |
parameter-unpacking, |
| 112 |
print-statement, |
| 113 |
raising-string, |
| 114 |
range-builtin-not-iterating, |
| 115 |
raw_input-builtin, |
| 116 |
rdiv-method, |
| 117 |
reduce-builtin, |
| 118 |
relative-import, |
| 119 |
reload-builtin, |
| 120 |
round-builtin, |
| 121 |
setslice-method, |
| 122 |
signature-differs, |
| 123 |
standarderror-builtin, |
| 124 |
suppressed-message, |
| 125 |
sys-max-int, |
| 126 |
too-few-public-methods, |
| 127 |
too-many-ancestors, |
| 128 |
too-many-arguments, |
| 129 |
too-many-boolean-expressions, |
| 130 |
too-many-branches, |
| 131 |
too-many-instance-attributes, |
| 132 |
too-many-locals, |
| 133 |
too-many-nested-blocks, |
| 134 |
too-many-public-methods, |
| 135 |
too-many-return-statements, |
| 136 |
too-many-statements, |
| 137 |
trailing-newlines, |
| 138 |
unichr-builtin, |
| 139 |
unicode-builtin, |
| 140 |
unnecessary-pass, |
| 141 |
unpacking-in-except, |
| 142 |
useless-else-on-loop, |
| 143 |
useless-object-inheritance, |
| 144 |
useless-suppression, |
| 145 |
using-cmp-argument, |
| 146 |
wrong-import-order, |
| 147 |
xrange-builtin, |
| 148 |
zip-builtin-not-iterating, |
| 149 |
|
| 150 |
|
| 151 |
[REPORTS] |
| 152 |
|
| 153 |
# Set the output format. Available formats are text, parseable, colorized, msvs |
| 154 |
# (visual studio) and html. You can also give a reporter class, eg |
| 155 |
# mypackage.mymodule.MyReporterClass. |
| 156 |
output-format=text |
| 157 |
|
| 158 |
# Tells whether to display a full report or only the messages |
| 159 |
reports=no |
| 160 |
|
| 161 |
# Python expression which should return a note less than 10 (10 is the highest |
| 162 |
# note). You have access to the variables errors warning, statement which |
| 163 |
# respectively contain the number of errors / warnings messages and the total |
| 164 |
# number of statements analyzed. This is used by the global evaluation report |
| 165 |
# (RP0004). |
| 166 |
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) |
| 167 |
|
| 168 |
# Template used to display messages. This is a python new-style format string |
| 169 |
# used to format the message information. See doc for all details |
| 170 |
#msg-template= |
| 171 |
|
| 172 |
|
| 173 |
[BASIC] |
| 174 |
|
| 175 |
# Good variable names which should always be accepted, separated by a comma |
| 176 |
good-names=main,_ |
| 177 |
|
| 178 |
# Bad variable names which should always be refused, separated by a comma |
| 179 |
bad-names= |
| 180 |
|
| 181 |
# Colon-delimited sets of names that determine each other's naming style when |
| 182 |
# the name regexes allow several styles. |
| 183 |
name-group= |
| 184 |
|
| 185 |
# Include a hint for the correct naming format with invalid-name |
| 186 |
include-naming-hint=no |
| 187 |
|
| 188 |
# List of decorators that produce properties, such as abc.abstractproperty. Add |
| 189 |
# to this list to register other decorators that produce valid properties. |
| 190 |
property-classes=abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl |
| 191 |
|
| 192 |
# Regular expression matching correct function names |
| 193 |
function-rgx=^(?:(?P<exempt>setUp|tearDown|setUpModule|tearDownModule)|(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$ |
| 194 |
|
| 195 |
# Regular expression matching correct variable names |
| 196 |
variable-rgx=^[a-z][a-z0-9_]*$ |
| 197 |
|
| 198 |
# Regular expression matching correct constant names |
| 199 |
const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ |
| 200 |
|
| 201 |
# Regular expression matching correct attribute names |
| 202 |
attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ |
| 203 |
|
| 204 |
# Regular expression matching correct argument names |
| 205 |
argument-rgx=^[a-z][a-z0-9_]*$ |
| 206 |
|
| 207 |
# Regular expression matching correct class attribute names |
| 208 |
class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ |
| 209 |
|
| 210 |
# Regular expression matching correct inline iteration names |
| 211 |
inlinevar-rgx=^[a-z][a-z0-9_]*$ |
| 212 |
|
| 213 |
# Regular expression matching correct class names |
| 214 |
class-rgx=^_?[A-Z][a-zA-Z0-9]*$ |
| 215 |
|
| 216 |
# Regular expression matching correct module names |
| 217 |
module-rgx=^(_?[a-z][a-z0-9_]*|__init__)$ |
| 218 |
|
| 219 |
# Regular expression matching correct method names |
| 220 |
method-rgx=(?x)^(?:(?P<exempt>_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$ |
| 221 |
|
| 222 |
# Regular expression which should only match function or class names that do |
| 223 |
# not require a docstring. |
| 224 |
no-docstring-rgx=(__.*__|main|test.*|.*test|.*Test)$ |
| 225 |
|
| 226 |
# Minimum line length for functions/classes that require docstrings, shorter |
| 227 |
# ones are exempt. |
| 228 |
docstring-min-length=10 |
| 229 |
|
| 230 |
|
| 231 |
[TYPECHECK] |
| 232 |
|
| 233 |
# List of decorators that produce context managers, such as |
| 234 |
# contextlib.contextmanager. Add to this list to register other decorators that |
| 235 |
# produce valid context managers. |
| 236 |
contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager |
| 237 |
|
| 238 |
# Tells whether missing members accessed in mixin class should be ignored. A |
| 239 |
# mixin class is detected if its name ends with "mixin" (case insensitive). |
| 240 |
ignore-mixin-members=yes |
| 241 |
|
| 242 |
# List of module names for which member attributes should not be checked |
| 243 |
# (useful for modules/projects where namespaces are manipulated during runtime |
| 244 |
# and thus existing member attributes cannot be deduced by static analysis. It |
| 245 |
# supports qualified module names, as well as Unix pattern matching. |
| 246 |
ignored-modules= |
| 247 |
|
| 248 |
# List of class names for which member attributes should not be checked (useful |
| 249 |
# for classes with dynamically set attributes). This supports the use of |
| 250 |
# qualified names. |
| 251 |
ignored-classes=optparse.Values,thread._local,_thread._local |
| 252 |
|
| 253 |
# List of members which are set dynamically and missed by pylint inference |
| 254 |
# system, and so shouldn't trigger E1101 when accessed. Python regular |
| 255 |
# expressions are accepted. |
| 256 |
generated-members= |
| 257 |
|
| 258 |
|
| 259 |
[FORMAT] |
| 260 |
|
| 261 |
# Maximum number of characters on a single line. |
| 262 |
max-line-length=120 |
| 263 |
|
| 264 |
# TODO(https://github.com/PyCQA/pylint/issues/3352): Direct pylint to exempt |
| 265 |
# lines made too long by directives to pytype. |
| 266 |
|
| 267 |
# Regexp for a line that is allowed to be longer than the limit. |
| 268 |
ignore-long-lines=(?x)( |
| 269 |
^\s*(\#\ )?<?https?://\S+>?$| |
| 270 |
^\s*(from\s+\S+\s+)?import\s+.+$) |
| 271 |
|
| 272 |
# Allow the body of an if to be on the same line as the test if there is no |
| 273 |
# else. |
| 274 |
single-line-if-stmt=yes |
| 275 |
|
| 276 |
# Maximum number of lines in a module |
| 277 |
max-module-lines=99999 |
| 278 |
|
| 279 |
# String used as indentation unit. The internal Google style guide mandates 2 |
| 280 |
# spaces. Google's externaly-published style guide says 4, consistent with |
| 281 |
# PEP 8. Here, we use 2 spaces, for conformity with many open-sourced Google |
| 282 |
# projects (like TensorFlow). |
| 283 |
# milvus use 4 spaces |
| 284 |
indent-string=' ' |
| 285 |
|
| 286 |
# Number of spaces of indent required inside a hanging or continued line. |
| 287 |
indent-after-paren=4 |
| 288 |
|
| 289 |
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. |
| 290 |
expected-line-ending-format= |
| 291 |
|
| 292 |
|
| 293 |
[MISCELLANEOUS] |
| 294 |
|
| 295 |
# List of note tags to take in consideration, separated by a comma. |
| 296 |
notes=TODO |
| 297 |
|
| 298 |
|
| 299 |
[STRING] |
| 300 |
|
| 301 |
# This flag controls whether inconsistent-quotes generates a warning when the |
| 302 |
# character used as a quote delimiter is used inconsistently within a module. |
| 303 |
check-quote-consistency=yes |
| 304 |
|
| 305 |
|
| 306 |
[VARIABLES] |
| 307 |
|
| 308 |
# Tells whether we should check for unused import in __init__ files. |
| 309 |
init-import=no |
| 310 |
|
| 311 |
# A regular expression matching the name of dummy variables (i.e. expectedly |
| 312 |
# not used). |
| 313 |
dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) |
| 314 |
|
| 315 |
# List of additional names supposed to be defined in builtins. Remember that |
| 316 |
# you should avoid to define new builtins when possible. |
| 317 |
additional-builtins= |
| 318 |
|
| 319 |
# List of strings which can identify a callback function by name. A callback |
| 320 |
# name must start or end with one of those strings. |
| 321 |
callbacks=cb_,_cb |
| 322 |
|
| 323 |
# List of qualified module names which can have objects that can redefine |
| 324 |
# builtins. |
| 325 |
redefining-builtins-modules=six,six.moves,past.builtins,future.builtins,functools |
| 326 |
|
| 327 |
|
| 328 |
[LOGGING] |
| 329 |
|
| 330 |
# Logging modules to check that the string format arguments are in logging |
| 331 |
# function parameter format |
| 332 |
logging-modules=logging,absl.logging,tensorflow.io.logging |
| 333 |
|
| 334 |
|
| 335 |
[SIMILARITIES] |
| 336 |
|
| 337 |
# Minimum lines number of a similarity. |
| 338 |
min-similarity-lines=4 |
| 339 |
|
| 340 |
# Ignore comments when computing similarities. |
| 341 |
ignore-comments=yes |
| 342 |
|
| 343 |
# Ignore docstrings when computing similarities. |
| 344 |
ignore-docstrings=yes |
| 345 |
|
| 346 |
# Ignore imports when computing similarities. |
| 347 |
ignore-imports=no |
| 348 |
|
| 349 |
|
| 350 |
[SPELLING] |
| 351 |
|
| 352 |
# Spelling dictionary name. Available dictionaries: none. To make it working |
| 353 |
# install python-enchant package. |
| 354 |
spelling-dict= |
| 355 |
|
| 356 |
# List of comma separated words that should not be checked. |
| 357 |
spelling-ignore-words= |
| 358 |
|
| 359 |
# A path to a file that contains private dictionary; one word per line. |
| 360 |
spelling-private-dict-file= |
| 361 |
|
| 362 |
# Tells whether to store unknown words to indicated private dictionary in |
| 363 |
# --spelling-private-dict-file option instead of raising a message. |
| 364 |
spelling-store-unknown-words=no |
| 365 |
|
| 366 |
|
| 367 |
[IMPORTS] |
| 368 |
|
| 369 |
# Deprecated modules which should not be used, separated by a comma |
| 370 |
deprecated-modules=regsub, |
| 371 |
TERMIOS, |
| 372 |
Bastion, |
| 373 |
rexec, |
| 374 |
sets |
| 375 |
|
| 376 |
# Create a graph of every (i.e. internal and external) dependencies in the |
| 377 |
# given file (report RP0402 must not be disabled) |
| 378 |
import-graph= |
| 379 |
|
| 380 |
# Create a graph of external dependencies in the given file (report RP0402 must |
| 381 |
# not be disabled) |
| 382 |
ext-import-graph= |
| 383 |
|
| 384 |
# Create a graph of internal dependencies in the given file (report RP0402 must |
| 385 |
# not be disabled) |
| 386 |
int-import-graph= |
| 387 |
|
| 388 |
# Force import order to recognize a module as part of the standard |
| 389 |
# compatibility libraries. |
| 390 |
known-standard-library= |
| 391 |
|
| 392 |
# Force import order to recognize a module as part of a third party library. |
| 393 |
known-third-party=enchant, absl |
| 394 |
|
| 395 |
# Analyse import fallback blocks. This can be used to support both Python 2 and |
| 396 |
# 3 compatible code, which means that the block might have code that exists |
| 397 |
# only in one or another interpreter, leading to false positives when analysed. |
| 398 |
analyse-fallback-blocks=no |
| 399 |
|
| 400 |
|
| 401 |
[CLASSES] |
| 402 |
|
| 403 |
# List of method names used to declare (i.e. assign) instance attributes. |
| 404 |
defining-attr-methods=__init__, |
| 405 |
__new__, |
| 406 |
setUp |
| 407 |
|
| 408 |
# List of member names, which should be excluded from the protected access |
| 409 |
# warning. |
| 410 |
exclude-protected=_asdict, |
| 411 |
_fields, |
| 412 |
_replace, |
| 413 |
_source, |
| 414 |
_make |
| 415 |
|
| 416 |
# List of valid names for the first argument in a class method. |
| 417 |
valid-classmethod-first-arg=cls, |
| 418 |
class_ |
| 419 |
|
| 420 |
# List of valid names for the first argument in a metaclass class method. |
| 421 |
valid-metaclass-classmethod-first-arg=mcs |
| 422 |
|
| 423 |
|
| 424 |
[EXCEPTIONS] |
| 425 |
|
| 426 |
# Exceptions that will emit a warning when being caught. Defaults to |
| 427 |
# "Exception" |
| 428 |
overgeneral-exceptions=builtins.StandardError, |
| 429 |
builtins.Exception, |
| 430 |
builtins.BaseException |