-
Notifications
You must be signed in to change notification settings - Fork 5k
fix(types): allow missing name on function_call_arguments.done events #3523
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Solaris-star
wants to merge
1
commit into
openai:main
Choose a base branch
from
Solaris-star:fix/3472-optional-function-call-name
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+66
−6
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| from __future__ import annotations | ||
|
|
||
| import pydantic | ||
| import pytest | ||
|
|
||
| from openai.types.beta.beta_response_function_call_arguments_done_event import ( | ||
| BetaResponseFunctionCallArgumentsDoneEvent, | ||
| ) | ||
| from openai.types.responses.response_function_call_arguments_done_event import ( | ||
| ResponseFunctionCallArgumentsDoneEvent, | ||
| ) | ||
| from openai.types.responses.response_stream_event import ResponseStreamEvent | ||
|
|
||
|
|
||
| PAYLOAD_WITHOUT_NAME = { | ||
| "type": "response.function_call_arguments.done", | ||
| "arguments": "{\"city\": \"Paris\"}", | ||
| "item_id": "fc_test_item", | ||
| "output_index": 2, | ||
| "sequence_number": 10, | ||
| } | ||
|
|
||
|
|
||
| def test_function_call_arguments_done_accepts_missing_name() -> None: | ||
| """Live Responses API may omit `name` on done events (issue #3472).""" | ||
| event = ResponseFunctionCallArgumentsDoneEvent.model_validate(PAYLOAD_WITHOUT_NAME) | ||
| assert event.type == "response.function_call_arguments.done" | ||
| assert event.item_id == "fc_test_item" | ||
| assert event.name is None | ||
| assert event.arguments == '{"city": "Paris"}' | ||
|
|
||
|
|
||
| def test_function_call_arguments_done_keeps_name_when_present() -> None: | ||
| event = ResponseFunctionCallArgumentsDoneEvent.model_validate( | ||
| {**PAYLOAD_WITHOUT_NAME, "name": "get_weather"} | ||
| ) | ||
| assert event.name == "get_weather" | ||
|
|
||
|
|
||
| def test_response_stream_event_union_accepts_done_without_name() -> None: | ||
| # Strict union validation previously failed with missing: name. | ||
| event = pydantic.TypeAdapter(ResponseStreamEvent).validate_python(PAYLOAD_WITHOUT_NAME) | ||
| assert isinstance(event, ResponseFunctionCallArgumentsDoneEvent) | ||
| assert event.name is None | ||
|
|
||
|
|
||
| def test_beta_function_call_arguments_done_accepts_missing_name() -> None: | ||
| event = BetaResponseFunctionCallArgumentsDoneEvent.model_validate(PAYLOAD_WITHOUT_NAME) | ||
| assert event.name is None | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the pydantic-v1 CI session (
noxfile.pyinstallspydantic<2and runs the full pytest suite), this new test file fails before exercising the fix: under Pydantic v1 these models do not exposemodel_validate, and the later union test also callspydantic.TypeAdapter, which is v2-only. Using the repository's compatibility helpers (or otherwise gating the v2-only union assertion) keeps the tests passing for the supportedpydantic>=1.9.0,<3range.Useful? React with 👍 / 👎.