pyproject.toml

[project]
name = "dynamically_gated_similarities"
version = "0.2.0"
authors = [
    { name = "Martin Steinborn", email = "martin.steinborn@stud.tu-darmstadt.de" },
]
description = "Code for Paper \"Tracking with Dynamically Gated Similarities\""
readme = "README.md"
requires-python = ">=3.10"
license = { text = "MIT" }
classifiers = [
    "Environment :: GPU :: NVIDIA CUDA :: 12.1",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3.10",
    "Typing :: Typed",
    "Development Status :: 4 - Beta",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Scientific/Engineering :: Image Processing",
]
dynamic = ["dependencies"]

# ########## #
# SETUPTOOLS #
# ########## #

[tool.setuptools]
py-modules = ["dgs"]

[tool.setuptools.dynamic]

[tool.setuptools.dynamic.optional-dependencies]
test = { file = ["./tests/requirements_test.txt"] }
docs = { file = ["./docs/requirements_docs.txt"] }

[project.urls]
Documentation = "https://bmmtstb.github.io/dynamically-gated-similarities/"
Source = "https://github.com/bmmtstb/dynamically-gated-similarities"

# ##### #
# BLACK #
# ##### #

[tool.black]
line-length = 120  # equal to .pylintrc
target-version = ['py310']
include = '\.pyi?$'
force-exclude = '''
/(
      dependencies
    | data
    | .*/venv/
)/
'''

# ######## #
# COVERAGE #
# ######## #

[tool.coverage.run]
branch = true
data_file = ".coverage"
source = ["dgs"]
omit = [
    "*/utils/torchtools.py",  # copied from torchreid
    "*/engine/*",  # engine cant really be tested without data
    "visualization.py",  # printing is hard to test
    "alphapose.py",  # alphapose is not yet fully supported
    "*/venv/*",  # all source files
]

[tool.coverage.paths]
source = ["dgs", "tests", "tests/helper.py"]

[tool.coverage.report]
fail_under = 60
skip_covered = true
skip_empty = true
ignore_errors = true
# Regexes for lines to exclude from consideration
exclude_also = [
    # Don't complain about missing debug-only code:
    "def __repr__", # string representation of objects
    "self\\.logger", # info logging shouldn't be tested

    # Don't complain if tests don't hit defensive assertion code:
    "assert ",
    "raise NotImplementedError",

    # Don't complain if non-runnable code isn't run:
    "if __name__ == .__main__.:",

    # Don't complain about abstract methods, they aren't run:
    "@(abc\\.)?abstractmethod",
]

[tool.coverage.html]
directory = "coverage/coverage_html_report"

[tool.coverage.xml]
output = "coverage/coverage.xml"