pixi.toml

[workspace]
name = "array-api-extra"
description = "Extra array functions built on top of the array API standard."
channels = ["https://prefix.dev/conda-forge"]
platforms = [
  "linux-64",
  "linux-aarch64",
  "osx-64",
  "osx-arm64",
  "win-64",
  { platform = "linux-64", cuda = "12.9" },
  { platform = "win-64", cuda = "12.9" },
]
preview = ["pixi-build"]
requires-pixi = ">=0.82.1"  # security update
exclude-newer = "7d"

[exclude-newer]
certifi = "0d"
ca-certificates = "0d"
brotli-python = "2d"
jax = "1d"
jaxlib = "1d"

### array-api-extra package definition ###

[package]
build = {
  backend.name = "pixi-build-python",
  config.ignore-pypi-mapping = false,
}

### workspace environments ###

[environments]
default = {
  features = ["py314"],
  solve-group = "py314",
}
lint = {
  features = ["py312", "lint"],
  solve-group = "py312",
}
docs = {
  features = ["py314", "docs"],
  solve-group = "py314",
}

tests = {
  features = ["py314", "tests"],
  solve-group = "py314",
}
tests-py314 = {  # alias of tests
  features = ["py314", "tests"],
  solve-group = "py314",
}
tests-py312 = {
  features = ["py312", "tests"],
  solve-group = "py312",
}
tests-run-deps = {
  features = ["py314", "tests-run-deps"],
  solve-group = "py314",
}

# Some backends may pin numpy; use separate solve-group
dev = {
  features = ["py314", "lint", "tests", "docs", "dev", "backends"],
  solve-group = "backends",
}
tests-backends = {
  features = ["py314", "tests", "backends"],
  solve-group = "backends",
}
tests-backends-py312.features = ["py312", "tests", "backends"]

# CUDA not available on free github actions and on some developers' PCs
dev-cuda = {
  features = ["py314", "lint", "tests", "docs", "dev", "backends", "cuda-backends"],
  solve-group = "cuda",
}
tests-cuda = {
  features = ["py314", "tests", "backends", "cuda-backends"],
  solve-group = "cuda",
}
tests-cuda-py312.features = ["py312", "tests", "backends", "cuda-backends"]

# Ungrouped environments
tests-numpy1 = ["py312", "tests", "numpy1"]
tests-nogil = ["py314t", "nogil", "tests"]

### default feature definition ###

# this pulls in array-api-extra's host dependencies
[dev]
array-api-extra.path = "."

[dependencies]
array-api-extra.path = "."

### non-default feature definitions ###

[feature.lint.dependencies]
typing-extensions = ">=4.16.0"
pylint = ">=4.1.3"
mypy = ">=2.4.0"
basedpyright = ">=1.40.2"
numpydoc = ">=1.11.0"
# import dependencies for mypy:
array-api-strict = ">=2.6.1"
numpy = ">=2.1.3"
hypothesis = ">=6.168.1"
dask-core = ">=2026.8.0"  # No distributed, tornado, etc.
dprint = ">=0.50.0"
lefthook = ">=2.2.1"
ruff = ">=0.17.1"
typos = ">=1.51.1"
actionlint-with-all = ">=1.7.12"
blacken-docs = ">=1.20.0"
pytest = ">=9.1.1"
validate-pyproject = ">=0.25"
pyrefly = ">=1.4.0"
zizmor = ">=1.31.1"
tombi = ">=1.8.5"
# NOTE: don't add cupy, jax, pytorch, or sparse here,
# as they slow down mypy and are not portable across target OSs

[feature.lint.tasks]
lefthook = {
  description = "Run lefthook",
  cmd = "lefthook",
  default-environment = "lint",
}
hooks = {
  description = "Install pre-commit hooks",
  cmd = "lefthook install",
  default-environment = "lint",
}
pre-commit = {
  description = "Run pre-commit checks on staged files",
  cmd = "lefthook run pre-commit",
  default-environment = "lint",
}

pylint = {
  description = "Lint with pylint",
  cwd = "src",
  cmd = "pylint array_api_extra",
  default-environment = "lint",
}
mypy = {
  description = "Type check with mypy",
  cmd = "mypy",
  default-environment = "lint",
}
pyrefly = {
  description = "Type check with pyrefly",
  cmd = "pyrefly check",
  default-environment = "lint",
}
pyright = {
  description = "Type check with basedpyright",
  cmd = "basedpyright",
  default-environment = "lint",
}
ruff-check = {
  description = "Lint with ruff",
  cmd = "ruff check --fix",
  default-environment = "lint",
}
ruff-format = {
  description = "Format with ruff",
  cmd = "ruff format",
  default-environment = "lint",
}
dprint = {
  description = "Format with dprint",
  cmd = "dprint fmt",
  default-environment = "lint",
}
typos = {
  description = "Fix typos",
  cmd = "typos --write-changes --force-exclude",
  default-environment = "lint",
}
actionlint = {
  description = "Lint actions with actionlint",
  cmd = "actionlint",
  default-environment = "lint",
}
zizmor = {
  description = "GHA static analysis with zizmor",
  cmd = "zizmor .github -p",
  default-environment = "lint",
}
blacken-docs = {
  description = "Format Python markdown blocks with Black",
  cmd = "blacken-docs",
  default-environment = "lint",
}
validate-pyproject = {
  description = "Validate pyproject.toml",
  cmd = "validate-pyproject pyproject.toml",
  default-environment = "lint",
}
numpydoc = {
  description = "Validate docstrings with numpydoc",
  cmd = "numpydoc lint",
  default-environment = "lint",
}
tombi = {
  description = "Format TOML with tombi",
  cmd = "tombi format",
  default-environment = "lint",
}

lint = {
  description = "Run all linters",
  cmd = "lefthook run pre-commit --all-files --force",
  default-environment = "lint",
}

[feature.tests.dependencies]
pytest = ">=9.1.1"
pytest-cov = ">=7.1.0"
hypothesis = ">=6.168.1"
array-api-strict = ">=2.6.1"
numpy = ">=1.22.0"
scipy = ">=1.15.2"
scipy-doctest = ">=2.2.0,<3"

[feature.tests.tasks]
tests = {
  description = "Run tests",
  cmd = "pytest -v tests/main",
  default-environment = "tests",
}
doctests = {
  description = "Run public API doctests",
  cmd = "pytest -c ../pyproject.toml --pyargs array_api_extra --doctest-modules --doctest-collect=api",
  cwd = "docs",  # to use `docs/conftest.py`
  default-environment = "tests",
}
tests-cov = {
  description = "Run tests with coverage",
  cmd = "pytest -v -ra --cov --cov-report=xml --cov-report=term --durations=20 tests/main",
  default-environment = "tests",
}

coverage = {
  description = "Generate test coverage html report",
  depends-on = ["tests-cov"],
  cmd = "coverage html",
  default-environment = "tests",
}
open-coverage = {
  description = "Open test coverage report",
  depends-on = ["coverage"],
  cmd = "open htmlcov/index.html",
  default-environment = "tests",
}

clean-vendor-compat = {
  description = "Delete the existing vendored version of array-api-compat",
  cmd = "rm -rf tests/vendoring/array_api_compat",
  default-environment = "tests",
}
clean-vendor-extra = {
  description = "Delete the existing vendored version of array-api-extra",
  cmd = "rm -rf tests/vendoring/array_api_extra",
  default-environment = "tests",
}
copy-vendor-compat = {
  description = "Vendor a clean copy of array-api-compat",
  depends-on = ["clean-vendor-compat"],
  cmd = "cp -r $(python -c 'import array_api_compat, pathlib; print(pathlib.Path(array_api_compat.__file__).parent)') tests/vendoring/ && rm -rf tests/vendoring/array_api_compat/vendor_tests && rm -rf tests/vendoring/array_api_compat/tests",
  default-environment = "tests",
}
copy-vendor-extra = {
  description = "Vendor a clean copy of array-api-extra",
  depends-on = ["clean-vendor-extra"],
  cmd = "cp -r src/array_api_extra tests/vendoring/",
  default-environment = "tests",
}
tests-vendoring = {
  description = "Check that array-api-extra and array-api-compat can be vendored together",
  depends-on = ["copy-vendor-compat", "copy-vendor-extra"],
  cmd = "pytest -v tests/vendoring",
  default-environment = "tests",
}

tests-ci = {
  description = "Run tests with coverage and vendor tests",
  depends-on = ["tests-cov", "tests-vendoring"],
}

# tests with only run dependencies
[feature.tests-run-deps.dependencies]
pytest = ">=9.1.1"
pytest-cov = ">=7.1.0"

[feature.tests-run-deps.tasks]
tests-run-deps = {
  description = "Run run-dependency tests",
  cmd = "pytest --confcutdir=tests/run_deps -v tests/run_deps",
  default-environment = "tests-run-deps",
}
tests-run-deps-cov = {
  description = "Run run-dependency tests with coverage",
  cmd = "pytest --confcutdir=tests/run_deps -v -ra --cov --cov-report=xml --cov-report=term --durations=20 tests/run_deps",
  default-environment = "tests-run-deps",
}

[feature.docs.dependencies]
sphinx = ">=7.4.7"
furo = ">=2025.12.19"
myst-parser = ">=5.1.0"
sphinx-copybutton = ">=0.5.2"
sphinx-autodoc-typehints = ">=3.11.1"
# Needed to import parsed modules with autodoc
dask-core = ">=2026.8.0"  # No distributed, tornado, etc.
pytest = ">=9.1.1"
typing-extensions = ">=4.16.0"
numpy = ">=2.1.3"

[feature.docs.tasks]
docs = {
  description = "Build docs",
  cwd = "docs/sphinx/",
  cmd = "sphinx-build -E -W . build/",
  default-environment = "docs",
}
open-docs = {
  description = "Open the generated docs",
  depends-on = ["docs"],
  cwd = "docs/sphinx/",
  cmd = "open build/index.html",
  default-environment = "docs",
}

[feature.docs.target.win.tasks]
open-docs = {
  description = "Open the generated docs",
  depends-on = ["docs"],
  cwd = "docs/sphinx/",
  cmd = "cmd /c start build/index.html",
  default-environment = "docs",
}

[feature.dev.dependencies]
ipython = ">=9.17.1"

[feature.dev.tasks]
ipython = {
  description = "Launch ipython",
  cmd = "ipython",
  default-environment = "dev",
}

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

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

[feature.py314t.dependencies]
python-freethreading = "~=3.14.0"

[feature.numpy1.dependencies]
# Oldest NumPy version supported by scikit-learn.
# Note that this is older than what SPEC0 recommends.
numpy = "=1.26.0"
scipy = "1.16.*"  # compatible ith the pinned numpy version

# Backends that can run on CPU-only hosts
# Note: JAX and PyTorch will install CPU variants.
[feature.backends.dependencies]
pytorch = ">=2.14.1"
dask-core = ">=2026.8.0"  # No distributed, tornado, etc.
sparse = ">=0.19.2"
mparray = ">=0.2.2"

[feature.backends.target.unix.dependencies]
jax = ">=0.11.2"

# Backends that require a GPU host and a CUDA driver.
[feature.cuda-backends]
platforms = ["linux-64-cuda-12-9", "win-64-cuda-12-9"]

[feature.cuda-backends.dependencies]
cuda-version = "==12.9"
cupy = ">=14.2.0"
pytorch = ">=2.14.1"

[feature.cuda-backends.target.linux.dependencies]
jaxlib = ">=0.11.2"

[feature.nogil.dependencies]
pytest-run-parallel = ">=0.10.0"
numpy = ">=2.3.5"
dask-core = ">=2026.8.0"  # No distributed, tornado, etc.
# sparse = ">=0.19.1"  # flaky, see data-apis/array-api-extra#900
# pytorch = "*"  # Not available on Python 3.14t yet
# jax = "*"  # waiting for conda-forge/jaxlib-feedstock#351

[tool.pixi-audit]
# TODO: remove these ignores — they were added to let admit autofixes
ignore = [{ package = "python" }, { package = "pytorch" }]