Skip to content

test: add api contract tests#9

Merged
tylerriccio33 merged 3 commits into
mainfrom
add-api-contract-tests
Jun 10, 2026
Merged

test: add api contract tests#9
tylerriccio33 merged 3 commits into
mainfrom
add-api-contract-tests

Conversation

@tylerriccio33

Copy link
Copy Markdown
Owner

Add api contract, add doctests, freeze api shape

Freeze the public contract so it can't change silently within a major
version:

- tests/contract/test_surface.py pins __all__ and the exact signature of
  every exported function.
- tests/contract/test_behavior.py freezes documented round-trips, dtypes,
  errors, the length-prefixed header shape, and the token wire format via
  a frozen golden token (cross-version decode stability).
- CONTRACT.md documents the SemVer promise and the append-only rule for
  tests/contract/.
Add --doctest-modules so the >>> examples in pl_row_encode's public
docstrings execute under pytest. This makes the documented usage a third
contract layer (alongside tests/contract/) and guarantees the examples
stay runnable. All 6 module doctests pass with no repr brittleness.
@tylerriccio33 tylerriccio33 changed the title Add api contract tests test: add api contract tests Jun 9, 2026
@tylerriccio33 tylerriccio33 merged commit 1f0ed35 into main Jun 10, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant