Skip to content

sdk-types: add opt-in deferred model building (defer_build) - #41

Merged
truham merged 5 commits into
mainfrom
hamilton/sdk-types-defer-build
Nov 20, 2026
Merged

truham merged 5 commits into
mainfrom
hamilton/sdk-types-defer-build

Conversation

@truham

@truham truham commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Adds opt-in deferred model building. Off by default, so existing apps are unchanged.

Set TURNKEY_SDK_DEFER_BUILD=1 before importing the SDK to build each Pydantic model on first use instead of all ~1,300 at import. Requires Pydantic 2.5+ (2.1–2.2 crash when a model is serialized before it's validated). On older versions, or with an unrecognized value, it warns and keeps the default.

Testing: new tests in CI (latest Pydantic and 2.5.3) cover the default matching main, on/off values, both warnings, every model building when deferred, and identical dumps, validation errors and schemas with deferral on and off. Also run locally on 2.4.2 and 2.0.3.

truham and others added 5 commits November 12, 2026 18:40
Set Pydantic's defer_build on TurnkeyBaseModel so each generated model
builds its validator and serializer on first use instead of at import.
Only enabled on Pydantic 2.5+; older versions keep the current behavior.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Checks that every model builds, that serializing before validating works,
and that dumps, validation errors and schemas match with defer_build on
and off for a sample of models. CI runs only the sdk-types tests, which
need no credentials.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add a test that models are unbuilt after import, share one model-listing
helper, and document the sample size and how the test turns deferral off.
Tighten the changeset: lead with peak memory and note it depends on build
order, drop machine-specific timings, and remove the build-failure note
now covered by CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.5 is the oldest version with defer_build enabled, so test it alongside
the latest release.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Deferred model building is now off by default, so existing apps keep
eager building and the same model_config as before. Set
TURNKEY_SDK_DEFER_BUILD=1 (or true) before the first Turnkey import to
turn it on. Unrecognized values, and Pydantic below 2.5, warn and keep
the default.

Tests switch the mode with the env var instead of spoofing the Pydantic
version, and cover the default, on/off values, and both warnings. Adds
a short README section and rewords the changeset as opt-in.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@truham truham changed the title sdk-types: build models on first use (defer_build) sdk-types: add opt-in deferred model building (defer_build) Nov 18, 2026
@truham
truham merged commit b8c848a into main Nov 20, 2026
5 checks passed
@truham
truham deleted the hamilton/sdk-types-defer-build branch November 20, 2026 17:47
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.

2 participants