Add local channel

qiskit_ibm_runtime/accounts/account.py

@@ -26,7 +26,7 @@
 from ..utils import resolve_crn
 
 AccountType = Optional[Literal["cloud", "legacy"]]
-ChannelType = Optional[Literal["ibm_cloud", "ibm_quantum"]]
+ChannelType = Optional[Literal["ibm_cloud", "ibm_quantum", "local"]]
 
 IBM_QUANTUM_API_URL = "https://auth.quantum-computing.ibm.com/api"
 IBM_CLOUD_API_URL = "https://cloud.ibm.com"

qiskit_ibm_runtime/qiskit_runtime_service.py

@@ -56,6 +56,16 @@ class QiskitRuntimeService:
 
     global_service = None
 
+    def __new__(cls, *args, **kwargs):  # type: ignore[no-untyped-def]
+        channel = kwargs.get("channel", None)
+        if channel == "local":
+            # pylint: disable=import-outside-toplevel
+            from .fake_provider.local_service import QiskitRuntimeLocalService
+
+            return super().__new__(QiskitRuntimeLocalService)
+        else:
+            return super().__new__(cls)
+
     def __init__(
         self,
         channel: Optional[ChannelType] = None,
@@ -85,7 +95,7 @@ def __init__(
         values in the loaded account.
 
         Args:
-            channel: Channel type. ``ibm_cloud`` or ``ibm_quantum``.
+            channel: Channel type. ``ibm_cloud``, ``ibm_quantum`` or ``local``.
             token: IBM Cloud API key or IBM Quantum API token.
             url: The API URL.
                 Defaults to https://cloud.ibm.com (ibm_cloud) or
@@ -106,7 +116,7 @@ def __init__(
             private_endpoint: Connect to private API URL.
 
         Returns:
-            An instance of QiskitRuntimeService.
+            An instance of QiskitRuntimeService or QiskitRuntimeLocalService for local channel.
 
         Raises:
             IBMInputValueError: If an input is invalid.

release-notes/unreleased/1793.feat.rst

@@ -0,0 +1,8 @@
+The :class:`QiskitRuntimeLocalService` was created to support a local
+testing mode. To avoid having to initialize a separate class, "local"
+has been added to the valid :class:`QiskitRuntimeService` channel.
+
+.. code:: python
+    service=QiskitRuntimeService(channel="local")
+
+a :class:`QiskitRuntimeLocalService` instance will be returned.

test/integration/test_account.py

@@ -20,6 +20,7 @@
 
 from qiskit_ibm_runtime import QiskitRuntimeService
 from qiskit_ibm_runtime.accounts import CloudResourceNameResolutionError
+from qiskit_ibm_runtime.fake_provider.local_service import QiskitRuntimeLocalService
 from qiskit_ibm_runtime.utils.utils import (
     get_resource_controller_api_url,
     get_iam_api_url,
@@ -74,6 +75,21 @@ def test_channel_strategy(self):
         )
         self.assertTrue(service)
 
+    def test_local_channel(self):
+        """Test local channel mode"""
+        local_service = QiskitRuntimeService(
+            channel="local",
+        )
+        local_service1 = QiskitRuntimeService(
+            channel="local",
+            url=self.dependencies.url,
+            token=self.dependencies.token,
+            instance=self.dependencies.instance,
+            channel_strategy="default",
+        )
+        self.assertIsInstance(local_service, QiskitRuntimeLocalService)
+        self.assertIsInstance(local_service1, QiskitRuntimeLocalService)
+
     def test_resolve_crn_for_valid_service_instance_name(self):
         """Verify if CRN is transparently resolved based for an existing service instance name."""
         self._skip_on_ibm_quantum()

test/unit/mock/fake_runtime_service.py

@@ -36,6 +36,9 @@ class FakeRuntimeService(QiskitRuntimeService):
     DEFAULT_COMMON_BACKEND = "common_backend"
     DEFAULT_UNIQUE_BACKEND_PREFIX = "unique_backend_"
 
+    def __new__(cls, *args, num_hgps=2, runtime_client=None, backend_specs=None, **kwargs):
+        return super().__new__(cls, *args, **kwargs)
+
     def __init__(self, *args, num_hgps=2, runtime_client=None, backend_specs=None, **kwargs):
         self._test_num_hgps = num_hgps
         self._fake_runtime_client = runtime_client