Number of qubits in CLI job list view (#682)

Author: cosenal

metriq_gym/cli.py

@@ -25,7 +25,14 @@
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
 
-LIST_JOBS_HEADERS = ["Metriq-gym Job Id", "Provider", "Device", "Type", "Dispatch time (UTC)"]
+LIST_JOBS_HEADERS = [
+    "Metriq-gym Job Id",
+    "Provider",
+    "Device",
+    "Type",
+    "# Qubits",
+    "Dispatch time (UTC)",
+]
 LIST_JOBS_HEADERS_FULL = ["Suite ID"] + LIST_JOBS_HEADERS
 
 LATEST_JOB_ID = "latest"

metriq_gym/job_manager.py

@@ -9,7 +9,7 @@
 import os
 import pprint
 import logging
-from typing import Any
+from typing import Any, Sequence
 
 from tabulate import tabulate
 from metriq_gym.constants import JobType
@@ -52,7 +52,23 @@ def __post_init__(self) -> None:
                 plat["device"] = self.device_name
         self.platform = plat
 
-    def to_table_row(self, show_suite_id: bool) -> list[str | None]:
+    def num_qubits(self) -> int | None:
+        preferred_keys = ("num_qubits", "qubits", "width", "max_qubits")
+        value: Any | None = None
+        for key in preferred_keys:
+            if key in self.params:
+                value = self.params.get(key)
+                break
+
+        if isinstance(value, bool):
+            return None
+        if isinstance(value, int):
+            return value
+        if isinstance(value, float) and value.is_integer():
+            return int(value)
+        return None
+
+    def to_table_row(self, show_suite_id: bool) -> Sequence[str | int | None]:
         return (
             [
                 self.suite_id,
@@ -64,6 +80,7 @@ def to_table_row(self, show_suite_id: bool) -> list[str | None]:
             self.provider_name,
             self.device_name,
             self.job_type,
+            self.num_qubits(),
             self.dispatch_time.isoformat(),
         ]
 

tests/unit/test_cli.py

@@ -44,14 +44,77 @@ def test_list_jobs_all(capsys):
 
     # Expected output using tabulate
     table = [
-        ["1234", "ibm", "ibmq_qasm_simulator", "Quantum Volume", "2021-09-01T12:00:00"],
-        ["5678", "ionq", "ionq_simulator", "Quantum Volume", "2021-09-02T12:00:00"],
+        ["1234", "ibm", "ibmq_qasm_simulator", "Quantum Volume", None, "2021-09-01T12:00:00"],
+        ["5678", "ionq", "ionq_simulator", "Quantum Volume", None, "2021-09-02T12:00:00"],
     ]
     expected_output = tabulate(table, headers=LIST_JOBS_HEADERS, tablefmt="grid") + "\n"
 
     assert captured.out == expected_output
 
 
+def test_list_jobs_prefers_max_qubits_for_qft(capsys):
+    mock_jobs = [
+        MetriqGymJob(
+            id="qft1",
+            device_name="local_sim",
+            provider_name="local",
+            job_type=JobType.QUANTUM_FOURIER_TRANSFORM,
+            dispatch_time=datetime.fromisoformat("2021-09-01T12:00:00"),
+            params={"max_qubits": 6},
+            data={},
+        )
+    ]
+
+    list_jobs(mock_jobs, show_index=False, show_suite_id=False)
+    captured = capsys.readouterr()
+
+    table = [["qft1", "local", "local_sim", "Quantum Fourier Transform", 6, "2021-09-01T12:00:00"]]
+    expected_output = tabulate(table, headers=LIST_JOBS_HEADERS, tablefmt="grid") + "\n"
+    assert captured.out == expected_output
+
+
+def test_list_jobs_uses_width_alias_for_num_qubits(capsys):
+    mock_jobs = [
+        MetriqGymJob(
+            id="mc1",
+            device_name="local_sim",
+            provider_name="local",
+            job_type=JobType.MIRROR_CIRCUITS,
+            dispatch_time=datetime.fromisoformat("2021-09-01T12:00:00"),
+            params={"width": 11, "max_qubits": 20},
+            data={},
+        )
+    ]
+
+    list_jobs(mock_jobs, show_index=False, show_suite_id=False)
+    captured = capsys.readouterr()
+
+    table = [["mc1", "local", "local_sim", "Mirror Circuits", 11, "2021-09-01T12:00:00"]]
+    expected_output = tabulate(table, headers=LIST_JOBS_HEADERS, tablefmt="grid") + "\n"
+    assert captured.out == expected_output
+
+
+def test_list_jobs_uses_qubits_alias_for_num_qubits(capsys):
+    mock_jobs = [
+        MetriqGymJob(
+            id="q2",
+            device_name="local_sim",
+            provider_name="local",
+            job_type=JobType.WIT,
+            dispatch_time=datetime.fromisoformat("2021-09-01T12:00:00"),
+            params={"qubits": 9},
+            data={},
+        )
+    ]
+
+    list_jobs(mock_jobs, show_index=False, show_suite_id=False)
+    captured = capsys.readouterr()
+
+    table = [["q2", "local", "local_sim", "WIT", 9, "2021-09-01T12:00:00"]]
+    expected_output = tabulate(table, headers=LIST_JOBS_HEADERS, tablefmt="grid") + "\n"
+    assert captured.out == expected_output
+
+
 def test_list_jobs_no_jobs(capsys):
     """Test listing jobs when no jobs are recorded."""
     # Mock no jobs