pyproject.toml

[tool.poetry]
name = "batteries-forking-included"
# WARNING: Don't forget to update the version number in src/bfi/template/bfi-base.sh
version = "0.1.2.dev0"
description = "A Pytest plugin to drop duplicated tests during collection, but will prefer keeping nested packages."
authors = ["Marximus Maximus <marximus@marximus.com>"]
license = "MIT"
maintainers = ["Marximus Maximus <marximus@marximus.com>"]
readme = "README.md"
homepage = "https://github.com/MarximusMaximus/batteries-forking-included"
repository = "https://github.com/MarximusMaximus/batteries-forking-included"
documentation = "https://github.com/MarximusMaximus/batteries-forking-included"
classifiers = [
    "Development Status :: 4 - Beta",
    "Framework :: Pytest",
    "Intended Audience :: Developers",
    "Topic :: Software Development :: Testing",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: Implementation :: CPython",
    "Operating System :: OS Independent",
    "License :: OSI Approved :: MIT License",
]
packages = [
    { include = "batteries_forking_included", from="src" },
    # { include = "pyproject.toml", from="src/batteries_forking_included", format="sdist"},
    # { include = "tests", format="sdist"},
    # { include = "CHANGELOG.rst", format="sdist"},
    # { include = "LICENSE", format="sdist"},
]
include = [
    # { path = "pyproject.toml", format="sdist"},
    # { path = "LICENSE", format="sdist"},
    # { path = "CHANGELOG.rst", format="sdist"},
    # { path = "tests", format="sdist"},
#     "CHANGELOG.rst",
#     "tests",
#     "activate.sh",
#     "batteries-forking-included.sh",
#     "bfi-base.sh",
#     "run.sh",
]

[tool.poetry.urls]
"Bug Tracker" = "https://github.com/MarximusMaximus/batteries-forking-included/issues"
"Source" = "https://github.com/MarximusMaximus/batteries-forking-included"
"Documentation" = "https://github.com/MarximusMaximus/batteries-forking-included"

# poetry, pyOpenSSL, PySocks are installed and required by the conda env,
# including them here as ">1" will prevent poetry from uninstalling them or
# their dependencies
# similarly, we need to specify a valid version of python
[tool.poetry.dependencies]
poetry = ">1"  # conda controls poetry version
pyOpenSSL = ">1"  # conda congtrol pyOpenSSL version
PySocks = ">1"  # conda control PySocks version
pip = ">1"  # prevents poetry from removing it
setuptools = ">1"  # prevents poetry from removing it
python = ">=3.8,<4"
packaging = ">1"

[tool.poetry.scripts]
bfi = "batteries_forking_included.__main__:scriptEntryPoint"
batteries-forking-included = "batteries_forking_included.__main__:scriptEntryPoint"

[tool.poetry.group.dev.dependencies]
pytest-cov = "4.0.0"
pipdeptree = "^2.2.1"
tox = "^3.25.0"
pytest-sugar = "^0.9.4"
mypy = "^0.971"
Pygments = "^2.12.0"
restructuredtext-lint = "^1.4.0"
pytest-html = "^3.1.1"
pre-commit = "^2.18.1"
pip-licenses = "^3.5.4"
flake8 = "^4.0.1"
flake8-bugbear = "^22.8.22"
flake8-docstrings = "^1.6.0"
flake8-commas = "^2.1.0"
flake8-pyi = "^22.4.1"
colorama = "^0.4.4"
pygrep = "^0.2"
bandit = "^1.7.4"
prospector = "^1.7.7"
vulture = "^2.4"
pylint = "^2.15.0"
pytest-prefer-nested-dup-tests = "^0.1.0"
pyright = "^1.1.269"
packaging = ">1"
pytest = "^7.1.2"
pytest-xdist = "^2.5.0"
pytest-subprocess = "^1.4.1"
esbonio = "^0.14.0"
pytest-shell-script-test-harness = {path = "../pytest-shell-script-test-harness", develop = true}
safety = "^2.3.3"
liccheck = "^0.7.3"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.mypy]
python_version=3.8
follow_imports="silent"
pretty=true
show_column_numbers=true
show_error_context=true
show_error_codes=true
strict=true
## strict enables vvvvv
# check_untyped_defs
# disallow_any_generics
# disallow_incomplete_defs
# disallow_subclassing_any
# disallow_untyped_calls
# disallow_untyped_decorators
# disallow_untyped_defs
# no_implicit_optional
no_implicit_reexport=false
# strict_concatenate
# strict_equality
# warn_redundant_casts
# warn_return_any
# warn_unused_configs
warn_unused_ignores=false
## strict enables ^^^^^
local_partial_types=true
show_none_errors=true
strict_optional=true
warn_unreachable=true

[[tool.mypy.overrides]]
module="pyparsing"
ignore_missing_imports=true

[[tool.mypy.overrides]]
module="pyparsing.*"
ignore_missing_imports=true

[[tool.mypy.overrides]]
module="jinja2"
ignore_missing_imports=true

[[tool.mypy.overrides]]
module="jinja2.*"
ignore_missing_imports=true

[tool.pyright]
pythonVersion=3.8
typeCheckingMode="strict"
## strict settings, from https://github.com/microsoft/pyright/blob/main/docs/configuration.md
## NOTE: Changes here need to be propagated to settings.json.
strictListInference=true
strictDictionaryInference=true
strictSetInference=true
strictParameterNoneValue=true
enableTypeIgnoreComments=true
reportMissingModuleSource="error"  # was "warning"
reportMissingImports="error"
reportUndefinedVariable="error"
reportAssertAlwaysTrue="error"
reportInvalidStringEscapeSequence="error"
reportInvalidTypeVarUse="error"
reportMissingTypeStubs="error"
reportSelfClsParameterName="error"
reportUnsupportedDunderAll="error"
reportUnusedExpression="error"
reportWildcardImportFromLibrary="error"
reportGeneralTypeIssues="error"
reportOptionalSubscript="error"
reportOptionalMemberAccess="error"
reportOptionalCall="error"
reportOptionalIterable="error"
reportOptionalContextManager="error"
reportOptionalOperand="error"
reportTypedDictNotRequiredAccess="error"
reportPrivateImportUsage="error"
reportUnboundVariable="error"
reportUnusedCoroutine="error"
reportConstantRedefinition="error"
reportDuplicateImport="error"
reportFunctionMemberAccess="error"
reportImportCycles="error"
reportIncompatibleMethodOverride="error"
reportIncompatibleVariableOverride="error"
reportIncompleteStub="error"
reportInconsistentConstructor="error"
reportInvalidStubStatement="error"
reportMatchNotExhaustive="error"
reportMissingParameterType="error"
reportMissingTypeArgument="error"
reportOverlappingOverload="error"
reportPrivateUsage="error"
reportTypeCommentUsage="error"
reportUnknownArgumentType="error"
reportUnknownLambdaType="error"
reportUnknownMemberType="error"
reportUnknownParameterType="error"
reportUnknownVariableType="error"
reportUnnecessaryCast="error"
reportUnnecessaryComparison="error"
reportUnnecessaryContains="error"
reportUnnecessaryIsInstance="error"
reportUnusedClass="error"
reportUnusedImport="error"
reportUnusedFunction="error"
reportUnusedVariable="error"
reportUntypedBaseClass="error"
reportUntypedClassDecorator="error"
reportUntypedFunctionDecorator="error"
reportUntypedNamedTuple="error"
reportCallInDefaultInitializer="error"  # was "none"
reportImplicitStringConcatenation="none"
reportMissingSuperCall="error"  # was "none"
reportPropertyTypeMismatch="error"  # was "none"
reportUninitializedInstanceVariable="error"  # was "none"
reportUnnecessaryTypeIgnoreComment="none"
reportUnusedCallResult="error"  # was "none"

# these options are used when running pytest directly on the command line,
#   via vscode, and during the 'coverage' env of tox
[tool.pytest.ini_options]
minversion = 7.1
# make XPASS ("unexpectedly passing") result to fail the test suite
xfail_strict = true
addopts = [
    # report details (verbose)
    "-v",
    # report the reasons for all tests that skipped, xfailed, xpassed, etc EXCEPT passed/Passed w/ Output
    "-ra",
    # colorize
    "--force-sugar",
    "--color=yes",
    # execute doctests directly from docstrings of your classes and functions
    "--doctest-modules",
    "--doctest-continue-on-failure",
    # show complete traceback
    "--tb=long",
    # show local variable values in traceback
    "--showlocals",
    # raise errors if using an unregistered marker
    "--strict-markers",
    # raise errors if the config is bad
    "--strict-config",
    # let's adopt the future mode already
    "--import-mode=importlib",
    # generate html report of test results (use the 'coverage' name for env b/c this is also used by that tox env)
    "--html=.reports/test-report-coverage.html",
    # html report should be single file
    "--self-contained-html",
    # parallelize tests across available cpu cores
    "-n=auto",
    # coverage (configured via .coveragerc)
    "--cov",
    # output coverage to terminal
    "--cov-report=term",
    # output coverage as html report (for human browsing from CI)
    "--cov-report=html",
    # output coverage as xml report (for CI reporting and VSCode reporting)
    "--cov-report=xml",
    # output xunit2/junit report
    "--junit-xml=junit.xml",
]
filterwarnings = [
    "error",
]
log_cli_level = "debug"
testpaths = ["."]
pythonpath = ["."]
norecursedirs = ["dist/*"]

# [tool.isort]
# verbose = true
# conda_env = "batteries-forking-included"
# multi_line_output = 3
# force_grid_wrap = 1
# indent = 4
# use_parentheses = true
# atomic = true
# lines_between_sections = 1
# include_trailing_comma = true
# force_alphabetical_sort_within_sections = true
# force_sort_within_sections = true
# group_by_package = true
# # ignore_comments = true
# remove_redundant_aliases = true
# # profile = "black"
# py_version = 38
# color_output = true
# src_paths = ["src", "tests"]
# sections = [
#     "FUTURE",
#     "STDLIB",
#     "DJANGOFIRST",
#     "DJANGOTHIRD",
#     "PANDAS",
#     "THIRDPARTY",
#     "FIRSTPARTY",
#     "LOCALFOLDER",
# ]
# default_section="THIRDPARTY"
# extra_standard_library = []
# known_djangofirst = ["django"]
# known_djangothird = [""]
# known_pandas = ["pandas","numpy"]
# known_third_party = []
# known_first_party = []
# known_local_folder = []

# comment_prefix = ""
# # import_heading_stdlib = "#===============================================================================\n#region Standard Library\n"
# # import_footer_stdlib = "\n#endregion Standard Library\n#==============================================================================="
# import_heading_stdlib = "#region Standard Library"
# import_footer_stdlib = "#endregion Standard Library"

[tool.vulture]
# exclude = ["file*.py", "dir/"]
# ignore_decorators = ["@app.route", "@require_*"]
# ignore_names = ["visit_*", "do_*"]
make_whitelist = true
min_confidence = 80
paths = ["src", "tests"]
sort_by_size = true
# verbose = true

[tool.bandit]
exclude = ["/example"]

[tool.pylint.main]
# 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 to be exceeded before program exits with error.
fail-under = 10

# Files or directories to be skipped. They should be base names, not paths.
ignore = []

# Add files or directories matching the regex patterns to the ignore-list. The
# regex matches against paths and can be in Posix or Windows format.
ignore-paths = [
    "^examples/",
]

# Files or directories matching the regex 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 =

# 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 = true

# Minimum Python version to use for version dependent checks. Will default to the
# version used to run pylint.
py-version = "3.8"

# When enabled, pylint would attempt to guess common misconfiguration and emit
# user-friendly hints instead of false-positive error messages.
suggestion-mode = true

# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
# unsafe-load-any-extension =

[tool.pylint.basic]
# Naming style matching correct argument names.
argument-naming-style = "snake_case"

# Naming style matching correct attribute names.
# attr-naming-style = "snake_case", but allow UPPER_CASE
attr-rgx = "([^\\dA-Z][^A-Z]{2,}|__.*__|[^\\da-z][^a-z]{2,})$"

# Bad variable names which should always be refused, separated by a comma.
bad-names = ["foo", "bar", "baz", "toto", "tutu", "tata", "qwerty", "asdf"]

# Naming style matching correct class attribute names.
class-attribute-rgx = "([^\\dA-Z][^A-Z]{2,}|__.*__|[^\\da-z][^a-z]{2,})$"

# Naming style matching correct class constant names.
class-const-naming-style = "UPPER_CASE"

# Naming style matching correct class names.
# class-naming-style = "PascalCase" but allow underscores
class-rgx = "[^\\W\\da-z][^\\W]+$"

# Naming style matching correct constant names.
const-naming-style = "UPPER_CASE"

# Naming style matching correct function names.
# function-naming-style = "camelCase" but allow underscoes
function-rgx = "([^\\W\\dA-Z].{2,}|__[^\\W\\dA-Z].+__)$"

# Good variable names which should always be accepted, separated by a comma.
good-names = [
    "_",
    "e",
    "err",
    "ex",
    "f",
    "i",
    "j",
    "k",
    "m",
    "o",
    "p",
    "ret",
    "_ret",
    "__ret",
    "Run",
    "s",
    "t",
    "w",
    "v",
    "x",
    "y",
    "z",
]

# Naming style matching correct inline iteration names.
inlinevar-naming-style = "snake_case"

# Naming style matching correct method names.
# method-naming-style = "camelCase"
method-rgx = "([^\\W\\dA-Z].{2,}|__[^\\W\\dA-Z].+__)$"

# # 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 = "([^\\W\\dA-Z][^\\WA-Z]*|[^\\W\\dA-Z][^\\W]*|[^\\W\\da-z][^\\W]+)$"

# 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 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"

[tool.pylint.classes]
# Warn about protected attribute access inside special methods
# check-protected-access-in-special-methods =

# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods = ["__init__", "__new__", "setUp", "__post_init__"]

# List of member names, which should be excluded from the protected access
# warning.
exclude-protected = ["_asdict", "_fields", "_replace", "_source", "_make"]

# 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 = ["cls"]

[tool.pylint.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 = 99

# Maximum number of attributes for a class (see R0902).
max-attributes = 99

# Maximum number of boolean expressions in an if statement (see R0916).
max-bool-expr = 99

# Maximum number of branch for function / method body.
max-branches = 45

# 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 = 99

# Maximum number of return / yield for function / method body.
max-returns = 6

# Maximum number of statements in function / method body.
max-statements = 999

# Minimum number of public methods for a class (see R0903).
min-public-methods = 0

[tool.pylint.exceptions]
# Exceptions that will emit a warning when caught.
overgeneral-exceptions = ["BaseException", "Exception"]

[tool.pylint.format]
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
expected-line-ending-format = "LF"

# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines = "^\\s*(# )?<?https?://\\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 = 9999

# Maximum number of lines in a module.
max-module-lines = 9999

# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
# single-line-class-stmt =

# Allow the body of an if to be on the same line as the test if there is no else.
# single-line-if-stmt =

[tool.pylint.imports]
# List of modules that can be imported at any level, not just the top level one.
# allow-any-import-level =

# Allow wildcard imports from modules that define __all__.
# allow-wildcard-with-all =

# 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 =

[tool.pylint.logging]
# The type of string formatting that logging methods do. `old` means using %
# formatting, `new` is for `{}` formatting.
logging-format-style = "new"

# Logging modules to check that the string format arguments are in logging
# function parameter format.
logging-modules = ["logging"]

[tool.pylint."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",  # we use both, don't flag
    "unnecessary-pass",  # flags trailing pass statements used for folding
    "pointless-string-statement",  # flags our bootstrapping shell code
    # "unnecessary-lambda",
    "wrong-import-position",  # we put our preambles first
    "subprocess-run-check",  # we do this often & bandit checks this too
    "unused-import",  # checked by flake8
]

# 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 = [
    "c-extension-no-member",
]

[tool.pylint.miscellaneous]
# List of note tags to take in consideration, separated by a comma.
notes = ["FIXME", "XXX"]

# Regular expression of note tags to take in consideration.
# notes-rgx =

[tool.pylint.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"]

[tool.pylint.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, json
# 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 = true

# Activate the evaluation score.
score = true

[tool.pylint.similarities]
# Comments are removed from the similarity computation
ignore-comments = true

# Docstrings are removed from the similarity computation
ignore-docstrings = true

# Imports are removed from the similarity computation
ignore-imports = true

# Signatures are removed from the similarity computation
ignore-signatures = true

# Minimum lines number of a similarity.
min-similarity-lines = 10

[tool.pylint.spelling]
# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions = 4

# Spelling dictionary name. Available dictionaries: none. To make it work,
# install the 'python-enchant' package.
# 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 =

[tool.pylint.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 = true

# 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 = true

[tool.pylint.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 =

# Tells whether missing members accessed in mixin class should be ignored. A
# class is considered mixin if its name matches the mixin-class-rgx option.
# Tells whether to warn about missing members when the owner of the attribute is
# inferred to be None.
ignore-none = true

# 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 = true

# 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"]

# 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 = true

# 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 =

[tool.pylint.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 = true

# List of names allowed to shadow builtins
allowed-redefined-builtins = false

# 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. Default to name with
# leading underscore.
ignored-argument-names = "_.*|^ignored_|^unused_"

# Tells whether we should check for unused import in __init__ files.
# init-import =

# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules = ["six.moves", "past.builtins", "future.builtins", "builtins", "io"]