Feat: Add helper show commands to easily print avaliable devices and plans to user

Author: oliwenmandiamond

src/blueapi/client/client.py

@@ -295,6 +295,11 @@ def get_plan(self, name: str) -> PlanModel:
         """
         return self._rest.get_plan(name)
 
+    def show_plans(self) -> None:
+        """Command to print all avaliable plans."""
+        for name in self.plans:
+            print(name)
+
     @start_as_current_span(TRACER)
     @deprecated("devices property")
     def get_devices(self) -> DeviceResponse:
@@ -334,6 +339,11 @@ def get_device(self, name: str) -> DeviceModel:
 
         return self._rest.get_device(name)
 
+    def show_devices(self) -> None:
+        """Command to print all avaliable devices."""
+        for name in self.devices:
+            print(name)
+
     @property
     @start_as_current_span(TRACER)
     def state(self) -> WorkerState:

tests/unit_tests/client/test_client.py

@@ -145,6 +145,13 @@ def test_get_plan(client: BlueapiClient):
     assert client.plans["foo"].model == PLAN
 
 
+def test_show_plans(client: BlueapiClient, capsys: pytest.CaptureFixture):
+    client.show_plans()
+    captured = capsys.readouterr()
+    for dev in PLANS.plans:
+        assert dev.name in captured.out
+
+
 def test_get_nonexistant_plan(
     client: BlueapiClient,
 ):
@@ -160,6 +167,13 @@ def test_get_device(client: BlueapiClient):
     assert client.devices.foo.model == DEVICE
 
 
+def test_show_devices(client: BlueapiClient, capsys: pytest.CaptureFixture):
+    client.show_devices()
+    captured = capsys.readouterr()
+    for dev in DEVICES.devices:
+        assert dev.name in captured.out
+
+
 def test_get_nonexistent_device(
     client: BlueapiClient,
 ):