From 5efb04e037f97dfefb3686b479ea01b11a223497 Mon Sep 17 00:00:00 2001 From: Kavi Gupta Date: Mon, 28 Apr 2025 15:16:32 -0400 Subject: [PATCH 1/4] re-enable lit --- .github/workflows/test.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 702155c..5f21c5b 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -25,8 +25,8 @@ jobs: pytest tests - name: Lint with pylint run: | - # pylint ast_scope setup.py - # pylint --disable=duplicate-code tests + pylint ast_scope setup.py + pylint --disable=duplicate-code tests isort ast_scope tests black ast_scope tests bash -c '[ $(git status --porcelain --untracked-files=no | wc -c) -eq 0 ] || (git status; git diff; exit 1)' From 37f8e568b5497f079711e220c199dc84c58c0d7c Mon Sep 17 00:00:00 2001 From: Kavi Gupta Date: Mon, 28 Apr 2025 15:36:40 -0400 Subject: [PATCH 2/4] fix a bunch of lint errors --- ast_scope/annotator.py | 56 ++++++++++++--------------- ast_scope/group_similar_constructs.py | 2 + ast_scope/pull_scope.py | 37 +++++++----------- ast_scope/scope.py | 1 - ast_scope/utils.py | 21 ++++++++++ tests/types_test.py | 2 + tests/utils.py | 14 ++++--- 7 files changed, 72 insertions(+), 61 deletions(-) diff --git a/ast_scope/annotator.py b/ast_scope/annotator.py index f12a2af..d94b0bb 100644 --- a/ast_scope/annotator.py +++ b/ast_scope/annotator.py @@ -2,7 +2,7 @@ import ast from .group_similar_constructs import GroupSimilarConstructsVisitor -from .utils import name_of_alias +from .utils import compute_class_fields, name_of_alias class IntermediateScope(abc.ABC): @@ -34,17 +34,10 @@ def global_frame(self): pass @abc.abstractmethod - def find(self, name, global_acceptable=True): + def find(self, name, is_assignment, global_acceptable=True): """ Finds the actual frame containing the variable name, or None if no frame exists """ - pass - - def true_parent(self): - parent = self.parent - while isinstance(parent, IntermediateClassScope): - parent = parent.parent - return parent class IntermediateGlobalScope(IntermediateScope): @@ -57,12 +50,23 @@ def global_frame(self): return self -class IntermediateFunctionScope(IntermediateScope): - def __init__(self, node, parent): +class IntermediateScopeWithParent(IntermediateScope): + def __init__(self, parent): super().__init__() - self.node = node self.parent = parent + def true_parent(self): + parent = self.parent + while isinstance(parent, IntermediateClassScope): + parent = parent.parent + return parent + + +class IntermediateFunctionScope(IntermediateScopeWithParent): + def __init__(self, node, parent): + super().__init__(parent) + self.node = node + def global_frame(self): return self.true_parent().global_frame() @@ -76,11 +80,10 @@ def find(self, name, is_assignment, global_acceptable=True): return self.true_parent().find(name, is_assignment, global_acceptable) -class IntermediateClassScope(IntermediateScope): +class IntermediateClassScope(IntermediateScopeWithParent): def __init__(self, node, parent, class_binds_near): - super().__init__() + super().__init__(parent) self.node = node - self.parent = parent self.class_binds_near = class_binds_near def global_frame(self): @@ -106,10 +109,7 @@ def __init__(self, scope, variable, annotation_dict): self.annotation_dict = annotation_dict def visit_generic(self, node): - raise RuntimeError("Unsupported node type: {node}".format(node=node)) - - def visit_Name(self, node): - super().visit_generic(node) + raise RuntimeError(f"Unsupported node type: {node}") def load(self): self.annotation_dict[self.variable] = self.variable.id, self.scope, False @@ -203,8 +203,8 @@ def visit_Lambda(self, func_node): ProcessArguments(self, subscope).visit(func_node.args) visit_all(subscope, func_node.body) - def visit_comprehension_generic(self, targets, comprehensions, typ): - del typ + def visit_comprehension_generic(self, targets, comprehensions, node): + del node current_scope = self for comprehension in comprehensions: self.annotate_intermediate_scope(comprehension, "", None) @@ -222,17 +222,9 @@ def visit_ClassDef(self, class_node): subscope = self.create_subannotator( IntermediateClassScope(class_node, self.scope, self.class_binds_near) ) - assert class_node._fields == ( - "name", - "bases", - "keywords", - "body", - "decorator_list", - ) - visit_all(subscope, class_node.body) - visit_all( - self, class_node.bases, class_node.keywords, class_node.decorator_list - ) + class_scope_fields, parent_scope_fields = compute_class_fields(class_node) + visit_all(subscope, *class_scope_fields) + visit_all(self, *parent_scope_fields) def visit_Global(self, global_node): for name in global_node.names: diff --git a/ast_scope/group_similar_constructs.py b/ast_scope/group_similar_constructs.py index 3239afd..a8dddf5 100644 --- a/ast_scope/group_similar_constructs.py +++ b/ast_scope/group_similar_constructs.py @@ -3,6 +3,7 @@ class GroupSimilarConstructsVisitor(ast.NodeVisitor): def visit_function_def(self, func_node, is_async): + del is_async return self.generic_visit(func_node) def visit_FunctionDef(self, func_node): @@ -12,6 +13,7 @@ def visit_AsyncFunctionDef(self, func_node): return self.visit_function_def(func_node, is_async=True) def visit_comprehension_generic(self, targets, comprehensions, node): + del targets, comprehensions return self.generic_visit(node) def visit_DictComp(self, comp_node): diff --git a/ast_scope/pull_scope.py b/ast_scope/pull_scope.py index 1633afd..979b2e5 100644 --- a/ast_scope/pull_scope.py +++ b/ast_scope/pull_scope.py @@ -1,11 +1,6 @@ -import ast +from ast_scope.utils import compute_class_fields -from .annotator import ( - IntermediateClassScope, - IntermediateFunctionScope, - IntermediateGlobalScope, - visit_all, -) +from .annotator import IntermediateGlobalScope, visit_all from .group_similar_constructs import GroupSimilarConstructsVisitor from .scope import ClassScope, ErrorScope, FunctionScope, GlobalScope @@ -48,15 +43,19 @@ def visit_alias(self, node): scope.add_import(node) super().generic_visit(node) - def visit_function_def(self, node, is_async): + def visit_function_def(self, func_node, is_async): del is_async - scope = self.pull_scope(node) - if node not in self.node_to_corresponding_scope: - self.node_to_corresponding_scope[node] = FunctionScope(node, scope) + scope = self.pull_scope(func_node) + if func_node not in self.node_to_corresponding_scope: + self.node_to_corresponding_scope[func_node] = FunctionScope( + func_node, scope + ) scope.add_function( - node, self.node_to_corresponding_scope[node], include_as_variable=True + func_node, + self.node_to_corresponding_scope[func_node], + include_as_variable=True, ) - super().generic_visit(node) + super().generic_visit(func_node) def visit_Lambda(self, node): scope = self.pull_scope(node, include_as_variable=False) @@ -90,13 +89,7 @@ def visit_ClassDef(self, node): scope = self.pull_scope(node) if node not in self.node_to_corresponding_scope: self.node_to_corresponding_scope[node] = ClassScope(node, scope) - assert node._fields == ( - "name", - "bases", - "keywords", - "body", - "decorator_list", - ) - visit_all(self, node.bases, node.keywords, node.decorator_list) + class_scope_fields, parent_scope_fields = compute_class_fields(node) + visit_all(self, *parent_scope_fields) scope.add_class(node, self.node_to_corresponding_scope[node]) - visit_all(self, node.body) + visit_all(self, *class_scope_fields) diff --git a/ast_scope/scope.py b/ast_scope/scope.py index 6e00525..1923cae 100644 --- a/ast_scope/scope.py +++ b/ast_scope/scope.py @@ -1,5 +1,4 @@ import abc -import ast import attr diff --git a/ast_scope/utils.py b/ast_scope/utils.py index 8ccc71a..2eae1c8 100644 --- a/ast_scope/utils.py +++ b/ast_scope/utils.py @@ -48,3 +48,24 @@ def name_of_alias(alias_node): if alias_node.asname is not None: return alias_node.asname return alias_node.name + + +def compute_class_fields(class_node): + """ + Compute the fields of a class node that are in the class scope, versus the parent scope. + + :returns: (class_fields, parent_fields) + two lists containing the fields in the class scope and the parent scope, respectively. + """ + assert class_node._fields == ( + "name", + "bases", + "keywords", + "body", + "decorator_list", + ) + return [class_node.body], [ + class_node.bases, + class_node.keywords, + class_node.decorator_list, + ] diff --git a/tests/types_test.py b/tests/types_test.py index 3e9bf8c..b0f30a6 100644 --- a/tests/types_test.py +++ b/tests/types_test.py @@ -23,6 +23,8 @@ def test_basic_assignment(self): scope_info = ast_scope.annotate(ast.parse(remove_directives(annotated_code))) self.assertEqual( + # This is a hack to get the adjacency list from the static dependency graph + # pylint: disable=protected-access scope_info.static_dependency_graph._DiGraph__adjacency_list, { "B": set(), diff --git a/tests/utils.py b/tests/utils.py index 27acf23..829e74e 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -23,15 +23,13 @@ def get_name(node): name = "" pos_info_node = node.target else: - raise RuntimeError("Unsupported node type: {node}".format(node=node)) + raise RuntimeError(f"Unsupported node type: {node}") return name, pos_info_node def description_of_node(node): name, pos = get_name(node) - return "{name}@{lineno}:{col_offset}".format( - name=name, lineno=pos.lineno, col_offset=pos.col_offset - ) + return f"{name}@{pos.lineno}:{pos.col_offset}" def description_of_scope(scope): @@ -43,12 +41,14 @@ def description_of_scope(scope): return "~" + description_of_node(scope.function_node) if isinstance(scope, ClassScope): return "-" + description_of_node(scope.class_node) - raise RuntimeError("Unsupported node type: {scope}".format(scope=scope)) + raise RuntimeError(f"Unsupported node type: {scope}") def display_annotated(code, class_binds_near): lines = [list(x) for x in code.split("\n")] tree = ast.parse(code) + # should probably expose this but whatever. + # pylint: disable=protected-access mapping = annotate(tree, class_binds_near)._node_to_containing_scope for node, scope in mapping.items(): if not hasattr(node, "lineno"): @@ -136,7 +136,9 @@ def replacer(match): code = remove_directives(annotated_code) scope_info = annotate(ast.parse(code), class_binds_near) - scope_info.static_dependency_graph # just check for errors + _ = scope_info.static_dependency_graph # just check for errors + # Checking some of the internals + # pylint: disable=protected-access self._check_nodes( scope_info._node_to_containing_scope, scope_info._global_scope, From ddd3e2a9a862258e84352c97b10a1e5bd977017e Mon Sep 17 00:00:00 2001 From: Kavi Gupta Date: Mon, 28 Apr 2025 15:36:51 -0400 Subject: [PATCH 3/4] bump --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index d459b0f..8afa49e 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="ast_scope", # Replace with your own username - version="0.4.5", + version="0.4.6", author="Kavi Gupta", author_email="ast_scope@kavigupta.org", description="Annotates a Python AST with the scope of symbols.", From 2f473a6aeb3866c7d616a10e3b8193abd4ce3eb8 Mon Sep 17 00:00:00 2001 From: Kavi Gupta Date: Mon, 28 Apr 2025 15:38:04 -0400 Subject: [PATCH 4/4] add a pylintrc --- .pylintrc | 642 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 642 insertions(+) create mode 100644 .pylintrc diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..f332a90 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,642 @@ +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.11 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + use-implicit-booleaness-not-comparison-to-string, + use-implicit-booleaness-not-comparison-to-zero, + invalid-sequence-index, + use-dict-literal, + unnecessary-lambda-assignment, + too-few-public-methods, + unspecified-encoding, + invalid-name, + # deal with this later + missing-function-docstring,missing-class-docstring,missing-module-docstring,import-outside-toplevel,too-many-arguments,too-many-locals,too-many-instance-attributes,too-many-return-statements,too-many-ancestors,too-many-public-methods,too-many-lines,line-too-long,fixme + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are: text, parseable, colorized, +# json2 (improved json format), json (old json format) and msvs (visual +# studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members=numpy.*, torch.*, torch.nn.functional.*, numpy.random.* + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace,numpy.random + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io