Add TextContent Class

Author: dahbar

polarion_rest_api_client/base_client.py

@@ -9,7 +9,6 @@
 from polarion_rest_api_client import data_models as dm
 
 WorkItemType = t.TypeVar("WorkItemType", bound=dm.WorkItem)
-DocumentType = t.TypeVar("DocumentType", bound=dm.Document)
 
 
 class DefaultFields:

polarion_rest_api_client/client.py

@@ -687,24 +687,47 @@ def get_document(
             if not getattr(data.meta, "errors", []):
                 assert (attributes := data.attributes)
                 assert isinstance(data.id, str)
+                home_page_content = self._handle_home_page_content(
+                    attributes.home_page_content
+                )
 
                 document: dm.Document = dm.Document(
                     id=data.id,
                     module_folder=unset_str_builder(attributes.module_folder),
                     module_name=unset_str_builder(attributes.module_name),
                     type=unset_str_builder(attributes.type),
                     status=unset_str_builder(attributes.status),
-                    home_page_content={
-                        "type": attributes.home_page_content.type,
-                        "value": attributes.home_page_content.value,
-                    }
-                    if not isinstance(
-                        attributes.home_page_content, oa_types.Unset
-                    )
-                    else None,
+                    home_page_content=home_page_content,
                 )
         return document
 
+    def _handle_home_page_content(self, home_page_content):
+        home_page_content_type = None
+        home_page_content_value = None
+
+        if not isinstance(home_page_content, oa_types.Unset):
+            if isinstance(
+                home_page_content.type,
+                api_models.DocumentsSingleGetResponseDataAttributesHomePageContentType,
+            ):
+                home_page_content_type = str(home_page_content.type)
+            elif isinstance(home_page_content.type, oa_types.Unset):
+                home_page_content_type = None
+
+            if isinstance(home_page_content.value, str):
+                home_page_content_value = home_page_content.value
+            elif isinstance(home_page_content.value, oa_types.Unset):
+                home_page_content_value = None
+
+            home_page_content = dm.TextContent(
+                type=home_page_content_type,
+                value=home_page_content_value,
+            )
+        else:
+            home_page_content = None
+
+        return home_page_content
+
     def create_work_items(self, work_items: list[base_client.WorkItemType]):
         """Create the given list of work items."""
         current_batch = api_models.WorkitemsListPostRequest([])

polarion_rest_api_client/data_models.py

@@ -147,7 +147,7 @@ class Document(BaseItem):
 
     module_folder: str | None = None
     module_name: str | None = None
-    home_page_content: dict | None = None
+    home_page_content: TextContent | None = None
 
     def __init__(
         self,
@@ -156,9 +156,24 @@ def __init__(
         module_name: str | None = None,
         type: str | None = None,
         status: str | None = None,
-        home_page_content: dict | None = None,
+        home_page_content: TextContent | None = None,
     ):
         super().__init__(id, type, status)
         self.module_folder = module_folder
         self.module_name = module_name
         self.home_page_content = home_page_content
+
+
+class TextContent:
+    """A data class for home_page_content of a Polarion Document."""
+
+    type: str | None = None
+    value: str | None = None
+
+    def __init__(
+        self,
+        type: str | None = None,
+        value: str | None = None,
+    ):
+        self.type = type
+        self.value = value

tests/test_client_documents.py

@@ -33,5 +33,7 @@ def test_get_document_with_all_fields(
         "MyDocumentName",
         "standardSpecification",
         "open",
-        {"type": "text/html", "value": "<h1>My text value</h1>"},
+        polarion_api.data_models.TextContent(
+            type="text/html", value="<h1>My text value</h1>"
+        ),
     )