refactor(py): rename OutputConfig.schema_ to json_schema, pin wire alias - #6024
Open
huangjeff5 wants to merge 1 commit into
Open
refactor(py): rename OutputConfig.schema_ to json_schema, pin wire alias#6024huangjeff5 wants to merge 1 commit into
huangjeff5 wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request refactors the OutputConfig model to use json_schema instead of schema_ to avoid shadowing the parent BaseModel.schema attribute. It leverages Pydantic's AliasChoices for validation and serialization aliases to maintain compatibility with the wire format, allowing the removal of warning filters. The schema generation script schema_to_typing.py has been updated accordingly. There are no review comments, so no additional feedback is provided.
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.
Product Context & Motivation
In the Genkit Python SDK, structured output configuration had inconsistent field naming:
GenerateActionOutputConfigusedjson_schema, whereasOutputConfigusedschema_to avoid shadowing Pydantic'sBaseModel.schema. This inconsistency required linter warning suppressions (filterwarnings) and created friction for developers interacting with output schemas in Python code.This PR renames
OutputConfig.schema_tojson_schemain Python while pinning the serialization alias toschema. Developers get a clean, consistent Python API (config.json_schema), while Genkit's cross-language wire protocol (Dev UI, reflection server, TS/Go SDKs) continues to send and receive"schema"with 100% wire fidelity.Key Changes
OutputConfig.schema_tojson_schema.validation_alias=AliasChoices('json_schema', 'schema')(accepts both input names) andserialization_alias='schema'(serializes wire key as"schema").schema_to_typing.py) to emit the new alias configuration cleanly.warnings.filterwarningshacks.Verification & Safety
json_schemaandschema. Wire payloads remain identical.pytest py/packages/genkit/tests/genkit/(799 passed).