pyproject.toml

[project]
name = "dags"
description = "Tools to create executable dags from interdependent functions."
requires-python = ">=3.11"
dynamic = ["version"]
dependencies = [
    "networkx>=3.6",
    "flatten-dict",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "License :: OSI Approved :: MIT License",
    "Operating System :: MacOS :: MacOS X",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: POSIX",
    "Operating System :: Unix",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Topic :: Utilities",
    "Typing :: Typed",
]
authors = [
    {name = "Janoś Gabler", email = "janos.gabler@gmail.com"},
    {name = "Tobias Raabe"}
]
maintainers = [
    {name = "Hans-Martin von Gaudecker", email = "hmgaudecker@uni-bonn.de" }
]


[project.readme]
file = "README.md"
content-type = "text/markdown"

[project.license]
file = "LICENSE"

[project.urls]
Repository = "https://github.com/OpenSourceEconomics/dags"
Github = "https://github.com/OpenSourceEconomics/dags"
Tracker = "https://github.com/OpenSourceEconomics/dags/issues"


# ======================================================================================
# Build system configuration
# ======================================================================================

[build-system]
requires = ["hatchling", "hatch_vcs"]
build-backend = "hatchling.build"

[tool.hatch.build.hooks.vcs]
version-file = "src/dags/_version.py"

[tool.hatch.build.targets.sdist]
exclude = ["tests"]
only-packages = true

[tool.hatch.build.targets.wheel]
only-include = ["src"]
sources = ["src"]
include = [
    "src/dags/py.typed",
]

[tool.hatch.version]
source = "vcs"

[tool.hatch.metadata]
allow-direct-references = true


# ======================================================================================
# Pixi
# ======================================================================================

[tool.pixi.workspace]
channels = ["conda-forge"]
platforms = ["linux-64", "osx-64", "osx-arm64", "win-64"]

# Development Dependencies
# --------------------------------------------------------------------------------------

[tool.pixi.dependencies]
python = ">=3.11,<3.15"
jupyterlab = "*"
pre-commit = "*"
pytest = "*"
pytest-cov = "*"
pytest-xdist = "*"

[tool.pixi.pypi-dependencies]
dags = {path = ".", editable = true}
ty = ">=0.0.11"
types-networkx = ">=3.6.1.20251220"
pdbp = "*"

# Features and Tasks
# --------------------------------------------------------------------------------------

[tool.pixi.feature.test.tasks]
tests = "pytest tests"
tests-with-cov = "pytest tests --cov-report=xml --cov=./"

# Python versions for testing
# --------------------------------------------------------------------------------------

[tool.pixi.feature.py311.dependencies]
python = "~=3.11.0"

[tool.pixi.feature.py312.dependencies]
python = "~=3.12.0"

[tool.pixi.feature.py313.dependencies]
python = "~=3.13.0"

[tool.pixi.feature.py314.dependencies]
python = "~=3.14.0"

# Environments
# --------------------------------------------------------------------------------------

[tool.pixi.environments]
py311 = ["test", "py311"]
py312 = ["test", "py312"]
py313 = ["test", "py313"]
py314 = ["test", "py314"]

# ======================================================================================
# Ruff configuration
# ======================================================================================

[tool.ruff]
target-version = "py311"
fix = true
unsafe-fixes = false

[tool.ruff.lint]
select = ["ALL"]
extend-ignore = [
    "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed in `return_annotation`
    "COM812", # ignored to avoid conflict with formatter
    "EM101",  # exception must not use a string literal
    "EM102",  # exception must not use an f-string literal
    "FBT001", # Boolean-typed positional argument in function definition
    "FBT002", # Boolean default positional argument in function definition
    "ISC001", # ignored to avoid conflict with formatter
    "TRY003", # "long" messages outside exception class.
]

[tool.ruff.lint.per-file-ignores]
"docs/source/conf.py" = ["INP001", "ERA001", "RUF100"]
"docs/*" = [
    "D100",  # missing docstring in public module
    "D103",  # missing docstring in public function
    "D104",  # missing docstring in public package
]
"src/dags/tree/__init__.py" = ["RUF022"]
"tests/*" = [
    "ANN001",  # missing type annotation
    "ANN002",  # missing type annotation for `*args`
    "ANN003",  # missing type annotation for `**kwargs`
    "ANN201",
    "ANN202",
    "D100",  # missing docstring in public module
    "D103",  # missing docstring in public function
    "D104",  # missing docstring in public package
    "D401",
    "FBT001",
    "INP001",
    "PLC2401",
    "PLR2004",  # magic value used in comparison
    "S101",  # use of `assert` detected
]
"tests/test_dag.py" = ["ARG001"]


[tool.ruff.lint.pydocstyle]
convention = "numpy"


# ======================================================================================
# Pytest configuration
# ======================================================================================

[tool.pytest.ini_options]
markers = [
    "wip: Tests that are work-in-progress.",
    "slow: Tests that take a long time to run and are skipped in continuous integration.",
]
norecursedirs = ["docs"]
addopts = ["--pdbcls=pdbp:Pdb"]


# ======================================================================================
# yamlfix configuration
# ======================================================================================

[tool.yamlfix]
line_length = 88
sequence_style = "block_style"
none_representation = "null"


# ======================================================================================
# ty configuration -- set all rules to error.
# ======================================================================================

[tool.ty.rules]
ambiguous-protocol-member = "error"
deprecated = "error"
division-by-zero = "error"
ignore-comment-unknown-rule = "error"
invalid-argument-type = "error"
invalid-ignore-comment = "error"
possibly-missing-attribute = "error"
possibly-missing-implicit-call = "error"
possibly-missing-import = "error"
possibly-unresolved-reference = "error"
redundant-cast = "error"
undefined-reveal = "error"
unresolved-global = "error"
unsupported-base = "error"
unused-ignore-comment = "error"
useless-overload-body = "error"

[tool.ty.src]
exclude = ["docs/source/example/example.ipynb"]