add pydantic to mypy and fix resulting type issues

Author: Jens Kürten

.pre-commit-config.yaml

@@ -19,7 +19,8 @@ repos:
             [
                 types-mock,
                 types-requests,
-                types-PyYAML
+                types-PyYAML,
+                pydantic
             ]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0

csfunctions/events/dummy.py

@@ -17,8 +17,5 @@ class DummyEvent(BaseEvent):
     Dummy Event, for unit testing
     """
 
-    def __init__(self, event_id: str, data: DummyEventData, **_):
-        super().__init__(name=EventNames.DUMMY, event_id=event_id, data=data)
-
-    name: Literal[EventNames.DUMMY]
-    data: DummyEventData = Field([])
+    name: Literal[EventNames.DUMMY] = EventNames.DUMMY
+    data: DummyEventData = Field(..., description="Dummy Event Data")

csfunctions/events/workflow_task_trigger.py

@@ -18,8 +18,5 @@ class WorkflowTaskTriggerEventData(BaseModel):
 
 
 class WorkflowTaskTriggerEvent(BaseEvent):
-    def __init__(self, event_id: str, data: WorkflowTaskTriggerEventData, **_):
-        super().__init__(name=EventNames.WORKFLOW_TASK_TRIGGER, event_id=event_id, data=data)
-
-    name: Literal[EventNames.WORKFLOW_TASK_TRIGGER]
+    name: Literal[EventNames.WORKFLOW_TASK_TRIGGER] = EventNames.WORKFLOW_TASK_TRIGGER
     data: WorkflowTaskTriggerEventData

csfunctions/handler.py

@@ -6,11 +6,11 @@
 from typing import Callable
 
 import yaml
-from pydantic import BaseModel
 
 from csfunctions import ErrorResponse, Event, Request, WorkloadResponse
 from csfunctions.actions import ActionUnion
 from csfunctions.config import ConfigModel, FunctionModel
+from csfunctions.events import EventData
 from csfunctions.objects import BaseObject
 from csfunctions.response import ResponseUnion
 from csfunctions.service import Service
@@ -53,7 +53,7 @@ def link_objects(event: Event):
     e.g. document.part
     """
     data = getattr(event, "data", None)
-    if not isinstance(data, BaseModel):
+    if data is None or not isinstance(data, EventData):  # type: ignore  # MyPy doesn't like PEP604
         return
 
     # we expect all objects to be passed in Event.data

csfunctions/objects/classification.py

@@ -16,11 +16,11 @@ class ObjectPropertyValue(BaseObject):
     ref_object_id: str = Field(..., description="Referenced Object")
     boolean_value: int | None = Field(..., description="Boolean Value")
     datetime_value: datetime | None = Field(..., description="Datetime Value")
-    float_value: float | None = Field("", description="Float Value")
-    float_value_normalized: float | None = Field("", description="Float Value Normalized")
-    integer_value: int | None = Field("", description="Integer Value")
+    float_value: float | None = Field(None, description="Float Value")
+    float_value_normalized: float | None = Field(None, description="Float Value Normalized")
+    integer_value: int | None = Field(None, description="Integer Value")
     iso_language_code: str | None = Field(None, description="ISO Language Code")
-    value_pos: int | None = Field("", description="Position")
+    value_pos: int | None = Field(None, description="Position")
     property_code: str | None = Field("", description="Property Code")
     property_path: str | None = Field(None, description="Property Path")
     property_type: str | None = Field(None, description="Property Type")

json_schemas/request.json

@@ -897,6 +897,7 @@
       "properties": {
         "name": {
           "const": "dummy",
+          "default": "dummy",
           "enum": [
             "dummy"
           ],
@@ -914,12 +915,12 @@
               "$ref": "#/$defs/DummyEventData"
             }
           ],
-          "default": []
+          "description": "Dummy Event Data"
         }
       },
       "required": [
-        "name",
-        "event_id"
+        "event_id",
+        "data"
       ],
       "title": "DummyEvent",
       "type": "object"
@@ -2718,6 +2719,7 @@
       "properties": {
         "name": {
           "const": "workflow_task_trigger",
+          "default": "workflow_task_trigger",
           "enum": [
             "workflow_task_trigger"
           ],
@@ -2734,7 +2736,6 @@
         }
       },
       "required": [
-        "name",
         "event_id",
         "data"
       ],

tests/utils.py

@@ -36,8 +36,8 @@ def action_list_function(*args, **kwargs):  # pylint: disable=unused-argument
     return [AbortAndShowErrorAction(message="Testerror"), AbortAndShowErrorAction(message="Testerror")]
 
 
-dummy_document = Document(
-    **{
+dummy_document = Document.model_validate(
+    {
         "object_type": "document",
         "z_nummer": "D000017",
         "z_index": "a",
@@ -87,8 +87,8 @@ def action_list_function(*args, **kwargs):  # pylint: disable=unused-argument
     }
 )
 
-dummy_part = Part(
-    **{
+dummy_part = Part.model_validate(
+    {
         "object_type": "part",
         "teilenummer": "000000",
         "t_index": "a",
@@ -141,21 +141,25 @@ def action_list_function(*args, **kwargs):  # pylint: disable=unused-argument
 )
 
 dummy_request = Request(
-    metadata=MetaData(
-        request_id="123",
-        app_lang="de",
-        app_user="caddok",
-        request_datetime=datetime(2000, 1, 1),
-        transaction_id="123asd",
-        instance_url="https://instance.contact-cloud.com",
-        service_url=None,
+    metadata=MetaData.model_validate(
+        {
+            "request_id": "123",
+            "app_lang": "de",
+            "app_user": "caddok",
+            "request_datetime": datetime(2000, 1, 1),
+            "transaction_id": "123asd",
+            "instance_url": "https://instance.contact-cloud.com",
+            "service_url": None,
+            "service_token": "123",
+            "db_service_url": None,
+        }
     ),
     event=DummyEvent(event_id="42", data=DummyEventData(documents=[dummy_document], parts=[dummy_part])),
 )
 
 
-dummy_ec = EngineeringChange(
-    **{
+dummy_ec = EngineeringChange.model_validate(
+    {
         "object_type": "engineering_change",
         "cdb_ec_id": "EC00000005",
         "cdb_project_id": "",