qctrl-workflow-client 5.1.2__tar.gz → 5.3.0__tar.gz

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: qctrl-workflow-client
-Version: 5.1.2
+Version: 5.3.0
 Summary: Q-CTRL Workflow Client
-Home-page: https://q-ctrl.com
 License: https://q-ctrl.com/terms
 Keywords: black opal,boulder opal,fire opal,nisq,open controls,q control,q ctrl,q-control,q-ctrl,qcontrol,qctrl,quantum,quantum algorithms,quantum circuits,quantum coding,quantum coding software,quantum computing,quantum control,quantum control software,quantum control theory,quantum engineering,quantum error correction,quantum firmware,quantum fundamentals,quantum sensing,qubit,qudit
 Author: Q-CTRL
@@ -35,10 +34,11 @@ Requires-Dist: qctrl-client (>=10.1.0,<11.0.0)
 Requires-Dist: qctrl-commons (==23.3.0)
 Requires-Dist: requests (>=2.32.0,<3.0.0)
 Requires-Dist: tenacity (>=8.1.0,<9.0.0)
-Requires-Dist: tomli (>=2.0.1,<3.0.0)
+Requires-Dist: tomli (>=2.2.1,<3.0.0)
 Project-URL: Documentation, https://docs.q-ctrl.com
 Project-URL: Facebook, https://www.facebook.com/qctrl
 Project-URL: GitHub, https://github.com/qctrl
+Project-URL: Homepage, https://q-ctrl.com
 Project-URL: LinkedIn, https://www.linkedin.com/company/q-ctrl/
 Project-URL: X, https://x.com/qctrlHQ
 Project-URL: YouTube, https://www.youtube.com/qctrl

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qctrl-workflow-client"
-version = "5.1.2"
+version = "5.3.0"
 description = "Q-CTRL Workflow Client"
 license = "https://q-ctrl.com/terms"
 authors = ["Q-CTRL <support@q-ctrl.com>"]
@@ -75,7 +75,7 @@ priority = "supplemental"
 
 [tool.poetry.dependencies]
 python = ">=3.9, <3.13"
-tomli = "^2.0.1"
+tomli = "^2.2.1"
 importlib-metadata = "^6.8.0"
 gql = "^3.4.0"
 tenacity = "^8.1.0"
@@ -85,15 +85,15 @@ qctrl-commons = { version = "23.3.0", source = "PyPI" }
 qctrl-client = { version = "^10.1.0", source = "PyPI" }
 
 [tool.poetry.group.dev.dependencies]
-black = "^24.3.0"
-isort = "^5.12.0"
-pre-commit = "^3.3.3"
-pylint = "^3.2.2"
-pytest = "^7.2.2"
-pytest-cov = "^4.0.0"
+black = "^25.1.0"
+isort = "^6.0.0"
+pre-commit = "^4.1.0"
+pylint = "^3.3.4"
+pytest = "^8.3.4"
+pytest-cov = "^6.0.0"
 pytest-mock = "^3.10.0"
 pytest-xdist = "^3.2.1"
-qctrl-core-workflow-manager = "^4.0.0"
+qctrl-core-workflow-manager = "^5.0.0"
 
 [tool.isort]
 profile = "black"

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.
@@ -11,7 +11,7 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
-__version__ = "5.1.2"
+__version__ = "5.3.0"
 
 from .defaults import get_authenticated_client_for_product
 from .functions import (

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/defaults.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/functions.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.
@@ -26,7 +26,10 @@ from qctrlworkflowclient.router.api import ApiRouter
 
 
 def core_workflow(
-    get_config: Callable, workflow: str, formatter: Optional[Callable] = None
+    get_config: Callable,
+    workflow: str,
+    formatter: Optional[Callable] = None,
+    registry_selector: Optional[Callable] = None,
 ):
     """
     Decorator for a function which will execute a workflow.
@@ -55,6 +58,12 @@ def core_workflow(
         result. The callable should accept exactly one argument
         which is the raw result fo the workflow. If used, the
         decorated function will return the result of this callable.
+    registry_selector : Callable, optional
+        Optional callable which can be used to select the registry
+        to be used for the workflow. The callable should accept
+        exactly one argument which is the data returned by the
+        decorated function. If used, the decorated function will
+        return the result of this callable.
     """
 
     def decorator(func: Callable):
@@ -70,7 +79,16 @@ def core_workflow(
                 router.set_async_state(kwargs.pop("is_async", False))
 
             data = func(*args, **kwargs)
-            result = router(workflow, data)
+
+            # dynamically select the registry to be used if selector provided
+            # otherwise the default registry set in the router will be used
+            registry = registry_selector(data) if registry_selector else None
+
+            # if the router is an instance of the ApiRouter, pass the registry
+            if isinstance(router, ApiRouter):
+                result = router(workflow, data, registry=registry)
+            else:
+                result = router(workflow, data)
 
             if formatter:
                 result = formatter(result)
@@ -83,7 +101,10 @@ def core_workflow(
 
 
 def async_core_workflow(
-    get_config: Callable, workflow: str, formatter: Optional[Callable] = None
+    get_config: Callable,
+    workflow: str,
+    formatter: Optional[Callable] = None,
+    registry_selector: Optional[Callable] = None,
 ):
     """
     Decorator for a function which will execute asynchronously workflow.
@@ -112,6 +133,12 @@ def async_core_workflow(
         result. The callable should accept exactly one argument
         which is the raw result fo the workflow. If used, the
         decorated function will return the result of this callable.
+    registry_selector : Callable, optional
+        Optional callable which can be used to select the registry
+        to be used for the workflow. The callable should accept
+        exactly one argument which is the data returned by the
+        decorated function. If used, the decorated function will
+        return the result of this callable.
     """
 
     def decorator(func: Callable):
@@ -132,7 +159,16 @@ def async_core_workflow(
                 )
 
             data = func(*args, **kwargs)
-            result = router(workflow, data)
+
+            # dynamically select the registry to be used if selector provided
+            # otherwise the default registry set in the router will be used
+            registry = registry_selector(data) if registry_selector else None
+
+            # if the router is an instance of the ApiRouter, pass the registry
+            if isinstance(router, ApiRouter):
+                result = router(workflow, data, registry=registry)
+            else:
+                result = router(workflow, data)
 
             if formatter:
                 result = formatter(result)

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/products.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/router/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/router/api.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.
@@ -40,6 +40,7 @@ from tenacity import (
     wait_fixed,
 )
 
+from qctrlworkflowclient.products import Product
 from qctrlworkflowclient.settings import CoreClientSettings
 from qctrlworkflowclient.utils import get_installed_version
 
@@ -340,7 +341,19 @@ class ApiRouter(BaseRouter):
         self._parallel_task_collector = collector
         return collector
 
-    def __call__(self, workflow, data=None):
+    def __call__(self, workflow, data=None, registry=None):
+        """
+        Executes the workflow through the API.
+
+        Parameters
+        ----------
+        workflow : str
+            Name of the workflow to be executed.
+        data : Dict[str, Any], optional
+            Any data required by the workflow for execution.
+        registry : str, optional
+            The registry to be used for the workflow execution.
+        """
         query = gql.gql(
             """
             mutation ($input: StartCoreWorkflowInput!) {
@@ -367,8 +380,13 @@ class ApiRouter(BaseRouter):
         )
 
         client_metadata = self._get_client_metadata()
+
+        # if registry is not provided, use the default registry
+        if registry is None:
+            registry = self._settings.product.value.registry
+
         input_ = {
-            "registry": self._settings.product.value.registry,
+            "registry": registry,
             "workflow": workflow,
             "data": json.dumps(data, cls=DataTypeEncoder),
             "clientMetadata": json.dumps(client_metadata),
@@ -501,6 +519,13 @@ class ApiRouter(BaseRouter):
                 action = self._poll_for_completion(action)
             except KeyboardInterrupt as exc:
                 if revoke_on_interrupt:
+                    if self._settings.product == Product.BOULDER_OPAL:
+                        warn(
+                            "Keyboard interrupts will not cancel remote jobs in the future. "
+                            "To cancel a job, use the BoulderOpalJob.cancel() method instead.",
+                            category=FutureWarning,
+                            stacklevel=2,
+                        )
                     self._revoke_action(action)
                     action = self._poll_for_completion(action)
                 else:

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/router/base.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.
@@ -15,11 +15,7 @@ from abc import (
     ABC,
     abstractmethod,
 )
-from typing import (
-    Any,
-    Dict,
-    Optional,
-)
+from typing import Any
 
 
 class BaseRouter(ABC):
@@ -28,15 +24,12 @@ class BaseRouter(ABC):
     """
 
     @abstractmethod
-    def __call__(self, workflow: str, data: Optional[Dict[str, Any]] = None) -> Any:
+    def __call__(
+        self,
+        *args,
+        **kwargs,
+    ) -> Any:
         """
         Given a workflow name and the corresponding data (if any),
         execute the workflow and returns the raw result.
-
-        Parameters
-        ----------
-        workflow : str
-            Name of the workflow to be executed.
-        data : Dict[str, Any], optional
-            Any data required by the workflow for execution.
         """

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/router/local.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.
@@ -30,6 +30,16 @@ class LocalRouter(BaseRouter):
         self._resolver = resolver
 
     def __call__(self, workflow, data=None):
+        """
+        Executes the workflow locally.
+
+        Parameters
+        ----------
+        workflow : str
+            Name of the workflow to be executed.
+        data : Dict[str, Any], optional
+            Any data required by the workflow for execution.
+        """
         data = data or {}
         task = self._resolver.get_workflow_task_from_signature(workflow, **data)
         func = self._resolver(task)

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/settings.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.

{qctrl_workflow_client-5.1.2 → qctrl_workflow_client-5.3.0}/qctrlworkflowclient/utils.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Q-CTRL. All rights reserved.
+# Copyright 2025 Q-CTRL. All rights reserved.
 #
 # Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
 # copying or use of this file, via any medium, is strictly prohibited.