pyproject.toml

[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "heir_py"
dynamic = ["version"]
authors = [
  { name = "Jeremy Kun", email = "jkun@google.com" },
  { name = "Asra Ali", email = "asraa@google.com" },
  { name = "Alexander Viand", email = "alexander.viand@intel.com" },
]
description = "The HEIR compiler"
readme = "README.md"
requires-python = ">=3.11"
classifiers = [
  "Topic :: Security :: Cryptography",
  "Intended Audience :: Developers",
  "Topic :: Software Development :: Compilers",
]
license = "MIT AND Apache-2.0"
dependencies = [
  "numba~=0.62.0",
  # Numpy versioning is a bit tricky:
  # Numba 0.62 supports >=1.22,<=2.3,
  # but SciPy 1.14 wants >=1.23.5,<2.3.0" and will warn at runtime if not satisfied,
  # and finally we actually need <2 because otherwise we get "OverflowError: Python integer -1 out of bounds for uint32"
  # in some of our tests as Numpy 2 introduces stricter type checking
  "numpy>=1.23.5,<2",
  "pybind11>=2.13.6",
  "pybind11_global>=2.13.6",
  "colorama>=0.4.6",
  "absl-py>=2.1.0",
]

[project.optional-dependencies]
dev = [
  # for tests/poly/runner/generate_test_cases.py
  "tomli>=2.0.1",
  "sympy>=1.12",
  "mpmath>=1.3.0",
  # Requirements for running jaxite backend examples
  "jaxite==0.0.2",
  # for scripts and repo utils
  "fire>=0.7.0",
  "jinja2>=3.1.5",
  "pre-commit>=v3.3.3",
  "pytest>=8.1.1",
  "requests>=2.0.0",
  # Python Formatting
  "pyink>=24.10.1",
  # For ML integration tests
  "torch>=2.8.0",
  "setuptools>=80.9.0",
  "cibuildwheel>=3.0.0",
]

[project.urls]
Homepage = "https://heir.dev"
Issues = "https://github.com/google/heir/issues"

[tool.setuptools]
package-dir = { "" = "frontend" }
zip-safe = false

[tool.setuptools.packages.find]
where = ["frontend"]

[tool.cibuildwheel]
build = "cp311-* cp312-* cp313-*"
build-frontend = "build[uv]"
skip = "*-musllinux_* pp-*"
# The test must be run in an isolated directory so that python uses the wheel
# when running `import heir` instead of the local source files. cibuildwheel
# creates an isolated directory for this purpose, and cd's to it before running
# this command.
test-command = "cp {package}/frontend/example.py . && python example.py"

[tool.cibuildwheel.linux]
archs = "auto64"
manylinux-x86_64-image = "manylinux_2_28"
manylinux-aarch64-image = "manylinux_2_28"
before-all = "bash .github/install_cibuildwheel_deps.sh"
# Use the rootless Bazel installation inside the container.
environment = { PATH = "$PATH:$HOME/bin" }
# Force the repaired wheel to use the manylinux_2_28 platform tag.
# By default, auditwheel may analyze the wheel's actual symbol requirements
# and choose or add a lower compatible manylinux_x_y tag such as 2_27
# which PyPi might reject (they only accept a few specific tags).
repair-wheel-command = "auditwheel repair --plat manylinux_2_28_$(uname -m) --only-plat -w {dest_dir} {wheel}"

[tool.cibuildwheel.windows]
archs = "auto64"

[tool.cibuildwheel.macos]
# Inherits archs from default (auto64)
# Unused by Bazel, but needed explicitly by delocate on MacOS.
environment = { MACOSX_DEPLOYMENT_TARGET = "10.15" }

[tool.pytest.ini_options]
norecursedirs = [
  ".git",
  "__pycache__",
  "bazel",
  "bazel-bin",
  "bazel-heir",
  "bazel-out",
  "bazel-testlogs",
  "docs",
  "external",
  "tests",
  "tools",
  "venv",
]

[tool.pyink]
line-length = 80
unstable = true
pyink-indentation = 2
pyink-use-majority-quotes = true

[tool.codespell]
# words to allow even though codespell thinks they're misspelled
ignore-words-list = "crate,fpt,LogArithmetic,olt,allOne"
# enable if you want the pre-commit hook to automatically write changes
write-changes = false
# files to exclude
skip = "*.lock"

[tool.setuptools_scm]
# Can be empty, setuptools-scm handles the rest by default.