Skip to content

test: extend public api contract #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlippmann merged 2 commits into from
Jun 25, 2026
Merged

test: extend public api contract #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84abb23
test: tighten public api contract
rlippmann Jun 25, 2026
42e8d0c
test: extend public api contract
rlippmann Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions tests/fixtures/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,24 @@ This directory contains multiple fixture suites with different contracts.

## API contract fixture

[`conformance/api/public-api-v1.json`](conformance/api/public-api-v1.json) defines a small public API presence contract for the Python 0.7.x surface that ports must expose.
[`conformance/api/public-api-v1.json`](conformance/api/public-api-v1.json) defines the current portable core public API contract for Python and ports.

Ports may sync this artifact with conformance fixtures.

Ports should check equivalent public exports and methods using language-appropriate names where casing differs.
The contract encodes:

* exact exported `context_compiler.__all__` names
* export kinds (`callable`, `constant`, `type_alias`, `type`, `class`)
* exact public `Engine` members
* stable callable signatures where parameter shape is part of the contract
* forbidden package-root names that must not become public exports
* lightweight deterministic return-shape probes for selected stable helpers

Ports should check equivalent public exports, members, and signatures using language-appropriate names where casing differs.

Behavioral semantics remain covered by conformance and structured fixtures.

The API presence contract includes the public controller helper accessors:
The API contract includes the public controller helper accessors:

* `get_step_decision`
* `get_step_state`
Expand Down
Loading