fix: Pre-commit and Lint

Author: dahbar

polarion_rest_api_client/client.py

@@ -10,14 +10,15 @@
 import random
 import time
 import typing as t
-import urllib
+import urllib.parse
 
 from polarion_rest_api_client import base_client
 from polarion_rest_api_client import data_models as dm
 from polarion_rest_api_client import errors
 from polarion_rest_api_client.open_api_client import client as oa_client
 from polarion_rest_api_client.open_api_client import models as api_models
 from polarion_rest_api_client.open_api_client import types as oa_types
+from polarion_rest_api_client.open_api_client.api.documents import get_document
 from polarion_rest_api_client.open_api_client.api.linked_work_items import (
     delete_linked_work_items,
     get_linked_work_items,
@@ -36,7 +37,6 @@
     patch_work_item,
     post_work_items,
 )
-from polarion_rest_api_client.open_api_client.api.documents import get_document
 
 logger = logging.getLogger(__name__)
 
@@ -649,7 +649,7 @@ def get_document(
         include: str | None = None,
         revision: str | None = None,
         retry: bool = True,
-    ) -> base_client.DocumentType:
+    ) -> dm.Document:
         """Return the document with the given document_name and space_id."""
 
         if " " in space_id or " " in document_name:
@@ -688,7 +688,7 @@ def get_document(
                 assert (attributes := data.attributes)
                 assert isinstance(data.id, str)
 
-                document: base_client.DocumentType = dm.Document(
+                document: dm.Document = dm.Document(
                     id=data.id,
                     module_folder=unset_str_builder(attributes.module_folder),
                     module_name=unset_str_builder(attributes.module_name),

polarion_rest_api_client/data_models.py

@@ -10,6 +10,8 @@
 
 
 class BaseItem:
+    """A parent data class for WorkItem and Document."""
+
     id: str | None = None
     type: str | None = None
     status: str | None = None
@@ -37,7 +39,7 @@ def __eq__(self, other: object) -> bool:
 
         return self.get_current_checksum() == other.get_current_checksum()
 
-    def to_dict(self) -> dict[str, Any]:
+    def to_dict(self) -> dict[str, t.Any]:
         """Return the content of the BaseItem as dictionary."""
         return {
             "id": self.id,
@@ -72,7 +74,7 @@ class WorkItem(BaseItem):
     title: str | None = None
     description_type: str | None = None
     description: str | None = None
-    additional_attributes: dict[str, Any] = {}
+    additional_attributes: dict[str, t.Any] = {}
     linked_work_items: list[WorkItemLink] = []
     attachments: list[WorkItemAttachment] = []
 
@@ -84,7 +86,7 @@ def __init__(
         description: str | None = None,
         type: str | None = None,
         status: str | None = None,
-        additional_attributes: dict[str, Any] | None = None,
+        additional_attributes: dict[str, t.Any] | None = None,
         linked_work_items: list[WorkItemLink] | None = None,
         attachments: list[WorkItemAttachment] | None = None,
         **kwargs,
@@ -97,13 +99,13 @@ def __init__(
         self.linked_work_items = linked_work_items or []
         self.attachments = attachments or []
 
-    def __getattribute__(self, item: str) -> Any:
+    def __getattribute__(self, item: str) -> t.Any:
         """Return all non WorkItem attributes from additional_properties."""
         if item.startswith("__") or item in dir(WorkItem):
             return super().__getattribute__(item)
         return self.additional_attributes.get(item)
 
-    def __setattr__(self, key: str, value: Any):
+    def __setattr__(self, key: str, value: t.Any):
         """Set all non WorkItem attributes in additional_properties."""
         if key in dir(WorkItem):
             super().__setattr__(key, value)
@@ -141,6 +143,8 @@ class WorkItemAttachment:
 
 
 class Document(BaseItem):
+    """A data class containing all relevant data of a Polarion Document."""
+
     module_folder: str | None = None
     module_name: str | None = None
     home_page_content: dict | None = None

tests/data/mock_api_responses/get_document.json

@@ -33,4 +33,4 @@
     "links": {
         "self": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentName"
     }
-}
+}

tests/test_client_documents.py

@@ -8,7 +8,7 @@
 import pytest_httpx
 
 import polarion_rest_api_client as polarion_api
-from polarion_rest_api_client.open_api_client import models as api_models
+from polarion_rest_api_client import data_models as dm
 from tests import TEST_DOCUMENT_RESPONSE
 
 
@@ -19,7 +19,7 @@ def test_get_document_with_all_fields(
     with open(TEST_DOCUMENT_RESPONSE, encoding="utf8") as f:
         httpx_mock.add_response(json=json.load(f))
 
-    document = client.get_document(
+    document: dm.Document = client.get_document(
         "MySpaceId", "MyDocumentName", {"fields[documents]": "@all"}
     )