qctrl-workflow-client 1.0.0__tar.gz → 1.2.0__tar.gz

{qctrl_workflow_client-1.0.0 → qctrl_workflow_client-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qctrl-workflow-client
-Version: 1.0.0
+Version: 1.2.0
 Summary: Q-CTRL Client
 Home-page: https://q-ctrl.com
 License: https://q-ctrl.com/terms
@@ -33,7 +33,7 @@ Requires-Dist: gql (>=3.4.0,<4.0.0)
 Requires-Dist: importlib-metadata (>=6.8.0,<7.0.0)
 Requires-Dist: packaging (>=23.1.0,<24.0.0)
 Requires-Dist: qctrl-client (>=9.0.1,<10.0.0)
-Requires-Dist: qctrl-commons (>=20.0.0,<21.0.0)
+Requires-Dist: qctrl-commons (>=21.0.0,<22.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: tenacity (>=8.1.0,<9.0.0)
 Requires-Dist: tomli (>=2.0.1,<3.0.0)

{qctrl_workflow_client-1.0.0 → qctrl_workflow_client-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qctrl-workflow-client"
-version = "1.0.0"
+version = "1.2.0"
 description = "Q-CTRL Client"
 license = "https://q-ctrl.com/terms"
 authors = ["Q-CTRL <support@q-ctrl.com>"]
@@ -83,7 +83,7 @@ tenacity = "^8.1.0"
 click = "^8.1.3"
 requests = "^2.31.0"
 packaging = "^23.1.0"
-qctrl-commons = { version = "^20.0.0", source = "PyPI" }
+qctrl-commons = { version = "^21.0.0", source = "PyPI" }
 qctrl-client = { version = "^9.0.1", source = "PyPI" }
 
 [tool.poetry.group.dev.dependencies]

{qctrl_workflow_client-1.0.0 → qctrl_workflow_client-1.2.0}/qctrlworkflowclient/__init__.py

@@ -11,7 +11,7 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
-__version__ = "1.0.0"
+__version__ = "1.2.0"
 
 from .defaults import (
     get_authenticated_client_for_product,

{qctrl_workflow_client-1.0.0 → qctrl_workflow_client-1.2.0}/qctrlworkflowclient/router/api.py

@@ -10,6 +10,7 @@
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
+from __future__ import annotations
 
 import json
 from dataclasses import dataclass
@@ -26,6 +27,7 @@ from warnings import warn
 import gql
 from qctrlclient import GraphQLClient
 from qctrlclient.exceptions import GraphQLClientError
+from qctrlcommons.preconditions import check_argument
 from qctrlcommons.serializers import (
     DataTypeDecoder,
     DataTypeEncoder,
@@ -57,9 +59,13 @@ class ActionStatus(Enum):
     Valid Action statuses.
     """
 
-    SUCCESS = "SUCCESS"
-    FAILURE = "FAILURE"
-    REVOKED = "REVOKED"
+    SUCCESS = "SUCCESS"  # has completed
+    FAILURE = "FAILURE"  # has failed
+    REVOKED = "REVOKED"  # has been cancelled
+    PENDING = "PENDING"  # is queued
+    RECEIVED = "RECEIVED"  # has been received
+    RETRY = "RETRY"  # is retrying
+    STARTED = "STARTED"  # has started
 
 
 @dataclass
@@ -569,7 +575,7 @@ class ApiRouter(BaseRouter):
         Wait until the requested number of machines are online.
         """
 
-        number_of_machines_online = self._get_number_of_machines_online()
+        number_of_machines_online = self.get_machine_status()["online"]
 
         def machines(count: int) -> str:
             if count == 1:
@@ -585,9 +591,9 @@ class ApiRouter(BaseRouter):
             "requested": number_of_machines_requested,
         }
 
-    def _get_number_of_machines_online(self) -> int:
+    def get_machine_status(self) -> dict[str, int]:
         """
-        Return the number of machines that are online.
+        Return the current state of all machines.
         """
         _query = gql.gql(
             """
@@ -595,8 +601,12 @@ class ApiRouter(BaseRouter):
                 tenant(organizationId:$organizationId) {
                     tenant {
                         currentInstances {
+                            initializing
+                            offline
                             online
-                        }
+                            pending
+                            terminating
+                            }
                     }
                     errors {
                         message
@@ -610,10 +620,73 @@ class ApiRouter(BaseRouter):
             _query,
             {"organizationId": self._get_configured_organization().organization_id},
         )
-        number_of_machines_online = response["tenant"]["tenant"]["currentInstances"][
-            "online"
-        ]
-        return number_of_machines_online
+        return response["tenant"]["tenant"]["currentInstances"]
+
+    def activity_monitor(
+        self,
+        limit: int,
+        offset: int = 0,
+        status: Optional[str] = None,
+    ) -> list[dict[str, Any]]:
+        """
+        Fetch metadata from previously submitted actions.
+
+        Parameters
+        ----------
+        limit : int
+            The number of actions to fetch.
+        offset : int, optional
+            The number of recent actions to ignore before starting to fetch.
+            Defaults to 0.
+        status : str or None, optional
+            The filter for action status. Defaults to None.
+
+        Returns
+        -------
+        list[dict[str, Any]]
+            Action metadata with one raw JSON-style dictionary per action.
+        """
+        _query = gql.gql(
+            """
+            query getActions($limit: Int, $offset: Int, $filterBy: ActionFilter) {
+                actions(limit:$limit, offset:$offset, filterBy:$filterBy) {
+                    actions {
+                        name
+                        status
+                        modelType
+                        progress
+                        createdAt
+                        updatedAt
+                        modelId
+                    }
+                    errors {
+                        message
+                    }
+                }
+            }
+        """
+        )
+
+        check_argument(limit >= 1, "Limit must be at least 1.", {"limit": limit})
+        check_argument(offset >= 0, "Offset must be at least 0.", {"offset": offset})
+
+        filter_by = {}
+        if status is not None:
+            valid_statuses = [status.value for status in ActionStatus]
+            check_argument(
+                condition=status in valid_statuses,
+                description="Status is not valid. "
+                "Please choose from a valid status type: "
+                f"{valid_statuses}",
+                arguments={"status": status},
+            )
+            filter_by["status"] = {"exact": status}
+
+        response = self._client.execute(
+            _query,
+            {"limit": limit, "offset": offset, "filterBy": filter_by},
+        )
+        return response["actions"]["actions"]
 
 
 class ParallelCollector: