pyproject.toml

[project]
name = "reliabletxt"
version = "0.0.1"
requires-python = ">=3.10, <3.12"
authors = [{ name = "Tim Hörmann" }, { email = "tim.hoermann@cup.uni-muenchen.de" }]
description = "Fork from stenway/reliabletxt"
readme = "README.md"
dependencies = [
    
]

[project.optional-dependencies]
dev = [
    "types-Pillow",
    "types-tqdm",
    "types-toml",
    "mypy",
    "isort",
    "black",
    "pylint",
    "pytest",
    "snakeviz",
    "notebook",
    "sphinx",
    "myst-parser",
    "sphinx-rtd-theme",
]

[project.urls]
homepage = "https://www.github.com/tim25651/reliabletxt"
repository = "https://www.github.com/tim25651/reliabletxt"

[tool.setuptools.packages.find]
where = ["src"]
include = ["reliabletxt*"]

[tool.isort]
profile = "black"

[tool.black]
target-version = ["py310"]
line-length = 88
# include src and tests regex .pyi?$ to include type hints
include = '(src|examples|tests)\/.*\.py'
# unstable
unstable = true

[tool.mypy]
# ignore_missing_imports = true
enable_error_code = '''type-arg,no-untyped-def,redundant-cast,redundant-self,comparison-overlap,
                    no-untyped-call,no-any-return,no-any-unimported,unreachable,redundant-expr,
                    possibly-undefined,truthy-bool,truthy-iterable,ignore-without-code,
                    unused-awaitable,unused-ignore,explicit-override,unimported-reveal'''
disable_error_code = 'import-untyped'
disallow_untyped_calls = true
disallow_untyped_defs = true
warn_unused_ignores = true
warn_redundant_casts = true
warn_return_any = true
warn_unreachable = true
exclude = ["rdkit-stubs", "OLD", "build", "docs", "test"]

[tool.pylint.MASTER]

# CUSTOM: Minimum supported Python version.
py-version = '3.10' # custom change

# Files or directories to be skipped. They should be base names, not paths.
ignore = 'third_party,rdkit-stubs'

# Files or directories matching the regex patterns are skipped. The regex
# matches against base names, not paths.
ignore-patterns = ''

# Pickle collected data for later comparisons.
persistent = 'no'

# List of plugins (as comma separated values of python modules names) to load,
# usually to register additional checkers.
# CUSTOM: All plugins are custom additions to the Google style guide.
load-plugins = '''
    pylint.extensions.check_elif,
    pylint.extensions.bad_builtin,
    pylint.extensions.docparams,
    pylint.extensions.for_any_all,
    pylint.extensions.set_membership,
    pylint.extensions.code_style,
    pylint.extensions.overlapping_exceptions,
    pylint.extensions.typing,
    pylint.extensions.redefined_variable_type,
    pylint.extensions.comparison_placement,
    pylint.extensions.mccabe,
    '''

# Use multiple processes to speed up Pylint.
jobs = 8

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


[tool.pylint."MESSAGES CONTROL"]

# Only show warnings with the listed confidence levels. Leave empty to show
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
confidence = ''

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

# All enables are custom additions to the Google style guide.
enable = '''
    R,
    use-symbolic-message-instead,
    abstract-method,
    attribute-defined-outside-init,
    bad-option-value,
    arguments-differ,
    c-extension-no-member,
    consider-using-enumerate,
    useless-suppression,
    no-member,
    no-name-in-module,
    wrong-import-order, 
    global-statement,
    missing-function-docstring,
    signature-differs,
    unnecessary-pass,
    useless-else-on-loop, 
    import-error,
    import-self,
    misplaced-comparison-constant,
    trailing-newlines,
    '''

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

# implicit-str-concat is disabled because 
# it is explicitly allowed by Google style guide
disable = '''
      implicit-str-concat,
      suppressed-message,
      locally-disabled,
      too-few-public-methods,
      fixme,
      '''

# CUSTOM: Complete design section is a custom addition to the Google style guide.


[tool.pylint.REPORTS]

# Set the output format. Available formats are text, parseable, colorized, msvs
# (visual studio) and html. You can also give a reporter class, eg
# mypackage.mymodule.MyReporterClass.
output-format = 'text'

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

# Python expression which should return a note less than 10 (10 is the highest
# note). You have access to the variables errors warning, statement which
# respectively contain the number of errors / warnings messages and the total
# number of statements analyzed. This is used by the global evaluation report
# (RP0004).
evaluation = '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=

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


[tool.pylint.LOGGING]

# Logging modules to check that the string format arguments are in logging
# function parameter format
logging-modules = 'logging,absl.logging,tensorflow.io.logging'


[tool.pylint.SPELLING]

# Spelling dictionary name. Available dictionaries: none. To make it working
# install python-enchant package.
spelling-dict = ''

# List of comma separated words that should not be checked.
spelling-ignore-words = ''

# A path to a file that contains private dictionary; one word per line.
spelling-private-dict-file = ''

# Tells whether to store unknown words to indicated private dictionary in
# --spelling-private-dict-file option instead of raising a message.
spelling-store-unknown-words = 'no'

[tool.pylint.MISCELLANEOUS]

# List of note tags to take in consideration, separated by a comma.
notes = 'TODO'


[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,contextlib2.contextmanager'

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

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

[tool.pylint.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. expectedly
# not used).
dummy-variables-rgx = '^\*{0,2}(_$|unused_|dummy_)'

# List of additional names supposed to be defined in builtins. Remember that
# you should avoid to define 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,six.moves,past.builtins,future.builtins,functools'


[tool.pylint.FORMAT]

# Maximum number of characters on a single line.
max-line-length = 88 # custom change

# TODO(https://github.com/pylint-dev/pylint/issues/3352): Direct pylint to exempt
# lines made too long by directives to pytype.

# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines = '''(?x)(
  ^\s*(\#\ )?<?https?://\S+>?$|
  ^\s*(from\s+\S+\s+)?import\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 = 'yes'

# Maximum number of lines in a module
max-module-lines = 99999

# String used as indentation unit.  The internal Google style guide mandates 2
# spaces.  Google's externaly-published style guide says 4, consistent with
# PEP 8.  Here, we use 2 spaces, for conformity with many open-sourced Google
# projects (like TensorFlow).
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 = ''

[tool.pylint.SIMILARITIES]

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

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

# Ignore imports when computing similarities.
ignore-imports = 'yes' # custom change

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


[tool.pylint.BASIC]

# Good variable names which should always be accepted, separated by a comma
good-names = 'main,_'

# Bad variable names which should always be refused, separated by a comma
bad-names = ''

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

# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
property-classes = 'abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl'

# Regular expression matching correct function names
function-rgx = '^(?:(?P<exempt>setUp|tearDown|setUpModule|tearDownModule)|(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$'

# Regular expression matching correct variable names
variable-rgx = '^[a-z][a-z0-9_]*$'

# Regular expression matching correct constant names
const-rgx = '^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$'

# Regular expression matching correct attribute names
attr-rgx = '^_{0,2}[a-z][a-z0-9_]*$'

# Regular expression matching correct argument names
argument-rgx = '^[a-z][a-z0-9_]*$'

# Regular expression matching correct class attribute names
class-attribute-rgx = '^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$'

# Regular expression matching correct inline iteration names
inlinevar-rgx = '^[a-z][a-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_]*|__init__)$'

# Regular expression matching correct method names
method-rgx = '(?x)^(?:(?P<exempt>_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$'

# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx = '(__.*__|main|test.*|.*test|.*Test)$'

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


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


[tool.pylint.IMPORTS]

# Deprecated modules which should not be used, separated by a comma
deprecated-modules = '''regsub,
                   TERMIOS,
                   Bastion,
                   rexec,
                   sets'''

# Create a graph of every (i.e. internal and external) dependencies 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 = ''

# 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, absl'

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

[tool.pylint.CLASSES]

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

# 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,
                            class_'''

# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg = 'mcs'


[tool.pylint.DESIGN]

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

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

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

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

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

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

# List of qualified class names to ignore when counting class parents (see R0901).
ignored-parents = ''

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

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

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

max-complexity = 10