give message as warning when getting backend

Author: nienkeduetz

qiskit_quantuminspire/qi_backend.py

@@ -129,6 +129,14 @@ def status(self) -> BackendStatus:
         backend_type: BackendType = run_async(self._get_backend_type())
         return backend_type.status
 
+    @property
+    def message(self) -> str:
+        backend_type: BackendType = run_async(self._get_backend_type())
+        messages = ""
+        for backend_name in backend_type.messages.keys():
+            messages += f"{backend_name}: {backend_type.messages[backend_name].content}\n"
+        return messages.rstrip("\n")
+
     async def _get_backend_type(self) -> BackendType:
         async with ApiClient(config()) as client:
             backend_types_api = BackendTypesApi(client)

qiskit_quantuminspire/qi_provider.py

@@ -1,5 +1,7 @@
+import logging
 from typing import Any, List, Optional, Sequence
 
+from colorama import Fore, Style
 from compute_api_client import ApiClient, BackendType, BackendTypesApi, PageBackendType
 from qi2_shared.client import config
 from qi2_shared.pagination import PageReader
@@ -48,6 +50,9 @@ def get_backend(self, name: Optional[str] = None, id: Optional[int] = None) -> Q
 
         for backend in self._qiskit_backends:
             if all(getattr(backend, key) == value for key, value in filter_arguments.items()):
+                if backend.message:
+                    logging.basicConfig(format="%(levelname)s: %(message)s")
+                    logging.warning(f"{Fore.BLUE}{backend.message}{Style.RESET_ALL}")
                 return backend
 
         raise ValueError(f"Backend {name} not found")

tests/helpers.py

@@ -33,7 +33,7 @@ def create_backend_type(
         native_gateset="",
         supports_raw_data=supports_raw_data,
         enabled=True,
-        messages={},
+        messages={"backend": {"content": "message for backend"}},
         job_execution_time_limit=3600,
         identifier="dummy",
     )

tests/test_qi_backend.py

@@ -142,6 +142,19 @@ def test_qi_backend_repr() -> None:
     assert qi_backend.name in repr(qi_backend)
 
 
+def test_qi_backend_construction_messages(mocker: MockerFixture, qi_backend_factory: Callable[..., QIBackend]) -> None:
+    # Arrange
+    backend_type = create_backend_type()
+    mock_run_async = mocker.patch("qiskit_quantuminspire.qi_backend.run_async")
+    mock_run_async.return_value = backend_type
+
+    # Act
+    qi_backend = QIBackend(backend_type=backend_type)
+
+    # Assert
+    assert qi_backend.message == "backend: message for backend"
+
+
 @pytest.mark.parametrize("backend_online", [True, False])  # Test cases for backend being available and offline
 def test_qi_backend_run_backend_status(
     qi_job_mock: MagicMock, qi_backend_factory: Callable[..., QIBackend], backend_online: bool

tests/test_qi_provider.py

@@ -1,3 +1,4 @@
+import logging
 from typing import Any
 from unittest.mock import AsyncMock
 
@@ -13,6 +14,8 @@
 def backend_repository(mocker: MockerFixture, mock_job_api: Any, page_reader_mock: AsyncMock) -> None:
     mocker.patch("qiskit_quantuminspire.qi_provider.config")
     mocker.patch("qiskit_quantuminspire.qi_provider.ApiClient")
+    mock_run_async = mocker.patch("qiskit_quantuminspire.qi_backend.run_async")
+    mock_run_async.return_value = create_backend_type()
     page_reader_mock.get_all.return_value = [
         create_backend_type(name="qi_backend_1", id=10),
         create_backend_type(name="spin", id=20),
@@ -61,6 +64,19 @@ def test_get_backend_no_arguments_gets_first(backend_repository: None) -> None:
     assert backend.id == 10
 
 
+def test_get_backend_print_message(backend_repository: None, caplog: Any) -> None:
+    # Arrange
+    provider = QIProvider()
+
+    # Act
+    with caplog.at_level(logging.WARNING):
+        provider.get_backend(name="qi_backend_1")
+
+    # Assert
+    assert len(caplog.records) == 1
+    assert "backend: message for backend" in caplog.text
+
+
 @pytest.mark.parametrize("name,id", [("not_existing", None), (None, 6), ("not_existing", 6)])
 def test_get_backend_raises_value_error_if_not_found(name: str, id: int, backend_repository: None) -> None:
     # Arrange