# Pylint configuration.

[MAIN]

# Python code to execute, usually for sys.path manipulation such as
# sys.path.append().
#init-hook=

# 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 base names, not paths.
#ignore-patterns=^\.#

# 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.
#ignore-paths=

# Pickle collected data for later comparisons.
persistent=no

# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
load-plugins=

# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
# number of processors available.
jobs=1

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

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

# Minimum supported python version. Defaults to the version of the interpreter
# running pylint; set it explicitly if you target an older runtime.
#py-version=3.9

# Discover python modules and packages in the file system subtree when a
# directory is passed on the command line.
recursive=no

# Specify a score threshold under which the program will exit with error.
#fail-under=10.0


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

# Disable the message, report, category or checker with the given id(s).
# We report [E]rrors and [F]atals only, so [C]onvention, [R]efactor and
# [W]arning are switched off wholesale.
disable=C,R,W

# Enable the message, report, category or checker with the given id(s).
# unknown-option-value (W0012) is re-enabled on purpose: it is what tells you
# that an option in this file has gone stale in a newer pylint.
enable=E,F,unknown-option-value


[REPORTS]

# Set the output format. Available formats are: text, parseable, colorized,
# json2, json, msvs and github. The dedicated "parseable" reporter is
# deprecated; it is exactly the text reporter plus the msg-template below.
output-format=text

# Template used to display messages. This is a python new-style format string
# used to format the message information.
msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg}

# Tells whether to display a full report or only the messages.
reports=no

# Activate the evaluation score.
score=no

# Python expression which should return a score less than or equal to 10. You
# have access to the variables 'fatal', 'error', 'warning', 'refactor',
# 'convention', 'info' and 'statement', which respectively contain the number
# of messages in each category and the total number of statements analyzed.
evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))


[BASIC]

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

# 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.
bad-names-rgxs=

# Colon-delimited sets of names that determine each other's naming style when
# the name regexes allow several styles.
name-group=

# Include a hint for the correct naming format with invalid-name.
include-naming-hint=no

# Regular expression matching correct function names.
function-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression matching correct variable names.
variable-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression matching correct constant names.
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$

# Regular expression matching correct attribute names.
attr-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression matching correct argument names.
argument-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression matching correct class attribute names.
class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$

# Regular expression matching correct inline iteration names.
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$

# Regular expression matching correct class names.
class-rgx=[A-Z_][a-zA-Z0-9]+$

# Regular expression matching correct module names.
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$

# Regular expression matching correct method names.
method-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx=^_

# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1


[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


[FORMAT]

# Maximum number of characters on a single line.
max-line-length=100

# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$

# 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

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

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

# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
# tab).
indent-string='    '

# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren=4

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


[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


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


[SIMILARITIES]

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

# Ignore comments when computing similarities.
ignore-comments=yes

# Ignore docstrings when computing similarities.
ignore-docstrings=yes

# Ignore imports when computing similarities.
ignore-imports=no

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


[SPELLING]

# 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

# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions=4


[TYPECHECK]

# List of decorators that produce context managers, such as
# contextlib.contextmanager.
contextmanager-decorators=contextlib.contextmanager

# List of symbolic message names to ignore for Mixin classes. This replaces the
# old boolean ignore-mixin-members option.
ignored-checks-for-mixins=no-member,not-async-context-manager,not-context-manager,attribute-defined-outside-init

# Regex pattern to define which classes are considered mixins.
mixin-class-rgx=.*[Mm]ixin

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

# 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

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

# Show a hint with possible names when a member name was not found.
missing-member-hint=yes


[VARIABLES]

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

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

# Tells whether unused global variables should be treated as a violation.
allow-global-unused-variables=yes

# List of additional names supposed to be defined in builtins. Remember that
# you should avoid defining new builtins when possible.
additional-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

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


[CLASSES]

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

# 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

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

# Warn about protected attribute access inside special methods.
check-protected-access-in-special-methods=no


[DESIGN]

# Maximum number of arguments for function / method.
max-args=5

# Argument names that match this expression will be ignored.
ignored-argument-names=_.*

# Maximum number of locals for function / method body.
max-locals=15

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

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

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

# Maximum number of parents for a class (see R0901).
max-parents=7

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

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

# Maximum number of public methods for a class (see R0904).
max-public-methods=20

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

# List of regular expressions of class ancestor names to ignore when counting
# public methods (see R0903).
exclude-too-few-public-methods=


[IMPORTS]

# Deprecated modules which should not be used, separated by a comma.
deprecated-modules=

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

# Allow explicit reexports by alias from a package __init__.
allow-any-import-level=

# Couples of modules and preferred modules, separated by a comma.
preferred-modules=

# Force import order to recognize a module as part of a third party library.
known-third-party=enchant

# Create a graph of every (i.e. internal and external) dependency in the given
# file (report RP0402 must not be disabled).
import-graph=

# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled).
ext-import-graph=

# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled).
int-import-graph=


[EXCEPTIONS]

# Exceptions that will emit a warning when caught. Names must be fully
# qualified as of pylint 2.16.
overgeneral-exceptions=builtins.Exception
