Skip to content

fix: Enable from vertexai.types import TypeName without needing to run from vertexai import types first #6173

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

Merged
copybara-service merged 1 commit into from
Dec 1, 2025
Merged

fix: Enable from vertexai.types import TypeName without needing to run from vertexai import types first #6173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 1 addition & 11 deletions tests/unit/architecture/test_vertexai_import.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,7 @@ def test_vertexai_import():
new_modules_after_vertexai = modules_after_vertexai - modules_before_vertexai

vertexai_module_name = vertexai.__name__ # == "vertexai"
assert sorted(new_modules_after_vertexai) == sorted(
[
vertexai_module_name,
f"{vertexai_module_name}.types",
]
)

placeholder_vertexai_types_module = sys.modules[f"{vertexai_module_name}.types"]
assert isinstance(placeholder_vertexai_types_module, vertexai._LazyTypesLoader)

assert f"{vertexai_module_name}._genai.types" not in sys.modules
assert sorted(new_modules_after_vertexai) == [vertexai_module_name]

assert vertexai_import_timedelta.total_seconds() < 0.005
assert aip_import_timedelta.total_seconds() < 40
Expand Down
27 changes: 6 additions & 21 deletions vertexai/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
import importlib
import sys

from types import ModuleType
from typing import Any

from google.cloud.aiplatform import version as aiplatform_version

__version__ = aiplatform_version.__version__
Expand All @@ -30,23 +27,6 @@
_genai_types = None


class _LazyTypesLoader(ModuleType):
"""A module that lazily loads the types module when an attribute is accessed via from `vertexai.types import TypeName`."""

def __init__(self, *args: Any, **kwargs: Any):
super().__init__(*args, **kwargs)
self._module = None

def __getattr__(self, name: str):
if self._module is None:
self._module = importlib.import_module("._genai.types", __package__)
return getattr(self._module, name)


# Register a placeholder _LazyTypesLoader instance for vertexai.types until it is accessed.
sys.modules[__name__ + ".types"] = _LazyTypesLoader(__name__ + ".types")


def __getattr__(name): # type: ignore[no-untyped-def]
# Lazy importing the preview submodule
# See https://peps.python.org/pep-0562/
Expand All @@ -65,7 +45,12 @@ def __getattr__(name): # type: ignore[no-untyped-def]
return getattr(_genai_client, name)

if name == "types":
return sys.modules[__name__ + ".types"]
global _genai_types
if _genai_types is None:
_genai_types = importlib.import_module("._genai.types", __name__)
if "vertexai.types" not in sys.modules:
sys.modules["vertexai.types"] = _genai_types
return _genai_types

raise AttributeError(f"module '{__name__}' has no attribute '{name}'")

Expand Down