feat: improve structured output tool circular reference handling #817
Conversation
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
…optional field detection - Move circular reference detection earlier in schema flattening process - Simplify optional field detection using field.is_required() instead of Union type inspection - Add comprehensive test coverage for circular reference scenarios - Fix handling of fields with default values that make them optional - Add uv.lock file for dependency management
|
Note: the |
Unshure
approved these changes
Sep 8, 2025
zastrowm
requested changes
Sep 8, 2025
zastrowm
approved these changes
Sep 8, 2025
vamgan
pushed a commit
to vamgan/sdk-python
that referenced
this pull request
Sep 8, 2025
…ands-agents#817) * feat: improve structured output tool circular reference handling and optional field detection - Move circular reference detection earlier in schema flattening process - Simplify optional field detection using field.is_required() instead of Union type inspection - Add comprehensive test coverage for circular reference scenarios - Fix handling of fields with default values that make them optional
vamgan
pushed a commit
to vamgan/sdk-python
that referenced
this pull request
Sep 9, 2025
…ands-agents#817) * feat: improve structured output tool circular reference handling and optional field detection - Move circular reference detection earlier in schema flattening process - Simplify optional field detection using field.is_required() instead of Union type inspection - Add comprehensive test coverage for circular reference scenarios - Fix handling of fields with default values that make them optional
7 tasks
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.
Description
This pull request improves the handling of circular references and optional fields in Pydantic model schema conversion. The main changes add error detection for circular references, update the logic for determining optional fields, and enhance test coverage for these scenarios.
Schema Conversion and Circular Reference Handling:
_flatten_schemafunctionOptional Field Logic:
_expand_nested_propertiesto usefield.is_required()for determining if a field is optional, replacing the previous manual inspection of type annotations.Test Coverage Enhancements:
test_structured_output.pyto verify that circular references (both required and optional) raise the appropriate errors, and that fields with default values are correctly marked as optional.Related Issues
#695
Type of Change
Bug fix
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.