flyte 0.2.0b4__py3-none-any.whl → 0.2.0b5__py3-none-any.whl

flyte/remote/_project.py

@@ -1,14 +1,13 @@
 from __future__ import annotations
 
-import typing
 from dataclasses import dataclass
-from typing import AsyncGenerator, Literal, Tuple
+from typing import AsyncIterator, Iterator, Literal, Tuple, Union
 
 import rich.repr
 from flyteidl.admin import common_pb2, project_pb2
 
-from flyte._api_commons import syncer
-from flyte._initialize import get_client, get_common_config, requires_client
+from flyte._initialize import ensure_client, get_client, get_common_config
+from flyte.syncify import syncify
 
 
 @dataclass
@@ -19,9 +18,8 @@ class Project:
 
     _pb2: project_pb2.Project
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get(cls, name: str, org: str | None = None) -> Project:
         """
         Get a run by its ID or name. If both are provided, the ID will take precedence.
@@ -29,6 +27,7 @@ class Project:
         :param name: The name of the project.
         :param org: The organization of the project (if applicable).
         """
+        ensure_client()
         service = get_client().project_domain_service  # type: ignore
         resp = await service.GetProject(
             project_pb2.ProjectGetRequest(
@@ -38,14 +37,13 @@ class Project:
         )
         return cls(resp)
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def listall(
         cls,
         filters: str | None = None,
         sort_by: Tuple[str, Literal["asc", "desc"]] | None = None,
-    ) -> typing.Union[typing.Iterator[Project], AsyncGenerator[Project, None]]:
+    ) -> Union[AsyncIterator[Project], Iterator[Project]]:
         """
         Get a run by its ID or name. If both are provided, the ID will take precedence.
 
@@ -53,6 +51,7 @@ class Project:
         :param sort_by: The sorting criteria for the project list, in the format (field, order).
         :return: An iterator of projects.
         """
+        ensure_client()
         token = None
         sort_by = sort_by or ("created_at", "asc")
         sort_pb2 = common_pb2.Sort(

flyte/remote/_run.py

@@ -11,16 +11,16 @@ from google.protobuf import timestamp
 from rich.console import Console
 from rich.progress import Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
 
-from flyte._api_commons import syncer
-from flyte._initialize import get_client, get_common_config, requires_client
+from flyte._initialize import ensure_client, get_client, get_common_config
 from flyte._protos.common import identifier_pb2, list_pb2
 from flyte._protos.workflow import run_definition_pb2, run_service_pb2
+from flyte.syncify import syncify
 
 from .._protos.workflow.run_service_pb2 import WatchActionDetailsResponse
 from ._console import get_run_url
 from ._logs import Logs
 
-WaitFor = Literal["terminal", "running"]
+WaitFor = Literal["terminal", "running", "logs-ready"]
 
 
 def _action_time_phase(action: run_definition_pb2.Action | run_definition_pb2.ActionDetails) -> rich.repr.Result:
@@ -106,14 +106,13 @@ class Run:
             raise RuntimeError("Run does not have an action")
         self.action = Action(self.pb2.action)
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def listall(
         cls,
         filters: str | None = None,
         sort_by: Tuple[str, Literal["asc", "desc"]] | None = None,
-    ) -> Union[Iterator[Run], AsyncGenerator[Run, None]]:
+    ) -> AsyncIterator[Run]:
         """
         Get all runs for the current project and domain.
 
@@ -121,6 +120,7 @@ class Run:
         :param sort_by: The sorting criteria for the project list, in the format (field, order).
         :return: An iterator of runs.
         """
+        ensure_client()
         token = None
         sort_by = sort_by or ("created_at", "asc")
         sort_pb2 = list_pb2.Sort(
@@ -150,16 +150,16 @@ class Run:
             if not token:
                 break
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get(cls, name: str) -> Run:
         """
         Get the current run.
 
         :return: The current run.
         """
-        run_details: RunDetails = await RunDetails.get.aio(RunDetails, name=name)
+        ensure_client()
+        run_details: RunDetails = await RunDetails.get.aio(name=name)
         run = run_definition_pb2.Run(
             action=run_definition_pb2.Action(
                 id=run_details.action_id,
@@ -181,9 +181,16 @@ class Run:
         """
         Get the phase of the run.
         """
-        return run_definition_pb2.Phase.Name(self.action.phase)
+        return self.action.phase
 
-    @syncer.wrap
+    @property
+    def raw_phase(self) -> run_definition_pb2.Phase:
+        """
+        Get the raw phase of the run.
+        """
+        return self.action.raw_phase
+
+    @syncify
     async def wait(self, quiet: bool = False, wait_for: Literal["terminal", "running"] = "terminal") -> None:
         """
         Wait for the run to complete, displaying a rich progress panel with status transitions,
@@ -216,7 +223,6 @@ class Run:
         return self._details
 
     @property
-    @requires_client
     def url(self) -> str:
         """
         Get the URL of the run.
@@ -230,7 +236,7 @@ class Run:
             run_name=self.name,
         )
 
-    @syncer.wrap
+    @syncify
     async def abort(self):
         """
         Aborts / Terminates the run.
@@ -291,13 +297,13 @@ class RunDetails:
         """
         self.action_details = ActionDetails(self.pb2.action)
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get_details(cls, run_id: run_definition_pb2.RunIdentifier) -> RunDetails:
         """
         Get the details of the run. This is a placeholder for getting the run details.
         """
+        ensure_client()
         resp = await get_client().run_service.GetRunDetails(
             run_service_pb2.GetRunDetailsRequest(
                 run_id=run_id,
@@ -305,9 +311,8 @@ class RunDetails:
         )
         return cls(resp.details)
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get(cls, name: str | None = None) -> RunDetails:
         """
         Get a run by its ID or name. If both are provided, the ID will take precedence.
@@ -315,9 +320,9 @@ class RunDetails:
         :param uri: The URI of the run.
         :param name: The name of the run.
         """
+        ensure_client()
         cfg = get_common_config()
         return await RunDetails.get_details.aio(
-            cls,
             run_id=run_definition_pb2.RunIdentifier(
                 org=cfg.org,
                 project=cfg.project,
@@ -390,15 +395,14 @@ class Action:
     pb2: run_definition_pb2.Action
     _details: ActionDetails | None = None
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def listall(
         cls,
         for_run_name: str,
         filters: str | None = None,
         sort_by: Tuple[str, Literal["asc", "desc"]] | None = None,
-    ) -> Union[Iterator[Action], AsyncGenerator[Action, None]]:
+    ) -> Union[Iterator[Action], AsyncIterator[Action]]:
         """
         Get all actions for a given run.
 
@@ -407,6 +411,7 @@ class Action:
         :param sort_by: The sorting criteria for the project list, in the format (field, order).
         :return: An iterator of projects.
         """
+        ensure_client()
         token = None
         sort_by = sort_by or ("created_at", "asc")
         sort_pb2 = list_pb2.Sort(
@@ -436,9 +441,8 @@ class Action:
             if not token:
                 break
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get(cls, uri: str | None = None, /, run_name: str | None = None, name: str | None = None) -> Action:
         """
         Get a run by its ID or name. If both are provided, the ID will take precedence.
@@ -447,9 +451,9 @@ class Action:
         :param run_name: The name of the action.
         :param name: The name of the action.
         """
+        ensure_client()
         cfg = get_common_config()
         details: ActionDetails = await ActionDetails.get_details.aio(
-            cls,
             run_definition_pb2.ActionIdentifier(
                 run=run_definition_pb2.RunIdentifier(
                     org=cfg.org,
@@ -476,6 +480,13 @@ class Action:
         """
         return run_definition_pb2.Phase.Name(self.pb2.status.phase)
 
+    @property
+    def raw_phase(self) -> run_definition_pb2.Phase:
+        """
+        Get the raw phase of the action.
+        """
+        return self.pb2.status.phase
+
     @property
     def name(self) -> str:
         """
@@ -515,10 +526,12 @@ class Action:
         filter_system: bool = False,
     ):
         details = await self.details()
+        if not details.is_running and not details.done():
+            # TODO we can short circuit here if the attempt is not the last one and it is done!
+            await self.wait(wait_for="logs-ready")
+            details = await self.details()
         if not attempt:
             attempt = details.attempts
-        if not details.is_running:
-            await self.wait(wait_for="running")
         return await Logs.create_viewer(
             action_id=self.action_id,
             attempt=attempt,
@@ -533,7 +546,7 @@ class Action:
         Get the details of the action. This is a placeholder for getting the action details.
         """
         if not self._details:
-            self._details = await ActionDetails.get_details.aio(ActionDetails, self.action_id)
+            self._details = await ActionDetails.get_details.aio(self.action_id)
         return cast(ActionDetails, self._details)
 
     async def watch(
@@ -543,14 +556,16 @@ class Action:
         Watch the action for updates. This is a placeholder for watching the action.
         """
         ad = None
-        async for ad in ActionDetails.watch.aio(ActionDetails, self.action_id):
+        async for ad in ActionDetails.watch.aio(self.action_id):
             if ad is None:
                 return
             self._details = ad
             yield ad
-            if wait_for == "running" and ad.phase == run_definition_pb2.PHASE_RUNNING:
+            if wait_for == "running" and ad.is_running:
                 break
-            elif wait_for == "terminal" and _action_done_check(ad.phase):
+            elif wait_for == "logs-ready" and ad.logs_available():
+                break
+            if ad.done():
                 break
         if cache_data_on_done and ad and ad.done():
             await cast(ActionDetails, self._details).outputs()
@@ -597,6 +612,10 @@ class Action:
                         progress.start_task(task_id)
                         break
 
+                    if ad.logs_available() and wait_for == "logs-ready":
+                        progress.start_task(task_id)
+                        break
+
                     # Update progress description with the current phase
                     progress.update(
                         task_id,
@@ -626,7 +645,7 @@ class Action:
         """
         Check if the action is done.
         """
-        return _action_done_check(self.pb2.status.phase)
+        return _action_done_check(self.raw_phase)
 
     async def sync(self) -> Action:
         """
@@ -659,13 +678,13 @@ class ActionDetails:
     _inputs: ActionInputs | None = None
     _outputs: ActionOutputs | None = None
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get_details(cls, action_id: run_definition_pb2.ActionIdentifier) -> ActionDetails:
         """
         Get the details of the action. This is a placeholder for getting the action details.
         """
+        ensure_client()
         resp = await get_client().run_service.GetActionDetails(
             run_service_pb2.GetActionDetailsRequest(
                 action_id=action_id,
@@ -673,9 +692,8 @@ class ActionDetails:
         )
         return ActionDetails(resp.details)
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get(
         cls, uri: str | None = None, /, run_name: str | None = None, name: str | None = None
     ) -> ActionDetails:
@@ -686,11 +704,11 @@ class ActionDetails:
         :param name: The name of the action.
         :param run_name: The name of the run.
         """
+        ensure_client()
         if not uri:
             assert name is not None and run_name is not None, "Either uri or name and run_name must be provided"
         cfg = get_common_config()
         return await cls.get_details.aio(
-            cls,
             run_definition_pb2.ActionIdentifier(
                 run=run_definition_pb2.RunIdentifier(
                     org=cfg.org,
@@ -702,13 +720,13 @@ class ActionDetails:
             ),
         )
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
-    async def watch(cls, action_id: run_definition_pb2.ActionIdentifier) -> AsyncGenerator[ActionDetails, None]:
+    async def watch(cls, action_id: run_definition_pb2.ActionIdentifier) -> AsyncIterator[ActionDetails]:
         """
         Watch the action for updates. This is a placeholder for watching the action.
         """
+        ensure_client()
         if not action_id:
             raise ValueError("Action ID is required")
 
@@ -740,7 +758,7 @@ class ActionDetails:
                 break
 
         if cache_data_on_done and self.done():
-            await self._cache_data.aio(self)
+            await self._cache_data.aio()
 
     @property
     def phase(self) -> str:
@@ -749,6 +767,13 @@ class ActionDetails:
         """
         return run_definition_pb2.Phase.Name(self.status.phase)
 
+    @property
+    def raw_phase(self) -> run_definition_pb2.Phase:
+        """
+        Get the raw phase of the action.
+        """
+        return self.status.phase
+
     @property
     def is_running(self) -> bool:
         """
@@ -824,7 +849,19 @@ class ActionDetails:
         """
         return self.pb2.status.attempts
 
-    @syncer.wrap
+    def logs_available(self, attempt: int | None = None) -> bool:
+        """
+        Check if logs are available for the action, optionally for a specific attempt.
+        If attempt is None, it checks for the latest attempt.
+        """
+        if attempt is None:
+            attempt = self.pb2.status.attempts
+        attempts = self.pb2.attempts
+        if attempts and len(attempts) >= attempt:
+            return attempts[attempt - 1].logs_available
+        return False
+
+    @syncify
     async def _cache_data(self) -> bool:
         """
         Cache the inputs and outputs of the action.
@@ -848,7 +885,7 @@ class ActionDetails:
         Placeholder for inputs. This can be extended to handle inputs from the run context.
         """
         if not self._inputs:
-            await self._cache_data.aio(self)
+            await self._cache_data.aio()
         return cast(ActionInputs, self._inputs)
 
     async def outputs(self) -> ActionOutputs:
@@ -856,7 +893,7 @@ class ActionDetails:
         Placeholder for outputs. This can be extended to handle outputs from the run context.
         """
         if not self._outputs:
-            if not await self._cache_data.aio(self):
+            if not await self._cache_data.aio():
                 raise RuntimeError(
                     "Action is not in a terminal state, outputs are not available. "
                     "Please wait for the action to complete."
@@ -868,7 +905,7 @@ class ActionDetails:
         Check if the action is in a terminal state (completed or failed). This is a placeholder for checking the
         action state.
         """
-        return _action_done_check(self.pb2.status.phase)
+        return _action_done_check(self.raw_phase)
 
     def __rich_repr__(self) -> rich.repr.Result:
         """

flyte/remote/_secret.py

@@ -1,13 +1,13 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import AsyncGenerator, Iterator, Literal, Union
+from typing import AsyncIterator, Literal, Union
 
 import rich.repr
 
-from flyte._api_commons import syncer
-from flyte._initialize import get_client, get_common_config, requires_client
+from flyte._initialize import ensure_client, get_client, get_common_config
 from flyte._protos.secret import definition_pb2, payload_pb2
+from flyte.syncify import syncify
 
 SecretTypes = Literal["regular", "image_pull"]
 
@@ -16,10 +16,10 @@ SecretTypes = Literal["regular", "image_pull"]
 class Secret:
     pb2: definition_pb2.Secret
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def create(cls, name: str, value: Union[str, bytes], type: SecretTypes = "regular"):
+        ensure_client()
         cfg = get_common_config()
         secret_type = (
             definition_pb2.SecretType.SECRET_TYPE_GENERIC
@@ -49,10 +49,10 @@ class Secret:
             ),
         )
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def get(cls, name: str) -> Secret:
+        ensure_client()
         cfg = get_common_config()
         resp = await get_client().secrets_service.GetSecret(
             request=payload_pb2.GetSecretRequest(
@@ -66,10 +66,10 @@ class Secret:
         )
         return Secret(pb2=resp.secret)
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
-    async def listall(cls, limit: int = 100) -> Union[Iterator[Secret], AsyncGenerator[Secret, None]]:
+    async def listall(cls, limit: int = 100) -> AsyncIterator[Secret]:
+        ensure_client()
         cfg = get_common_config()
         token = None
         while True:
@@ -88,10 +88,10 @@ class Secret:
             if not token:
                 break
 
+    @syncify
     @classmethod
-    @requires_client
-    @syncer.wrap
     async def delete(cls, name):
+        ensure_client()
         cfg = get_common_config()
         await get_client().secrets_service.DeleteSecret(  # type: ignore
             request=payload_pb2.DeleteSecretRequest(

flyte/remote/_task.py

@@ -9,11 +9,11 @@ import rich.repr
 
 import flyte
 import flyte.errors
-from flyte._api_commons import syncer
 from flyte._context import internal_ctx
 from flyte._initialize import get_client, get_common_config
 from flyte._protos.workflow import task_definition_pb2, task_service_pb2
 from flyte.models import NativeInterface
+from flyte.syncify import syncify
 
 
 class LazyEntity:
@@ -32,7 +32,7 @@ class LazyEntity:
     def name(self) -> str:
         return self._name
 
-    @syncer.wrap
+    @syncify
     async def fetch(self) -> Task:
         """
         Forwards all other attributes to task, causing the task to be fetched!
@@ -48,7 +48,7 @@ class LazyEntity:
         """
         Forwards the call to the underlying task. The entity will be fetched if not already present
         """
-        tk = await self.fetch.aio(self)
+        tk = await self.fetch.aio()
         return await tk(*args, **kwargs)
 
     def __repr__(self) -> str:

flyte/report/_report.py

@@ -4,10 +4,10 @@ import string
 from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Dict, List, Union
 
-from flyte._api_commons import syncer
 from flyte._internal.runtime import io
 from flyte._logging import logger
 from flyte._tools import ipython_check
+from flyte.syncify import syncify
 
 if TYPE_CHECKING:
     from IPython.core.display import HTML
@@ -112,7 +112,7 @@ def get_tab(name: str, /, create_if_missing: bool = True) -> Tab:
     return report.get_tab(name, create_if_missing=create_if_missing)
 
 
-@syncer.wrap
+@syncify
 async def log(content: str, do_flush: bool = False):
     """
     Log content to the main tab. The content should be a valid HTML string, but not a complete HTML document,
@@ -126,7 +126,7 @@ async def log(content: str, do_flush: bool = False):
         await flush.aio()
 
 
-@syncer.wrap
+@syncify
 async def flush():
     """
     Flush the report.
@@ -149,7 +149,7 @@ async def flush():
     logger.debug(f"Report flushed to {final_path}")
 
 
-@syncer.wrap
+@syncify
 async def replace(content: str, do_flush: bool = False):
     """
     Get the report. Replaces the content of the main tab.

flyte/syncify/__init__.py

@@ -0,0 +1,5 @@
+from flyte.syncify._api import Syncify
+
+syncify = Syncify()
+
+__all__ = ["Syncify", "syncify"]