Python pydantic

.github/workflows/main.yml

@@ -40,6 +40,7 @@ jobs:
               python3-justbytes
               python3-packaging
               python3-psutil
+              python3-pydantic
               python3-wcwidth
             task: >
               PATH=${PATH}:/github/home/.local/bin PYTHONPATH=./src
@@ -128,6 +129,7 @@ jobs:
           python3-dateutil
           python3-packaging
           python3-psutil
+          python3-pydantic
           python3-wcwidth
           systemd-devel
       - uses: dtolnay/rust-toolchain@master
@@ -164,6 +166,7 @@ jobs:
               python3-dateutil
               python3-packaging
               python3-psutil
+              python3-pydantic
               python3-wcwidth
             task: make -f Makefile legacy-package
     runs-on: ubuntu-latest

.github/workflows/weekly.yml

@@ -24,6 +24,7 @@ jobs:
               python3-justbytes
               python3-packaging
               python3-psutil
+              python3-pydantic
               python3-wcwidth
             task: >
               PATH=${PATH}:/github/home/.local/bin PYTHONPATH=./src

setup.cfg

@@ -31,6 +31,7 @@ install_requires =
     justbytes>=0.14
     packaging
     psutil
+    pydantic
     python-dateutil
     wcwidth
 

src/stratis_cli/_actions/_list_pool.py

@@ -534,7 +534,7 @@ def display(self):
 
         (pool_uuid, pool) = stopped_pool
 
-        self._print_detail_view(pool_uuid, StoppedPool(pool))
+        self._print_detail_view(pool_uuid, StoppedPool(**pool))
 
 
 class StoppedTable(Stopped):  # pylint: disable=too-few-public-methods
@@ -582,7 +582,7 @@ def key_description_str(value):
                 clevis_str(sp.clevis_info),
             )
             for pool_uuid, sp in (
-                (pool_uuid, StoppedPool(info))
+                (pool_uuid, StoppedPool(**info))
                 for pool_uuid, info in stopped_pools.items()
             )
         ]

src/stratis_cli/_actions/_utils.py

@@ -18,8 +18,12 @@
 
 # isort: STDLIB
 import json
+from typing import List, Optional
 from uuid import UUID
 
+# isort: THIRDPARTY
+from pydantic import BaseModel, validator
+
 from .._constants import Clevis
 from .._stratisd_constants import (
     CLEVIS_KEY_TANG_TRUST_URL,
@@ -141,43 +145,41 @@ def __init__(self, info):
                 self.value = str(value)
 
 
-class Device:  # pylint: disable=too-few-public-methods
+class Device(BaseModel):
     """
     A representation of a device in a stopped pool.
     """
 
-    def __init__(self, mapping):
-        self.uuid = UUID(mapping["uuid"])
-        self.devnode = str(mapping["devnode"])
+    uuid: UUID
+    devnode: str
 
 
-class StoppedPool:  # pylint: disable=too-few-public-methods
+class StoppedPool(BaseModel):
     """
-    A representation of a single stopped pool.
+    A representaton of a single stopped pool.
     """
 
-    def __init__(self, pool_info):
+    devs: List[Device]
+    clevis_info: Optional[EncryptionInfoClevis]
+    key_description: Optional[EncryptionInfoKeyDescription]
+    name: Optional[str]
+
+    @validator("key_description", allow_reuse=True)
+    def validate_key_description(cls, v):  # pylint: disable=no-self-argument
         """
-        Initializer.
-        :param pool_info: a D-Bus structure
+        Validate the key description.
         """
+        return EncryptionInfoKeyDescription(v)
 
-        self.devs = [Device(info) for info in pool_info["devs"]]
-
-        clevis_info = pool_info.get("clevis_info")
-        self.clevis_info = (
-            None if clevis_info is None else EncryptionInfoClevis(clevis_info)
-        )
-
-        key_description = pool_info.get("key_description")
-        self.key_description = (
-            None
-            if key_description is None
-            else EncryptionInfoKeyDescription(key_description)
-        )
+    @validator("clevis_info", allow_reuse=True)
+    def validate_clevis_info(cls, v):  # pylint: disable=no-self-argument
+        """
+        Validate the Clevis info.
+        """
+        return EncryptionInfoClevis(v)
 
-        name = pool_info.get("name")
-        self.name = None if name is None else str(name)
+    class Config:  # pylint: disable=too-few-public-methods,missing-docstring
+        arbitrary_types_allowed = True
 
 
 class PoolSelector: