Use purpose argument

Signed-off-by: mulhern <[email protected]>

Author: mulkieran

src/stratis_cli/_actions/_dynamic.py

@@ -66,7 +66,7 @@ class ClassKey(Enum):
     REPORT = ClassInfo(REPORT_INTERFACE, invoke_name="Report")
 
 
-class PurposeKey(Enum):
+class Purpose(Enum):
     """
     Purpose of class to be created.
     """
@@ -101,39 +101,42 @@ def new_method(proxy, args):  # pragma: no cover
     setattr(method_class, method_name, new_method)
 
 
-def make_dyn_class(key):
+def make_dyn_class(key, purpose):
     """
     Dynamically generate a class from introspection specification.
 
     :param ClassKey key: key that identifies the class to make
     """
-    try:
-        klass = make_class(
-            key.value.invoke_name,
-            ET.fromstring(SPECS[key.value.interface_name]),  # nosec B314
-            TIMEOUT,
-        )
-
+    if purpose is Purpose.INVOKE:
         try:
-            if key == ClassKey.MANAGER:
-                _add_abs_path_assertion(klass, "CreatePool", "devices")
-            if key == ClassKey.POOL:
-                _add_abs_path_assertion(klass, "InitCache", "devices")
-                _add_abs_path_assertion(klass, "AddCacheDevs", "devices")
-                _add_abs_path_assertion(klass, "AddDataDevs", "devices")
-        except AttributeError as err:  # pragma: no cover
-            # This can only happen if the expected method is missing from
-            # the XML spec or code generation has a bug, we will never
-            # test for these conditions.
+            klass = make_class(
+                key.value.invoke_name,
+                ET.fromstring(SPECS[key.value.interface_name]),  # nosec B314
+                TIMEOUT,
+            )
+
+            try:
+                if key == ClassKey.MANAGER:
+                    _add_abs_path_assertion(klass, "CreatePool", "devices")
+                if key == ClassKey.POOL:
+                    _add_abs_path_assertion(klass, "InitCache", "devices")
+                    _add_abs_path_assertion(klass, "AddCacheDevs", "devices")
+                    _add_abs_path_assertion(klass, "AddDataDevs", "devices")
+            except AttributeError as err:  # pragma: no cover
+                # This can only happen if the expected method is missing from
+                # the XML spec or code generation has a bug, we will never
+                # test for these conditions.
+                raise StratisCliGenerationError(
+                    "Malformed class definition; could not access a class or "
+                    "method in the generated class definition"
+                ) from err
+
+            return klass
+
+        except DPClientGenerationError as err:  # pragma: no cover
             raise StratisCliGenerationError(
-                "Malformed class definition; could not access a class or "
-                "method in the generated class definition"
+                f"Failed to generate class {key.value.invoke_name} needed for invoking "
+                "dbus-python methods"
             ) from err
 
-        return klass
-
-    except DPClientGenerationError as err:  # pragma: no cover
-        raise StratisCliGenerationError(
-            f"Failed to generate class {key.value.invoke_name} needed for invoking "
-            "dbus-python methods"
-        ) from err
+    assert False  # pragma: no cover

src/stratis_cli/_actions/_top.py

@@ -33,7 +33,7 @@
 from .._stratisd_constants import ReportKey, StratisdErrors
 from ._connection import get_object
 from ._constants import TOP_OBJECT
-from ._dynamic import ClassKey, make_dyn_class
+from ._dynamic import ClassKey, Purpose, make_dyn_class
 from ._formatting import print_table
 
 
@@ -45,7 +45,7 @@ def _fetch_keylist(proxy):
     :rtype: list of str
     :raises StratisCliEngineError:
     """
-    Manager = make_dyn_class(ClassKey.MANAGER)
+    Manager = make_dyn_class(ClassKey.MANAGER, Purpose.INVOKE)
 
     (keys, return_code, message) = Manager.Methods.ListKeys(proxy, {})
     if return_code != StratisdErrors.OK:  # pragma: no cover
@@ -68,7 +68,7 @@ def _add_update_key(proxy, key_desc, capture_key, *, keyfile_path):
     """
     assert capture_key == (keyfile_path is None)
 
-    Manager = make_dyn_class(ClassKey.MANAGER)
+    Manager = make_dyn_class(ClassKey.MANAGER, Purpose.INVOKE)
 
     if capture_key:
         password = getpass(prompt="Enter key data followed by the return key: ")
@@ -117,22 +117,22 @@ def get_report(namespace):
         """
 
         if namespace.report_name == ReportKey.MANAGED_OBJECTS.value:
-            ObjectManager = make_dyn_class(ClassKey.OBJECT_MANAGER)
+            ObjectManager = make_dyn_class(ClassKey.OBJECT_MANAGER, Purpose.INVOKE)
 
             json_report = ObjectManager.Methods.GetManagedObjects(
                 get_object(TOP_OBJECT), {}
             )
 
         else:
             if namespace.report_name == ReportKey.ENGINE_STATE.value:
-                Manager = make_dyn_class(ClassKey.MANAGER)
+                Manager = make_dyn_class(ClassKey.MANAGER, Purpose.INVOKE)
 
                 (report, return_code, message) = Manager.Methods.EngineStateReport(
                     get_object(TOP_OBJECT), {}
                 )
 
             else:
-                Report = make_dyn_class(ClassKey.REPORT)
+                Report = make_dyn_class(ClassKey.REPORT, Purpose.INVOKE)
 
                 (report, return_code, message) = Report.Methods.GetReport(
                     get_object(TOP_OBJECT), {"name": namespace.report_name}
@@ -240,7 +240,7 @@ def unset_key(namespace):
         :raises StratisCliNoChangeError:
         :raises StratisCliIncoherenceError:
         """
-        Manager = make_dyn_class(ClassKey.MANAGER)
+        Manager = make_dyn_class(ClassKey.MANAGER, Purpose.INVOKE)
 
         proxy = get_object(TOP_OBJECT)