pyproject.toml

[project]
authors = [
  { name = "Nathaniel Starkman", email = "nstarman@users.noreply.github.com" },
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Developers",
  "Intended Audience :: Financial and Insurance Industry",
  "Intended Audience :: Information Technology",
  "Intended Audience :: Science/Research",
  "License :: OSI Approved :: Apache Software License",
  "Natural Language :: English",
  "Programming Language :: Python :: 3",
  "Topic :: Scientific/Engineering :: Artificial Intelligence",
  "Topic :: Scientific/Engineering :: Information Analysis",
  "Topic :: Scientific/Engineering :: Mathematics",
]
dependencies = [
  "jax>=0.7.2",
  "jaxtyping>=0.3.3",
  "equinox>=0.13.3",
  'plum-dispatch>=2.5.7; python_version < "3.14"',
  'plum-dispatch>=2.9.0; python_version >= "3.14"',
  "packaging>=20.0",
]
description = "Multiple dispatch in JAX via custom interpreters."
dynamic = ["version"]
keywords = ["jax", "multiple-dispatch", "equinox"]
license = { file = "LICENSE" }
name = "quax"
readme = "README.md"
requires-python = ">=3.11"
urls = { repository = "https://github.com/nstarman/quax" }

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

[dependency-groups]
dev = [
  { include-group = "docs" },
  { include-group = "lint" },
  { include-group = "tests" },
]
docs = [
  "hippogriffe==0.2.2",
  "mkdocstrings[python]==1.0.6",
  "nbconvert>=7",
  "pymdown-extensions==11.0.2",
  "zensical",
]
ide = ["ipykernel>=7.2.0"]
lint = ["prek>=0.3.11", "ruff>=0.15.9"]
# Integration tests against downstream JAX libraries (tests/integration). Kept
# out of `dev`/`tests` so the default suite neither installs nor depends on
# them; the modules skip themselves when the dependency is missing. Run locally
# with `uv run --group test-integration pytest tests/integration`; CI runs them
# in a dedicated job.
test-integration = [{ include-group = "tests" }, "diffrax>=0.7.2"]
tests = [
  # beartype>=0.23.0rc0 breaks plum's method-redefinition detection:
  # https://github.com/beartype/plum/issues/295, fix in https://github.com/beartype/plum/pull/296 (unmerged).
  "beartype>=0.20.2,<0.23.0",
  "pytest>=8.3.5",
  "pytest-env>=1.1.5",
  "sybil>=9",
  "jax[cpu]",
]
# Performance benchmarks. Kept out of `dev`/`tests` so the default suite never
# collects them (see tests/benchmark/conftest.py). Run locally with
# `uv run --group bench pytest tests/benchmark --benchmark-only`; CI runs them
# under CodSpeed with `pytest tests/benchmark --codspeed`.
bench = [
  { include-group = "tests" },
  "pytest-benchmark>=5.1.0",
  "pytest-codspeed>=3.1.0",
]

[tool.hatch]
build.hooks.vcs.version-file = "src/quax/_version.py"
build.hooks.vcs.version-file-template = """\
version: str = {version!r}
version_tuple: tuple[int, int, int] | tuple[int, int, int, str, str]
version_tuple = {version_tuple!r}
"""
version.source = "vcs"

[tool.hatch.version.raw-options]
local_scheme = "no-local-version"

[tool.hatch.version.raw-options.scm.git]
describe_command = [
  "git",
  "describe",
  "--dirty",
  "--tags",
  "--long",
  "--match",
  "v*",
]

[tool.hatch.build.targets.wheel]
packages = ["src/quax"]

[tool.pytest.ini_options]
addopts = [
  "--jaxtyping-packages=quax,beartype.beartype(conf=beartype.BeartypeConf(strategy=beartype.BeartypeStrategy.On))",
  "-ra",
]
log_level = "INFO"
minversion = "8.3"
pythonpath = ["src"]
testpaths = ["README.md", "skills", "docs", "src/", "tests"]

[tool.pytest_env]
JAX_CHECK_TRACER_LEAKS = 1

[tool.ruff.lint]
fixable = ["I001", "F401", "UP"]
ignore  = ["E402", "E721", "E731", "E741", "F722"]
select  = ["E", "F", "I001", "UP"]

[tool.ruff.lint.flake8-import-conventions.extend-aliases]
"equinox"    = "eqx"
"jax.extend" = "jex"

[tool.ruff.lint.isort]
combine-as-imports     = true
extra-standard-library = ["typing_extensions"]
lines-after-imports    = 2
order-by-type          = false

[tool.ruff.format]
docstring-code-format = true

[tool.pyright]
include                          = ["src/quax", "tests"]
reportIncompatibleMethodOverride = true