Delegate top-level adapter imports to adapters package.
Code Quality Pipeline / code-quality (pull_request) Successful in 47s
PR Title Check / check-title (pull_request) Successful in 6s
Test Python Package / test (pull_request) Failing after 1m1s

Keep lazy loading in adapters/__init__.py as the single place to register new adapters.

Co-authored-by: Cursor <[email protected]>
This commit is contained in:
Brian Bjarke Jensen
2026-06-30 15:57:52 +02:00
co-authored by Cursor
parent f092ca2022
commit 1f02195c27
3 changed files with 21 additions and 18 deletions
+8 -18
View File
@@ -2,10 +2,10 @@
from __future__ import annotations from __future__ import annotations
import importlib
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
# Interfaces are always available; they have no optional backend dependencies. # Interfaces are always available; they have no optional backend dependencies.
from . import adapters
from .interfaces import ( from .interfaces import (
ConnectionAwareInterface, ConnectionAwareInterface,
ContextAwareInterface, ContextAwareInterface,
@@ -13,34 +13,24 @@ from .interfaces import (
ObjectRepositoryInterface, ObjectRepositoryInterface,
) )
# Adapters are imported only for static type checkers; runtime loading is deferred below. # Adapters are imported only for static type checkers; runtime loading is delegated below.
if TYPE_CHECKING: if TYPE_CHECKING:
from .adapters.minio_adapter import MinioAdapter from .adapters.minio_adapter import MinioAdapter as MinioAdapter
from .adapters.redis_adapter import RedisAdapter from .adapters.redis_adapter import RedisAdapter as RedisAdapter
# Map public adapter names to their defining module and class.
# Each adapter module fails fast with an install hint if its extra is missing.
_LAZY_EXPORTS = {
"RedisAdapter": (".adapters.redis_adapter", "RedisAdapter"),
"MinioAdapter": (".adapters.minio_adapter", "MinioAdapter"),
}
__all__ = [ __all__ = [
"ConnectionAwareInterface", "ConnectionAwareInterface",
"ContextAwareInterface", "ContextAwareInterface",
"JsonRepositoryInterface", "JsonRepositoryInterface",
"ObjectRepositoryInterface", "ObjectRepositoryInterface",
"RedisAdapter", *adapters.__all__,
"MinioAdapter",
] ]
def __getattr__(name: str) -> object: def __getattr__(name: str) -> object:
"""Load adapters on first access so the base package installs without redis/minio.""" """Delegate adapter lookups to adapters; lazy loading is defined there."""
if name in _LAZY_EXPORTS: if name in adapters.__all__:
module_path, attr = _LAZY_EXPORTS[name] return getattr(adapters, name)
module = importlib.import_module(module_path, __package__)
return getattr(module, attr)
raise AttributeError(f"module {__name__!r} has no attribute {name!r}") raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+6
View File
@@ -9,10 +9,14 @@ from __future__ import annotations
import importlib import importlib
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
# Adapters are imported only for static type checkers; runtime loading is deferred below.
if TYPE_CHECKING: if TYPE_CHECKING:
from .minio_adapter import MinioAdapter from .minio_adapter import MinioAdapter
from .redis_adapter import RedisAdapter from .redis_adapter import RedisAdapter
# Map public adapter names to their defining module and class.
# Each adapter module fails fast with an install hint if its extra is missing.
# When adding a new adapter, update this dict and __all__ only.
_LAZY_EXPORTS = { _LAZY_EXPORTS = {
"RedisAdapter": (".redis_adapter", "RedisAdapter"), "RedisAdapter": (".redis_adapter", "RedisAdapter"),
"MinioAdapter": (".minio_adapter", "MinioAdapter"), "MinioAdapter": (".minio_adapter", "MinioAdapter"),
@@ -25,6 +29,7 @@ __all__ = [
def __getattr__(name: str) -> object: def __getattr__(name: str) -> object:
"""Load an adapter on first access so the base package installs without backend clients."""
if name in _LAZY_EXPORTS: if name in _LAZY_EXPORTS:
module_path, attr = _LAZY_EXPORTS[name] module_path, attr = _LAZY_EXPORTS[name]
module = importlib.import_module(module_path, __package__) module = importlib.import_module(module_path, __package__)
@@ -33,4 +38,5 @@ def __getattr__(name: str) -> object:
def __dir__() -> list[str]: def __dir__() -> list[str]:
"""Expose lazy adapter names in tab completion and dir()."""
return sorted(__all__) return sorted(__all__)
+7
View File
@@ -93,3 +93,10 @@ def test_top_level_lazy_import_propagates_minio_import_error() -> None:
): ):
with pytest.raises(ImportError, match=r"python-repositories\[minio\]"): with pytest.raises(ImportError, match=r"python-repositories\[minio\]"):
_ = python_repositories.MinioAdapter _ = python_repositories.MinioAdapter
def test_adapters_subpackage_lazy_import_succeeds() -> None:
"""Adapter subpackage imports delegate to the same lazy loader."""
from python_repositories.adapters import RedisAdapter
assert RedisAdapter.__name__ == "RedisAdapter"