pyproject.toml

[project]
name = "bearshape"
version = "0.1.0rc0"
description = "Elegant runtime shape and dtype checking for NumPy, JAX, PyTorch, and CuPy arrays — powered by beartype."
readme = "README.md"
license = "MIT"
license-files = ["LICENSE"]
authors = [{ name = "acecchini", email = "ale.cecchini.valette@gmail.com" }]
requires-python = ">=3.10"
dependencies = [
  "beartype>=0.23.0rc0,<0.24", # Exact candidate tested in tox.toml
  "typing_extensions>=4.6",
]
keywords = [
  "type-checking",
  "shape",
  "dtype",
  "numpy",
  "jax",
  "pytorch",
  "cupy",
  "beartype",
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Developers",
  "Intended Audience :: Science/Research",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Topic :: Scientific/Engineering",
  "Topic :: Software Development :: Libraries :: Python Modules",
  "Typing :: Typed",
]

[project.urls]
Homepage = "https://github.com/acecchini/bearshape"
Repository = "https://github.com/acecchini/bearshape"
Issues = "https://github.com/acecchini/bearshape/issues"

[build-system]
requires = ["uv_build>=0.11.0,<0.12.0"]
build-backend = "uv_build"

[dependency-groups]
# Backends are CPU-only for dev/CI. bearshape is device-agnostic — it checks
# .shape and .dtype only. Users install their own numpy/jax/torch/cupy/optree.
# CuPy requires CUDA and is not included here; install separately for GPU envs.
optional = ["numpy>=2.2.0", "torch>=2.6.0", "jax[cpu]>=0.5.0", "optree>=0.14.0"]
static = [
  "pyright>=1.1.408",
  "mypy>=1.19,<3",
  "ty>=0.0.79",
  "pyrefly>=1.2,<2",
]
docs = ["zensical>=0.0.43"]
test = [
  "pytest>=9.0.2",
  "pytest-cov>=7.1.0",
  "pytest-xdist>=3.8.0",
  "tox>=4.52.0",
  "tox-uv>=1.34.0",
]
notebook = ["ipykernel>=7.2.0", "nbclient>=0.11.0"]
dev = ["ruff>=0.15.9", "prek>=0.3.8"]

[tool.uv]
default-groups = ["dev", "optional", "static", "docs", "test", "notebook"]
required-version = ">=0.11.0,<0.12.0"
python-preference = "only-managed"

[tool.uv.build-backend]
module-name = "bearshape"
source-include = [
  "tests/**", "tools/**", "pytest.toml", "tox.toml", "ty.toml", "ruff.toml",
  "uv.lock", "CONTRIBUTING.md", "CHANGELOG.md",
]

[tool.uv.sources]
torch = [{ index = "pytorch-cpu" }]

[[tool.uv.index]]
name = "pytorch-cpu"
url = "https://download.pytorch.org/whl/cpu"
explicit = true

[tool.codespell]
skip = "uv.lock,*.ipynb,.venv,.tox"
ignore-words-list = "numbe"

[tool.typos.default.extend-words]
ND = "ND"

[tool.pyright]
typeCheckingMode = "strict"
include = ["src", "tests/typing"]
# Beartype's Is[lambda ...] validators produce unknown types in closures
reportUnknownLambdaType = false
reportUnknownMemberType = false
reportUnknownVariableType = false
reportUnknownArgumentType = false
# _TreeFactory is used at runtime via module-level assignment, not direct reference
reportUnusedClass = false
# numpy._NestedSequence, ._SupportsArray, and internal _dim_spec access
reportPrivateUsage = false
reportUnusedImport = "warning"
# Check the oldest supported Python, not the interpreter running the checker.
pythonVersion = "3.10"
pythonPlatform = "Linux"

[tool.pyrefly]
preset = "default"
project-includes = ["src", "tests/typing"]
python-version = "3.10"

[tool.mypy]
python_version = "3.10"
strict = true
ignore_missing_imports = true
warn_unreachable = true

[tool.coverage.run]
branch = true
source = ["bearshape"]

[tool.coverage.report]
show_missing = true
skip_covered = true
exclude_also = [
  "if tp.TYPE_CHECKING:",
  "if typing.TYPE_CHECKING:",
  "if TYPE_CHECKING:",
]