github.com/NVIDIA/aistore@v1.3.23-0.20240517131212-7df6609be51d/python/.pylintrc-tests (about)

     1  [MASTER]
     2  
     3  # A comma-separated list of package or module names from where C extensions may
     4  # be loaded. Extensions are loading into the active Python interpreter and may
     5  # run arbitrary code.
     6  extension-pkg-allow-list=
     7  
     8  # A comma-separated list of package or module names from where C extensions may
     9  # be loaded. Extensions are loading into the active Python interpreter and may
    10  # run arbitrary code. (This is an alternative name to extension-pkg-allow-list
    11  # for backward compatibility.)
    12  extension-pkg-whitelist=
    13  
    14  # Return non-zero exit code if any of these messages/categories are detected,
    15  # even if score is above --fail-under value. Syntax same as enable. Messages
    16  # specified are enabled, while categories only check already-enabled messages.
    17  fail-on=
    18  
    19  # Specify a score threshold to be exceeded before program exits with error.
    20  fail-under=10.0
    21  
    22  # Files or directories to be skipped. They should be base names, not paths.
    23  ignore=CVS
    24  
    25  # Add files or directories matching the regex patterns to the ignore-list. The
    26  # regex matches against paths and can be in Posix or Windows format.
    27  ignore-paths=./tests/s3compat,./tests/integration/pytorch,./tests/unit/pytorch
    28  
    29  # Files or directories matching the regex patterns are skipped. The regex
    30  # matches against base names, not paths. The default value ignores emacs file
    31  # locks
    32  ignore-patterns=^\.#
    33  
    34  # Python code to execute, usually for sys.path manipulation such as
    35  # pygtk.require().
    36  #init-hook=
    37  
    38  # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
    39  # number of processors available to use.
    40  jobs=0
    41  
    42  # Control the amount of potential inferred values when inferring a single
    43  # object. This can help the performance when dealing with large functions or
    44  # complex, nested conditions.
    45  limit-inference-results=100
    46  
    47  # List of plugins (as comma separated values of python module names) to load,
    48  # usually to register additional checkers.
    49  load-plugins=
    50  
    51  # Pickle collected data for later comparisons.
    52  persistent=yes
    53  
    54  # Minimum Python version to use for version dependent checks. Will default to
    55  # the version used to run pylint.
    56  py-version=3.8
    57  
    58  # Discover python modules and packages in the file system subtree.
    59  recursive=no
    60  
    61  # When enabled, pylint would attempt to guess common misconfiguration and emit
    62  # user-friendly hints instead of false-positive error messages.
    63  suggestion-mode=yes
    64  
    65  # Allow loading of arbitrary C extensions. Extensions are imported into the
    66  # active Python interpreter and may run arbitrary code.
    67  unsafe-load-any-extension=no
    68  
    69  
    70  [MESSAGES CONTROL]
    71  
    72  # Only show warnings with the listed confidence levels. Leave empty to show
    73  # all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
    74  # UNDEFINED.
    75  confidence=
    76  
    77  # Disable the message, report, category or checker with the given id(s). You
    78  # can either give multiple identifiers separated by comma (,) or put this
    79  # option multiple times (only on the command line, not in the configuration
    80  # file where it should appear only once). You can also use "--disable=all" to
    81  # disable everything first and then re-enable specific checks. For example, if
    82  # you want to run only the similarities checker, you can use "--disable=all
    83  # --enable=similarities". If you want to run only the classes checker, but have
    84  # no Warning level messages displayed, use "--disable=all --enable=classes
    85  # --disable=W".
    86  disable=raw-checker-failed,
    87          bad-inline-option,
    88          locally-disabled,
    89          file-ignored,
    90          suppressed-message,
    91          useless-suppression,
    92          deprecated-pragma,
    93          use-symbolic-message-instead,
    94          broad-except,
    95          broad-exception-raised,
    96          missing-module-docstring,
    97          missing-class-docstring,
    98          missing-function-docstring
    99  
   100  # Enable the message, report, category or checker with the given id(s). You can
   101  # either give multiple identifier separated by comma (,) or put this option
   102  # multiple time (only on the command line, not in the configuration file where
   103  # it should appear only once). See also the "--disable" option for examples.
   104  enable=c-extension-no-member
   105  
   106  
   107  [REPORTS]
   108  
   109  # Python expression which should return a score less than or equal to 10. You
   110  # have access to the variables 'fatal', 'error', 'warning', 'refactor',
   111  # 'convention', and 'info' which contain the number of messages in each
   112  # category, as well as 'statement' which is the total number of statements
   113  # analyzed. This score is used by the global evaluation report (RP0004).
   114  evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
   115  
   116  # Template used to display messages. This is a python new-style format string
   117  # used to format the message information. See doc for all details.
   118  #msg-template=
   119  
   120  # Set the output format. Available formats are text, parseable, colorized, json
   121  # and msvs (visual studio). You can also give a reporter class, e.g.
   122  # mypackage.mymodule.MyReporterClass.
   123  output-format=text
   124  
   125  # Tells whether to display a full report or only the messages.
   126  reports=no
   127  
   128  # Activate the evaluation score.
   129  score=yes
   130  
   131  
   132  [REFACTORING]
   133  
   134  # Maximum number of nested blocks for function / method body
   135  max-nested-blocks=5
   136  
   137  # Complete name of functions that never returns. When checking for
   138  # inconsistent-return-statements if a never returning function is called then
   139  # it will be considered as an explicit return statement and no message will be
   140  # printed.
   141  never-returning-functions=sys.exit,argparse.parse_error
   142  
   143  
   144  [LOGGING]
   145  
   146  # The type of string formatting that logging methods do. `old` means using %
   147  # formatting, `new` is for `{}` formatting.
   148  logging-format-style=old
   149  
   150  # Logging modules to check that the string format arguments are in logging
   151  # function parameter format.
   152  logging-modules=logging
   153  
   154  
   155  [FORMAT]
   156  
   157  # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
   158  expected-line-ending-format=
   159  
   160  # Regexp for a line that is allowed to be longer than the limit.
   161  ignore-long-lines=^\s*(# )?<?https?://\S+>?$
   162  
   163  # Number of spaces of indent required inside a hanging or continued line.
   164  indent-after-paren=4
   165  
   166  # String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
   167  # tab).
   168  indent-string='    '
   169  
   170  # Maximum number of characters on a single line.
   171  max-line-length=120
   172  
   173  # Maximum number of lines in a module.
   174  max-module-lines=1000
   175  
   176  # Allow the body of a class to be on the same line as the declaration if body
   177  # contains single statement.
   178  single-line-class-stmt=no
   179  
   180  # Allow the body of an if to be on the same line as the test if there is no
   181  # else.
   182  single-line-if-stmt=no
   183  
   184  
   185  [SPELLING]
   186  
   187  # Limits count of emitted suggestions for spelling mistakes.
   188  max-spelling-suggestions=4
   189  
   190  # Spelling dictionary name. Available dictionaries: none. To make it work,
   191  # install the 'python-enchant' package.
   192  spelling-dict=
   193  
   194  # List of comma separated words that should be considered directives if they
   195  # appear and the beginning of a comment and should not be checked.
   196  spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
   197  
   198  # List of comma separated words that should not be checked.
   199  spelling-ignore-words=
   200  
   201  # A path to a file that contains the private dictionary; one word per line.
   202  spelling-private-dict-file=
   203  
   204  # Tells whether to store unknown words to the private dictionary (see the
   205  # --spelling-private-dict-file option) instead of raising a message.
   206  spelling-store-unknown-words=no
   207  
   208  
   209  [MISCELLANEOUS]
   210  
   211  # List of note tags to take in consideration, separated by a comma.
   212  notes=FIXME,
   213        XXX
   214  
   215  # Regular expression of note tags to take in consideration.
   216  #notes-rgx=
   217  
   218  
   219  [BASIC]
   220  
   221  # Naming style matching correct argument names.
   222  argument-naming-style=snake_case
   223  
   224  # Regular expression matching correct argument names. Overrides argument-
   225  # naming-style. If left empty, argument names will be checked with the set
   226  # naming style.
   227  #argument-rgx=
   228  
   229  # Naming style matching correct attribute names.
   230  attr-naming-style=snake_case
   231  
   232  # Regular expression matching correct attribute names. Overrides attr-naming-
   233  # style. If left empty, attribute names will be checked with the set naming
   234  # style.
   235  #attr-rgx=
   236  
   237  # Bad variable names which should always be refused, separated by a comma.
   238  bad-names=foo,
   239            bar,
   240            baz,
   241            toto,
   242            tutu,
   243            tata
   244  
   245  # Bad variable names regexes, separated by a comma. If names match any regex,
   246  # they will always be refused
   247  bad-names-rgxs=
   248  
   249  # Naming style matching correct class attribute names.
   250  class-attribute-naming-style=any
   251  
   252  # Regular expression matching correct class attribute names. Overrides class-
   253  # attribute-naming-style. If left empty, class attribute names will be checked
   254  # with the set naming style.
   255  #class-attribute-rgx=
   256  
   257  # Naming style matching correct class constant names.
   258  class-const-naming-style=UPPER_CASE
   259  
   260  # Regular expression matching correct class constant names. Overrides class-
   261  # const-naming-style. If left empty, class constant names will be checked with
   262  # the set naming style.
   263  #class-const-rgx=
   264  
   265  # Naming style matching correct class names.
   266  class-naming-style=PascalCase
   267  
   268  # Regular expression matching correct class names. Overrides class-naming-
   269  # style. If left empty, class names will be checked with the set naming style.
   270  #class-rgx=
   271  
   272  # Naming style matching correct constant names.
   273  const-naming-style=UPPER_CASE
   274  
   275  # Regular expression matching correct constant names. Overrides const-naming-
   276  # style. If left empty, constant names will be checked with the set naming
   277  # style.
   278  #const-rgx=
   279  
   280  # Minimum line length for functions/classes that require docstrings, shorter
   281  # ones are exempt.
   282  docstring-min-length=-1
   283  
   284  # Naming style matching correct function names.
   285  function-naming-style=snake_case
   286  
   287  # Regular expression matching correct function names. Overrides function-
   288  # naming-style. If left empty, function names will be checked with the set
   289  # naming style.
   290  #function-rgx=
   291  
   292  # Good variable names which should always be accepted, separated by a comma.
   293  good-names=i,
   294             j,
   295             k,
   296             ex,
   297             Run,
   298             _
   299  
   300  # Good variable names regexes, separated by a comma. If names match any regex,
   301  # they will always be accepted
   302  good-names-rgxs=
   303  
   304  # Include a hint for the correct naming format with invalid-name.
   305  include-naming-hint=no
   306  
   307  # Naming style matching correct inline iteration names.
   308  inlinevar-naming-style=any
   309  
   310  # Regular expression matching correct inline iteration names. Overrides
   311  # inlinevar-naming-style. If left empty, inline iteration names will be checked
   312  # with the set naming style.
   313  #inlinevar-rgx=
   314  
   315  # Naming style matching correct method names.
   316  method-naming-style=snake_case
   317  
   318  # Regular expression matching correct method names. Overrides method-naming-
   319  # style. If left empty, method names will be checked with the set naming style.
   320  #method-rgx=
   321  
   322  # Naming style matching correct module names.
   323  module-naming-style=snake_case
   324  
   325  # Regular expression matching correct module names. Overrides module-naming-
   326  # style. If left empty, module names will be checked with the set naming style.
   327  #module-rgx=
   328  
   329  # Colon-delimited sets of names that determine each other's naming style when
   330  # the name regexes allow several styles.
   331  name-group=
   332  
   333  # Regular expression which should only match function or class names that do
   334  # not require a docstring.
   335  no-docstring-rgx=^_
   336  
   337  # List of decorators that produce properties, such as abc.abstractproperty. Add
   338  # to this list to register other decorators that produce valid properties.
   339  # These decorators are taken in consideration only for invalid-name.
   340  property-classes=abc.abstractproperty
   341  
   342  # Regular expression matching correct type variable names. If left empty, type
   343  # variable names will be checked with the set naming style.
   344  #typevar-rgx=
   345  
   346  # Naming style matching correct variable names.
   347  variable-naming-style=snake_case
   348  
   349  # Regular expression matching correct variable names. Overrides variable-
   350  # naming-style. If left empty, variable names will be checked with the set
   351  # naming style.
   352  #variable-rgx=
   353  
   354  
   355  [SIMILARITIES]
   356  
   357  # Comments are removed from the similarity computation
   358  ignore-comments=yes
   359  
   360  # Docstrings are removed from the similarity computation
   361  ignore-docstrings=yes
   362  
   363  # Imports are removed from the similarity computation
   364  ignore-imports=no
   365  
   366  # Signatures are removed from the similarity computation
   367  ignore-signatures=no
   368  
   369  # Minimum lines number of a similarity.
   370  min-similarity-lines=4
   371  
   372  
   373  [VARIABLES]
   374  
   375  # List of additional names supposed to be defined in builtins. Remember that
   376  # you should avoid defining new builtins when possible.
   377  additional-builtins=
   378  
   379  # Tells whether unused global variables should be treated as a violation.
   380  allow-global-unused-variables=yes
   381  
   382  # List of names allowed to shadow builtins
   383  allowed-redefined-builtins=
   384  
   385  # List of strings which can identify a callback function by name. A callback
   386  # name must start or end with one of those strings.
   387  callbacks=cb_,
   388            _cb
   389  
   390  # A regular expression matching the name of dummy variables (i.e. expected to
   391  # not be used).
   392  dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
   393  
   394  # Argument names that match this expression will be ignored. Default to name
   395  # with leading underscore.
   396  ignored-argument-names=_.*|^ignored_|^unused_
   397  
   398  # Tells whether we should check for unused import in __init__ files.
   399  init-import=no
   400  
   401  # List of qualified module names which can have objects that can redefine
   402  # builtins.
   403  redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
   404  
   405  
   406  [TYPECHECK]
   407  
   408  # List of decorators that produce context managers, such as
   409  # contextlib.contextmanager. Add to this list to register other decorators that
   410  # produce valid context managers.
   411  contextmanager-decorators=contextlib.contextmanager
   412  
   413  # List of members which are set dynamically and missed by pylint inference
   414  # system, and so shouldn't trigger E1101 when accessed. Python regular
   415  # expressions are accepted.
   416  generated-members=
   417  
   418  # Tells whether missing members accessed in mixin class should be ignored. A
   419  # class is considered mixin if its name matches the mixin-class-rgx option.
   420  ignore-mixin-members=yes
   421  
   422  # Tells whether to warn about missing members when the owner of the attribute
   423  # is inferred to be None.
   424  ignore-none=yes
   425  
   426  # This flag controls whether pylint should warn about no-member and similar
   427  # checks whenever an opaque object is returned when inferring. The inference
   428  # can return multiple potential results while evaluating a Python object, but
   429  # some branches might not be evaluated, which results in partial inference. In
   430  # that case, it might be useful to still emit no-member and other checks for
   431  # the rest of the inferred objects.
   432  ignore-on-opaque-inference=yes
   433  
   434  # List of class names for which member attributes should not be checked (useful
   435  # for classes with dynamically set attributes). This supports the use of
   436  # qualified names.
   437  ignored-classes=optparse.Values,thread._local,_thread._local
   438  
   439  # List of module names for which member attributes should not be checked
   440  # (useful for modules/projects where namespaces are manipulated during runtime
   441  # and thus existing member attributes cannot be deduced by static analysis). It
   442  # supports qualified module names, as well as Unix pattern matching.
   443  ignored-modules=
   444  
   445  # Show a hint with possible names when a member name was not found. The aspect
   446  # of finding the hint is based on edit distance.
   447  missing-member-hint=yes
   448  
   449  # The minimum edit distance a name should have in order to be considered a
   450  # similar match for a missing member name.
   451  missing-member-hint-distance=1
   452  
   453  # The total number of similar names that should be taken in consideration when
   454  # showing a hint for a missing member.
   455  missing-member-max-choices=1
   456  
   457  # Regex pattern to define which classes are considered mixins ignore-mixin-
   458  # members is set to 'yes'
   459  mixin-class-rgx=.*[Mm]ixin
   460  
   461  # List of decorators that change the signature of a decorated function.
   462  signature-mutators=
   463  
   464  
   465  [STRING]
   466  
   467  # This flag controls whether inconsistent-quotes generates a warning when the
   468  # character used as a quote delimiter is used inconsistently within a module.
   469  check-quote-consistency=no
   470  
   471  # This flag controls whether the implicit-str-concat should generate a warning
   472  # on implicit string concatenation in sequences defined over several lines.
   473  check-str-concat-over-line-jumps=no
   474  
   475  
   476  [IMPORTS]
   477  
   478  # List of modules that can be imported at any level, not just the top level
   479  # one.
   480  allow-any-import-level=
   481  
   482  # Allow wildcard imports from modules that define __all__.
   483  allow-wildcard-with-all=no
   484  
   485  # Deprecated modules which should not be used, separated by a comma.
   486  deprecated-modules=
   487  
   488  # Output a graph (.gv or any supported image format) of external dependencies
   489  # to the given file (report RP0402 must not be disabled).
   490  ext-import-graph=
   491  
   492  # Output a graph (.gv or any supported image format) of all (i.e. internal and
   493  # external) dependencies to the given file (report RP0402 must not be
   494  # disabled).
   495  import-graph=
   496  
   497  # Output a graph (.gv or any supported image format) of internal dependencies
   498  # to the given file (report RP0402 must not be disabled).
   499  int-import-graph=
   500  
   501  # Force import order to recognize a module as part of the standard
   502  # compatibility libraries.
   503  known-standard-library=
   504  
   505  # Force import order to recognize a module as part of a third party library.
   506  known-third-party=enchant
   507  
   508  # Couples of modules and preferred modules, separated by a comma.
   509  preferred-modules=
   510  
   511  
   512  [DESIGN]
   513  
   514  # List of regular expressions of class ancestor names to ignore when counting
   515  # public methods (see R0903)
   516  exclude-too-few-public-methods=
   517  
   518  # List of qualified class names to ignore when counting class parents (see
   519  # R0901)
   520  ignored-parents=
   521  
   522  # Maximum number of arguments for function / method.
   523  max-args=5
   524  
   525  # Maximum number of attributes for a class (see R0902).
   526  max-attributes=7
   527  
   528  # Maximum number of boolean expressions in an if statement (see R0916).
   529  max-bool-expr=5
   530  
   531  # Maximum number of branch for function / method body.
   532  max-branches=12
   533  
   534  # Maximum number of locals for function / method body.
   535  max-locals=15
   536  
   537  # Maximum number of parents for a class (see R0901).
   538  max-parents=7
   539  
   540  # Maximum number of public methods for a class (see R0904).
   541  max-public-methods=20
   542  
   543  # Maximum number of return / yield for function / method body.
   544  max-returns=6
   545  
   546  # Maximum number of statements in function / method body.
   547  max-statements=50
   548  
   549  # Minimum number of public methods for a class (see R0903).
   550  min-public-methods=2
   551  
   552  
   553  [CLASSES]
   554  
   555  # Warn about protected attribute access inside special methods
   556  check-protected-access-in-special-methods=no
   557  
   558  # List of method names used to declare (i.e. assign) instance attributes.
   559  defining-attr-methods=__init__,
   560                        __new__,
   561                        setUp,
   562                        __post_init__
   563  
   564  # List of member names, which should be excluded from the protected access
   565  # warning.
   566  exclude-protected=_asdict,
   567                    _fields,
   568                    _replace,
   569                    _source,
   570                    _make
   571  
   572  # List of valid names for the first argument in a class method.
   573  valid-classmethod-first-arg=cls
   574  
   575  # List of valid names for the first argument in a metaclass class method.
   576  valid-metaclass-classmethod-first-arg=cls
   577  
   578  
   579  [EXCEPTIONS]
   580  
   581  # Exceptions that will emit a warning when being caught. Defaults to
   582  # "BaseException, Exception".
   583  overgeneral-exceptions=builtin.BaseException,
   584                         builtin.Exception