Repository navigation
sdk-types: add opt-in deferred model building (defer_build) - #41
Merged
Merged
Conversation
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>
hadrelandon
approved these changes
Nov 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds opt-in deferred model building. Off by default, so existing apps are unchanged.
Set
TURNKEY_SDK_DEFER_BUILD=1before 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.