pyproject.toml

[build-system]
requires = ["maturin>=1.0,<2.0", "setuptools_scm"]
build-backend = "_build_backend"
backend-path = ["."]

[project]
dependencies = [
  "pyyaml == 6.0.*",
  "pydantic >= 2.10, < 3",
]
name = "openjd-model"
authors = [
  { name = "Amazon Web Services" }
]
dynamic = ["version"]
readme = "README.md"
license = "Apache-2.0"
requires-python = ">=3.9"
description = "Provides a Python implementation of the data model for Open Job Description's template schemas."
# https://pypi.org/classifiers/
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Operating System :: POSIX :: Linux",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: MacOS",
  "License :: OSI Approved :: Apache Software License",
  "Intended Audience :: Developers",
  "Topic :: Software Development :: Libraries"
]
[project.urls]
Homepage = "https://github.com/OpenJobDescription/openjd-model-for-python"
Source = "https://github.com/OpenJobDescription/openjd-model-for-python"

[tool.maturin]
python-source = "src"
module-name = "openjd._openjd_rs"
manifest-path = "rust-bindings/Cargo.toml"
features = ["extension-module"]
# Files outside maturin's default sdist/wheel walk that we need
# bundled anyway:
#
# * `src/openjd/model/_version.py` — generated at build time by
#   `_build_backend.py` (or `scripts/generate_version.py`) and is
#   gitignored. Maturin honors `.gitignore` when walking
#   `python-source`, so without this entry the file is excluded
#   from the wheel and `from .._version import version` fails at
#   import time on the deploy target. Needs to be in the wheel.
#
# * `_build_backend.py` and `scripts/generate_version.py` —
#   required when pip builds a wheel from the extracted sdist
#   (PEP 517 build-from-sdist, which is what `hatch build` does
#   in CI). `pyproject.toml` declares
#   `build-backend = "_build_backend"` with `backend-path = ["."]`,
#   and `_build_backend.py` imports `generate_version` from the
#   `scripts/` directory. Without these entries the file isn't
#   shipped in the sdist and the second-stage wheel build fails
#   with `BackendUnavailable: Cannot find module '_build_backend'`.
#   These only need to be in the sdist; they're build-time
#   tooling, not runtime code.
include = [
    { path = ".gitignore", format = "sdist" },
    { path = "LICENSE", format = "sdist" },
    { path = "NOTICE", format = "sdist" },
    "src/openjd/model/_version.py",
    { path = "_build_backend.py", format = "sdist" },
    { path = "scripts/generate_version.py", format = "sdist" },
]

[tool.hatch.version]
source = "vcs"

[tool.hatch.version.raw-options]
version_scheme = "post-release"

[tool.mypy]
check_untyped_defs = false
show_error_codes = false
pretty = true
ignore_missing_imports = true
disallow_incomplete_defs = false
disallow_untyped_calls = false
show_error_context = true
strict_equality = false
python_version = "3.10"
warn_redundant_casts = true
warn_unused_configs = true
warn_unused_ignores = false
# Tell mypy that there's a namespace package at src/openjd
namespace_packages = true
explicit_package_bases = true
mypy_path = "src"
# Skip the pure-Python pydantic v0 reference test suite. It carries
# pre-existing typing debt (Literal[str] vs Literal[Enum]
# discrimination, dict-vs-model fixture shapes, etc.) that pydantic
# accepts at runtime but mypy flags. The v0 reference is slated for
# retirement once the bindings stabilise.
exclude = [
    "test/openjd/model_v0/",
]

# `_openjd_rs.pyi` is auto-generated by PyO3's `gen-stub` from the
# Rust binding macros (see `scripts/generate_stubs.sh`). It's an
# interface declaration regenerated on every binding rebuild, not
# source under review. Stubgen produces constructs mypy flags as
# soft violations (e.g. narrow-typed
# `__eq__(self, other: SameType)` overrides that violate Liskov,
# enum-member annotations on class-level revision constants), and
# none of those are actionable from the Python wrapper side. Treat
# the module as opaque and silence those nits — the wrappers
# themselves (`src/openjd/expr/__init__.py`,
# `src/openjd/model/_v1/__init__.py`, etc.) are still checked
# normally.
[[tool.mypy.overrides]]
module = "openjd._openjd_rs"
ignore_errors = true


[tool.ruff]
line-length = 100

[tool.ruff.lint]
ignore = [
  "E501",
  # Double Check if this should be fixed
  "E731",
]

[tool.ruff.lint.isort]
known-first-party = [
  "openjd",
]

[tool.black]
line-length = 100

[tool.pytest.ini_options]
xfail_strict = false
markers = [
    "fuzz: Hypothesis-based fuzz tests (test/openjd/expr/test_fuzz.py)",
]
# Use importlib import mode so test files with identical names in different
# directories (e.g. test/openjd/model_v0/test_parse.py and
# test/openjd/model_v1/test_parse.py) coexist in the same pytest run. The
# default rootdir-based import mode synthesizes a top-level module name from
# the test filename and breaks on collisions; importlib mode imports each file
# under its full filesystem path.
addopts = [
    "-rfEx",
    "--durations=5",
    "--cov=src/openjd",
    "--color=yes",
    "--cov-report=html:build/coverage",
    "--cov-report=xml:build/coverage/coverage.xml",
    "--cov-report=term-missing",
    "--numprocesses=auto",
    "--timeout=30",
    "--import-mode=importlib",
]

[tool.coverage.run]
branch = true
parallel = true


[tool.coverage.paths]
source = [
  "src/"
]

[tool.coverage.report]
show_missing = true

[tool.semantic_release]
# Can be removed or set to true once we are v1
major_on_zero = false
tag_format = "{version}"
allow_zero_version = true

[tool.semantic_release.commit_parser_options]
allowed_tags = [
    "build",
    "chore",
    "ci",
    "docs",
    "feat",
    "fix",
    "perf",
    "style",
    "refactor",
    "test",
]
minor_tags = []
patch_tags = [
  "chore",
  "feat",
  "fix",
  "refactor",
  "perf",
]

[tool.semantic_release.publish]
upload_to_vcs_release = false

[tool.semantic_release.changelog]
template_dir = ".semantic_release"

[tool.semantic_release.changelog.environment]
trim_blocks = true
lstrip_blocks = true

[tool.semantic_release.branches.release]
match = "(mainline|release|patch_.*)"