Skip to content

perf: lazily load openai.types exports #3725

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.

Sign up for GitHub

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
patrickswedish wants to merge 2 commits into
base: main
Choose a base branch
from
Open

perf: lazily load openai.types exports #3725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9a2150
fix(types): lazily import openai.types to resolve cold import latency…
patrickswedish Aug 24, 2026
9101d7e
fix(types): preserve lazy package compatibility
patrickswedish Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/openai/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
import typing as _t
from typing_extensions import override

from . import types
if _t.TYPE_CHECKING:
from . import types as types
else:
from ._utils._types_proxy import types as types
from ._types import NOT_GIVEN, Omit, NoneType, NotGiven, Transport, ProxiesTypes, omit, not_given
from ._utils import file_from_path
from ._client import Client, OpenAI, Stream, Timeout, Transport, AsyncClient, AsyncOpenAI, AsyncStream, RequestOptions
Expand Down Expand Up @@ -121,7 +124,7 @@
# openai._exceptions.NotFoundError -> openai.NotFoundError
__locals = locals()
for __name in __all__:
if not __name.startswith("__"):
if not __name.startswith("__") and __name not in ("types", "resources"):
try:
__locals[__name].__module__ = "openai"
except (TypeError, AttributeError):
Expand Down
24 changes: 24 additions & 0 deletions src/openai/_utils/_types_proxy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
from __future__ import annotations

from typing import Any
from typing_extensions import override

from ._proxy import LazyProxy


class TypesProxy(LazyProxy[Any]):
"""A proxy for the `openai.types` module.

This is used so that we can lazily import `openai.types` only when
needed *and* so that users can just import `openai` and reference `openai.types`
"""

@override
def __load__(self) -> Any:
import importlib

mod = importlib.import_module("openai.types")
return mod


types = TypesProxy().__as_proxied__()
Loading