-
Notifications
You must be signed in to change notification settings - Fork 5.1k
perf(lib): stop pulling openai.types.beta into every import openai #3727
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
aviseth
wants to merge
3
commits into
openai:main
Choose a base branch
from
aviseth:perf/lazy-beta-types-in-assistant-streaming
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.
+74
−4
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| from __future__ import annotations | ||
|
|
||
| import sys | ||
| import typing | ||
| import subprocess | ||
|
|
||
| import pytest | ||
|
|
||
| import openai | ||
|
|
||
|
|
||
| def _modules_after_import_openai() -> set[str]: | ||
| """Return the module names loaded by a bare `import openai` in a fresh interpreter.""" | ||
| output = subprocess.run( | ||
| [ | ||
| sys.executable, | ||
| "-c", | ||
| "import sys\nimport openai\nprint('\\n'.join(sys.modules))\n", | ||
| ], | ||
| check=True, | ||
| capture_output=True, | ||
| text=True, | ||
| ).stdout | ||
| return set(output.split()) | ||
|
|
||
|
|
||
| def test_import_openai_does_not_load_beta_types() -> None: | ||
| # `openai.lib.streaming` is only needed by callers using the Assistants API, | ||
| # and it reaches `openai.types.beta`, so importing the package must not pull | ||
| # the namespace in. | ||
| modules = _modules_after_import_openai() | ||
|
|
||
| assert "openai" in modules | ||
| assert not [module for module in modules if module.startswith("openai.types.beta")] | ||
|
|
||
|
|
||
| def test_assistant_event_handlers_are_still_exported() -> None: | ||
| assert openai.AssistantEventHandler.__name__ == "AssistantEventHandler" | ||
| assert openai.AsyncAssistantEventHandler.__name__ == "AsyncAssistantEventHandler" | ||
|
|
||
|
|
||
| def test_handler_annotations_stay_resolvable() -> None: | ||
| # Deferring the module must not make the handlers' postponed annotations | ||
| # unresolvable: `get_type_hints` has to keep working for annotation-aware | ||
| # integrations and documentation tooling. | ||
| for name in ("on_event", "on_run_step_delta", "on_tool_call_delta"): | ||
| hints = typing.get_type_hints(getattr(openai.AssistantEventHandler, name)) | ||
| assert "return" in hints | ||
|
|
||
|
|
||
| def test_unknown_attribute_still_raises_attribute_error() -> None: | ||
| with pytest.raises(AttributeError, match="definitely_not_an_export"): | ||
| openai.definitely_not_an_export # type: ignore[attr-defined] # noqa: B018 |
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.
On a fresh
import openai, these public classes are now absent from the module dictionary, anddir(openai)therefore omits them until some separate direct attribute lookup happens. This makes standard discovery paths such asinspect.getmembers(openai)fail to find either documented handler, whereas they were discoverable before this change. Add a module__dir__that includes_STREAMING_EXPORTSso introspection remains compatible without eagerly importing the beta types.AGENTS.md reference: AGENTS.md:L5-L8
Useful? React with 👍 / 👎.