Python: Fix Pydantic error when using Literal type for tool params #2893
+166
−2
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.
Motivation and Context
When using
Literaltype annotations for tool parameters in@ai_functiondecorated methods, Pydantic throws:The
_parse_annotationfunction incorrectly processedLiteraltypes. ForLiteral["Data", "Security"], the args are("Data", "Security"). The code checked ifargs[1]is a string (which"Security"is), then mistakenly createdAnnotated[ForwardRef('Data'), Field(description='Security')], treating literal values as type references.The fix: added early return in
_parse_annotationwhenget_origin(annotation) is Literalto preserve Literal types unchanged.Testing:
Added 9 tests covering:
AnnotatedandField_parse_annotationfunctionDescription
Contribution Checklist