Fix type hint on sync api.get() (#556)

kr8s-org · Jan 22, 2025 · 947edfd · 947edfd
1 parent d19b6c1
commit 947edfd
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/kr8s/__init__.py b/kr8s/__init__.py
@@ -77,7 +77,7 @@ def get(  # type: ignore
         as_object: type[APIObject] | None = None,
         allow_unknown_type: bool = True,
         **kwargs,
-    ) -> Generator[APIObject]:
+    ) -> Generator[objects.APIObject]:
         yield from _run_sync(self.async_get)(
             kind,
             *names,
@@ -96,7 +96,7 @@ def watch(  # type: ignore
         label_selector: str | dict | None = None,
         field_selector: str | dict | None = None,
         since: str | None = None,
-    ) -> Generator[tuple[str, APIObject]]:
+    ) -> Generator[tuple[str, objects.APIObject]]:
         yield from _run_sync(self.async_watch)(
             kind,
             namespace=namespace,

diff --git a/kr8s/objects.py b/kr8s/objects.py
@@ -138,6 +138,10 @@
 from .portforward import PortForward
 
 
+class APIObject(APIObjectSyncMixin):
+    __doc__ = APIObjectSyncMixin.__doc__
+
+
 class Binding(APIObjectSyncMixin, _Binding):
     __doc__ = _Binding.__doc__
 

diff --git a/kr8s/tests/test_api.py b/kr8s/tests/test_api.py
@@ -265,14 +265,17 @@ async def test_async_get_returns_async_objects() -> None:
 
 
 def test_sync_get_returns_sync_objects() -> None:
-    pods = kr8s.get("pods", namespace=kr8s.ALL)
-    assert list(pods)[0]._asyncio is False
+    pods = list(kr8s.get("pods", namespace=kr8s.ALL))
+    assert pods[0]._asyncio is False
+    pods[0].refresh()
 
 
 def test_sync_api_returns_sync_objects():
     api = kr8s.api()
     pods = api.get("pods", namespace=kr8s.ALL)
-    assert next(pods)._asyncio is False
+    pod = next(pods)
+    assert pod._asyncio is False
+    pod.refresh()
 
 
 async def test_api_names(example_pod_spec: dict, ns: str) -> None: