Merge branch 'main' of github.com:cslab/functions-sdk-python into ec_status_changeevent

Author: Jens Kürten

csfunctions/devserver.py

@@ -35,7 +35,6 @@
 import os
 import time
 from collections.abc import Iterable
-from wsgiref.types import StartResponse, WSGIEnvironment
 
 from werkzeug.serving import run_simple
 from werkzeug.wrappers import Request, Response
@@ -128,7 +127,7 @@ def handle_request(request: Request) -> Response:
     return Response(response, content_type="application/json")
 
 
-def application(environ: WSGIEnvironment, start_response: StartResponse) -> Iterable[bytes]:
+def application(environ, start_response) -> Iterable[bytes]:
     request = Request(environ)
     response = handle_request(request)
     return response(environ, start_response)

csfunctions/events/__init__.py

@@ -2,15 +2,15 @@
 
 from pydantic import Field
 
-from .dialog_data import DocumentReleaseDialogData, PartReleaseDialogData
+from .dialog_data import DocumentReleasedDialogData, PartReleasedDialogData
 from .document_create_check import DocumentCreateCheckData, DocumentCreateCheckEvent
 from .document_field_calculation import DocumentFieldCalculationData, DocumentFieldCalculationEvent
 from .document_modify_check import DocumentModifyCheckData, DocumentModifyCheckEvent
-from .document_release import DocumentReleaseData, DocumentReleaseEvent
 from .document_release_check import DocumentReleaseCheckData, DocumentReleaseCheckEvent
+from .document_released import DocumentReleasedData, DocumentReleasedEvent
 from .dummy import DummyEvent, DummyEventData
-from .engineering_change_release import EngineeringChangeRelease, EngineeringChangeReleaseData
-from .engineering_change_release_check import EngineeringChangeReleaseCheck, EngineeringChangeReleaseCheckData
+from .engineering_change_release_check import EngineeringChangeReleaseCheckData, EngineeringChangeReleaseCheckEvent
+from .engineering_change_released import EngineeringChangeReleasedData, EngineeringChangeReleasedEvent
 from .engineering_change_status_change_check import (
     EngineeringChangeStatusChangeCheck,
     EngineeringChangeStatusChangeCheckData,
@@ -20,22 +20,22 @@
 from .part_create_check import PartCreateCheckData, PartCreateCheckEvent
 from .part_field_calculation import PartFieldCalculationData, PartFieldCalculationEvent
 from .part_modify_check import PartModifyCheckData, PartModifyCheckEvent
-from .part_release import PartReleaseData, PartReleaseEvent
 from .part_release_check import PartReleaseCheckData, PartReleaseCheckEvent
+from .part_released import PartReleasedData, PartReleasedEvent
 from .workflow_task_trigger import WorkflowTaskTriggerEvent, WorkflowTaskTriggerEventData
 
 Event = Annotated[
     Union[
-        DocumentReleaseEvent,
+        DocumentReleasedEvent,
         DocumentReleaseCheckEvent,
         DocumentFieldCalculationEvent,
-        PartReleaseEvent,
+        PartReleasedEvent,
         PartReleaseCheckEvent,
         PartFieldCalculationEvent,
         FieldValueCalculationEvent,
         DummyEvent,
-        EngineeringChangeRelease,
-        EngineeringChangeReleaseCheck,
+        EngineeringChangeReleasedEvent,
+        EngineeringChangeReleaseCheckEvent,
         EngineeringChangeStatusChanged,
         EngineeringChangeStatusChangeCheck,
         WorkflowTaskTriggerEvent,
@@ -47,15 +47,15 @@
     Field(discriminator="name"),
 ]
 EventData = Union[
-    DocumentReleaseData,
+    DocumentReleasedData,
     DocumentReleaseCheckData,
     DocumentFieldCalculationData,
-    PartReleaseData,
+    PartReleasedData,
     PartReleaseCheckData,
     PartFieldCalculationData,
     FieldValueCalculationData,
     DummyEventData,
-    EngineeringChangeReleaseData,
+    EngineeringChangeReleasedData,
     EngineeringChangeReleaseCheckData,
     EngineeringChangeStatusChangedData,
     EngineeringChangeStatusChangeCheckData,
@@ -67,33 +67,31 @@
 ]
 
 __all__ = [
-    "DocumentReleaseEvent",
+    "DocumentReleasedEvent",
     "DocumentReleaseCheckEvent",
     "DocumentFieldCalculationEvent",
-    "PartReleaseEvent",
+    "PartReleasedEvent",
     "PartReleaseCheckEvent",
     "PartFieldCalculationEvent",
     "FieldValueCalculationEvent",
     "DummyEvent",
-    "EngineeringChangeRelease",
-    "EngineeringChangeReleaseCheck",
-    "EngineeringChangeStatusChanged",
-    "EngineeringChangeStatusChangeCheck",
+    "EngineeringChangeReleasedEvent",
+    "EngineeringChangeReleaseCheckEvent",
     "WorkflowTaskTriggerEvent",
-    "DocumentReleaseData",
+    "DocumentReleasedData",
     "DocumentReleaseCheckData",
     "DocumentFieldCalculationData",
-    "PartReleaseData",
+    "PartReleasedData",
     "PartReleaseCheckData",
     "FieldValueCalculationData",
     "DummyEventData",
-    "EngineeringChangeReleaseData",
+    "EngineeringChangeReleasedData",
     "EngineeringChangeReleaseCheckData",
     "EngineeringChangeStatusChangedData",
     "EngineeringChangeStatusChangeCheckData",
     "WorkflowTaskTriggerEventData",
-    "DocumentReleaseDialogData",
-    "PartReleaseDialogData",
+    "DocumentReleasedDialogData",
+    "PartReleasedDialogData",
     "PartFieldCalculationData",
     "DocumentCreateCheckData",
     "DocumentCreateCheckEvent",

csfunctions/events/base.py

@@ -5,13 +5,13 @@
 
 class EventNames(str, Enum):
     DUMMY = "dummy"
-    DOCUMENT_RELEASE = "document_release"
+    DOCUMENT_RELEASED = "document_released"
     DOCUMENT_RELEASE_CHECK = "document_release_check"
     DOCUMENT_FIELD_CALCULATION = "document_field_calculation"
-    PART_RELEASE = "part_release"
+    PART_RELEASED = "part_released"
     PART_RELEASE_CHECK = "part_release_check"
     PART_FIELD_CALCULATION = "part_field_calculation"
-    ENGINEERING_CHANGE_RELEASE = "engineering_change_release"
+    ENGINEERING_CHANGE_RELEASED = "engineering_change_released"
     ENGINEERING_CHANGE_RELEASE_CHECK = "engineering_change_release_check"
     FIELD_VALUE_CALCULATION = "field_value_calculation"
     WORKFLOW_TASK_TRIGGER = "workflow_task_trigger"

csfunctions/events/dialog_data.py

@@ -3,13 +3,13 @@
 from pydantic import BaseModel, Field
 
 
-class DocumentReleaseDialogData(BaseModel):
+class DocumentReleasedDialogData(BaseModel):
     dialog_type: Literal["document_release"] = "document_release"
     cdbprot_remark: str | None = Field(None, description="remark")
     cdb_ec_id: str | None = Field(None, description="Engineering Change ID")
 
 
-class PartReleaseDialogData(BaseModel):
+class PartReleasedDialogData(BaseModel):
     dialog_type: Literal["part_release"] = "part_release"
     cdbprot_remark: str | None = Field("", description="remark")
     cdb_ec_id: str | None = Field("", description="Engineering Change ID")

csfunctions/events/document_create_check.py

@@ -9,7 +9,7 @@
 
 class DocumentCreateCheckData(BaseModel):
     documents: list[Document] = Field(..., description="List of documents that are about to be created")
-    linked_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+    parts: list[Part] = Field(..., description="List of parts that belong to the documents")
 
 
 class DocumentCreateCheckEvent(BaseEvent):

csfunctions/events/document_field_calculation.py

@@ -10,7 +10,7 @@
 class DocumentFieldCalculationData(BaseModel):
     document: Document = Field(..., description="Current state of the document")
     action: Literal["create", "modify", "copy", "index"] = Field(..., description="Action being performed")
-    linked_parts: list[Part] = Field(..., description="Parts that belong to the document")
+    parts: list[Part] = Field(..., description="Parts that belong to the document")
 
 
 class DocumentFieldCalculationEvent(BaseEvent):

csfunctions/events/document_modify_check.py

@@ -9,7 +9,7 @@
 
 class DocumentModifyCheckData(BaseModel):
     documents: list[Document] = Field(..., description="List of documents that are about to be modified")
-    linked_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+    parts: list[Part] = Field(..., description="List of parts that belong to the documents")
 
 
 class DocumentModifyCheckEvent(BaseEvent):

csfunctions/events/document_release_check.py

@@ -5,13 +5,13 @@
 from csfunctions.objects import Document, Part
 
 from .base import BaseEvent, EventNames
-from .dialog_data import DocumentReleaseDialogData
+from .dialog_data import DocumentReleasedDialogData
 
 
 class DocumentReleaseCheckData(BaseModel):
     documents: list[Document] = Field(..., description="List of documents that will be released.")
-    attached_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
-    dialog_data: DocumentReleaseDialogData
+    parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+    dialog_data: DocumentReleasedDialogData
 
 
 class DocumentReleaseCheckEvent(BaseEvent):

csfunctions/events/document_release.py renamed to csfunctions/events/document_released.py

@@ -5,15 +5,15 @@
 from csfunctions.objects import Document, Part
 
 from .base import BaseEvent, EventNames
-from .dialog_data import DocumentReleaseDialogData
+from .dialog_data import DocumentReleasedDialogData
 
 
-class DocumentReleaseData(BaseModel):
+class DocumentReleasedData(BaseModel):
     documents: list[Document] = Field(..., description="List of documents that were released.")
     parts: list[Part] = Field(..., description="List of parts that belong to the released documents")
-    dialog_data: DocumentReleaseDialogData
+    dialog_data: DocumentReleasedDialogData
 
 
-class DocumentReleaseEvent(BaseEvent):
-    name: Literal[EventNames.DOCUMENT_RELEASE] = EventNames.DOCUMENT_RELEASE
-    data: DocumentReleaseData
+class DocumentReleasedEvent(BaseEvent):
+    name: Literal[EventNames.DOCUMENT_RELEASED] = EventNames.DOCUMENT_RELEASED
+    data: DocumentReleasedData

csfunctions/events/engineering_change_release_check.py

@@ -8,13 +8,13 @@
 
 
 class EngineeringChangeReleaseCheckData(BaseModel):
-    attached_documents: list[Document] = Field(..., description="List of included documents.")
-    attached_parts: list[Part] = Field(..., description="List of included parts.")
+    documents: list[Document] = Field(..., description="List of included documents.")
+    parts: list[Part] = Field(..., description="List of included parts.")
     engineering_changes: list[EngineeringChange] = Field(
         ..., description="List of engineering changes that will be released."
     )
 
 
-class EngineeringChangeReleaseCheck(BaseEvent):
+class EngineeringChangeReleaseCheckEvent(BaseEvent):
     name: Literal[EventNames.ENGINEERING_CHANGE_RELEASE_CHECK] = EventNames.ENGINEERING_CHANGE_RELEASE_CHECK
     data: EngineeringChangeReleaseCheckData

csfunctions/events/engineering_change_release.py renamed to csfunctions/events/engineering_change_released.py

@@ -7,14 +7,14 @@
 from .base import BaseEvent, EventNames
 
 
-class EngineeringChangeReleaseData(BaseModel):
+class EngineeringChangeReleasedData(BaseModel):
     documents: list[Document] = Field(..., description="List of included documents.")
     parts: list[Part] = Field(..., description="List of included parts.")
     engineering_changes: list[EngineeringChange] = Field(
         ..., description="List of engineering changes that were released."
     )
 
 
-class EngineeringChangeRelease(BaseEvent):
-    name: Literal[EventNames.ENGINEERING_CHANGE_RELEASE] = EventNames.ENGINEERING_CHANGE_RELEASE
-    data: EngineeringChangeReleaseData
+class EngineeringChangeReleasedEvent(BaseEvent):
+    name: Literal[EventNames.ENGINEERING_CHANGE_RELEASED] = EventNames.ENGINEERING_CHANGE_RELEASED
+    data: EngineeringChangeReleasedData

csfunctions/events/part_create_check.py

@@ -9,7 +9,7 @@
 
 class PartCreateCheckData(BaseModel):
     parts: list[Part] = Field(..., description="List of parts that are about to be created")
-    linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
 
 
 class PartCreateCheckEvent(BaseEvent):

csfunctions/events/part_field_calculation.py

@@ -11,7 +11,7 @@ class PartFieldCalculationData(BaseModel):
     part: Part = Field(..., description="Current state of the part")
     action: Literal["create", "modify", "copy", "index"] = Field(..., description="Action being performed")
 
-    linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
 
 
 class PartFieldCalculationEvent(BaseEvent):

csfunctions/events/part_modify_check.py

@@ -9,7 +9,7 @@
 
 class PartModifyCheckData(BaseModel):
     parts: list[Part] = Field(..., description="List of parts that are about to be modified")
-    linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
 
 
 class PartModifyCheckEvent(BaseEvent):

csfunctions/events/part_release_check.py

@@ -5,13 +5,13 @@
 from csfunctions.objects import Document, Part
 
 from .base import BaseEvent, EventNames
-from .dialog_data import PartReleaseDialogData
+from .dialog_data import PartReleasedDialogData
 
 
 class PartReleaseCheckData(BaseModel):
     parts: list[Part] = Field(..., description="List of parts that will be released.")
-    attached_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
-    dialog_data: PartReleaseDialogData
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    dialog_data: PartReleasedDialogData
 
 
 class PartReleaseCheckEvent(BaseEvent):

csfunctions/events/part_release.py renamed to csfunctions/events/part_released.py

@@ -5,15 +5,15 @@
 from csfunctions.objects import Document, Part
 
 from .base import BaseEvent, EventNames
-from .dialog_data import PartReleaseDialogData
+from .dialog_data import PartReleasedDialogData
 
 
-class PartReleaseData(BaseModel):
+class PartReleasedData(BaseModel):
     parts: list[Part] = Field(..., description="List if parts that were released.")
     documents: list[Document] = Field(..., description="List if documents that are referenced by the released part.")
-    dialog_data: PartReleaseDialogData
+    dialog_data: PartReleasedDialogData
 
 
-class PartReleaseEvent(BaseEvent):
-    name: Literal[EventNames.PART_RELEASE] = EventNames.PART_RELEASE
-    data: PartReleaseData
+class PartReleasedEvent(BaseEvent):
+    name: Literal[EventNames.PART_RELEASED] = EventNames.PART_RELEASED
+    data: PartReleasedData

csfunctions/objects/document.py

@@ -1,4 +1,3 @@
-from contextlib import suppress
 from datetime import date, datetime
 from typing import TYPE_CHECKING, Literal, Optional
 
@@ -8,9 +7,7 @@
 
 from .base import BaseObject, ObjectType
 from .file import File
-
-with suppress(ImportError):
-    from .part import Part
+from .part import Part
 
 if TYPE_CHECKING:
     from csfunctions.events import EventData
@@ -99,3 +96,6 @@ class CADDocument(Document):
     """
 
     object_type: Literal[ObjectType.CAD_DOCUMENT] = ObjectType.CAD_DOCUMENT  # type: ignore[assignment]
+
+
+Part.model_rebuild()

csfunctions/objects/part.py

@@ -1,4 +1,3 @@
-from contextlib import suppress
 from datetime import date, datetime
 from typing import TYPE_CHECKING, Literal, Optional
 
@@ -11,7 +10,6 @@
 if TYPE_CHECKING:
     from csfunctions.events import EventData
 
-with suppress(ImportError):
     from .document import Document