pyproject.toml

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

[project]
name = "arraycontext"
version = "2024.0"
description = "Choose your favorite numpy-workalike"
readme = "README.rst"
license = "MIT"
authors = [
    { name = "Andreas Kloeckner", email = "inform@tiker.net" },
]
requires-python = ">=3.10"
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "Intended Audience :: Other Audience",
    "Intended Audience :: Science/Research",
    "Natural Language :: English",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3 :: Only",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Information Analysis",
    "Topic :: Scientific/Engineering :: Mathematics",
    "Topic :: Software Development :: Libraries",
    "Topic :: Utilities",
]
dependencies = [
    "constantdict",
    "numpy",
    "pytools>=2025.2.2",
    # for TypeIs
    "typing_extensions>=4.10",
]

[project.optional-dependencies]
jax = [
    "jax>=0.4",
]
pyopencl = [
    "islpy>=2024.1",
    "loopy>=2024.1",
    "pyopencl>=2024.1",
]
pytato = [
    "pytato>=2021.1",
]
test = [
    "basedpyright",
    "pytest",
    "ruff",
    # for type checking
    "pymbolic",
]

[tool.hatch.build.targets.sdist]
exclude = [
  "/.git*",
  "/doc/_build",
  "/.editorconfig",
  "/run-*.sh",
  "/.basedpyright",
]

[project.urls]
Documentation = "https://documen.tician.de/arraycontext"
Homepage = "https://github.com/inducer/arraycontext"

[tool.ruff]
preview = true

[tool.ruff.lint]
extend-select = [
    "B",   # flake8-bugbear
    "C",   # flake8-comprehensions
    "E",   # pycodestyle
    "F",   # pyflakes
    "G",   # flake8-logging-format
    "I",   # flake8-isort
    "N",   # pep8-naming
    "NPY", # numpy
    "Q",   # flake8-quotes
    "RUF", # ruff
    "SIM", # flake8-simplify
    "TC",  # flake8-type-checking
    "UP",  # pyupgrade
    "W",   # pycodestyle
]
extend-ignore = [
    "C90",      # McCabe complexity
    "E221",     # multiple spaces before operator
    "E226",     # missing whitespace around arithmetic operator
    "E402",     # module-level import not at top of file
    "RUF067",   # non-empty-init-module
    "TRY300",
    "TRY004",
]

[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"
inline-quotes = "double"
multiline-quotes = "double"

[tool.ruff.lint.isort]
combine-as-imports = true
known-first-party = [
    "jax",
    "loopy",
    "pymbolic",
    "pyopencl",
    "pytato",
    "pytools",
]
known-local-folder = [
    "arraycontext",
    "testlib",
]
lines-after-imports = 2
required-imports = ["from __future__ import annotations"]

[tool.ruff.lint.per-file-ignores]
"doc/conf.py" = ["I002", "S102"]
# To avoid a requirement of array container definitions being someplace importable
# from @dataclass_array_container.
"test/test_utils.py" = ["I002"]
"test/*.py" = ["S102"]

[tool.typos.default]
extend-ignore-re = [
  "(?Rm)^.*(#|//)\\s*spellchecker:\\s*disable-line$"
]

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

# short for 'serialization'
"ser" = "ser"

[tool.basedpyright]
reportImplicitStringConcatenation = "none"
reportUnnecessaryIsInstance = "none"
reportUnusedCallResult = "none"
reportExplicitAny = "none"
reportPrivateUsage = "none"
reportUnusedFunction = "none"

# This reports even cycles that are qualified by 'if TYPE_CHECKING'. Not what
# we care about at this moment.
# https://github.com/microsoft/pyright/issues/746
reportImportCycles = "none"
pythonVersion = "3.10"
pythonPlatform = "All"

reportImplicitOverride = "hint"

exclude = [
    "doc",
    ".conda-root",
    "build",
    ".env",
]

[[tool.basedpyright.executionEnvironments]]
root = "test"
reportUnknownArgumentType = "hint"
reportUnknownMemberType = "hint"
reportUnknownVariableType = "hint"
reportUnknownParameterType = "hint"
reportMissingTypeArgument = "hint"
reportPrivateUsage = "none"
reportMissingTypeStubs = "hint"
reportAny = "hint"

reportIndexIssue = "hint"
reportOperatorIssue = "hint"
reportAttributeAccessIssue = "hint"

# so much numpy-or-not abuse in the tests *facepalm*
reportCallIssue = "hint"
reportArgumentType = "hint"

[[tool.basedpyright.executionEnvironments]]
root = "examples"
reportUnknownArgumentType = "hint"
reportUnknownMemberType = "hint"
reportUnknownVariableType = "hint"
reportUnknownParameterType = "hint"
reportMissingTypeArgument = "hint"
reportPrivateUsage = "none"
reportMissingTypeStubs = "hint"
reportAny = "hint"