Skip to content

Commit 98aa0b8

Browse files
author
Jens Kürten
committed
rename events
1 parent 9184016 commit 98aa0b8

File tree

13 files changed

+201
-193
lines changed

13 files changed

+201
-193
lines changed

‎csfunctions/events/__init__.py‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,35 @@
22

33
from pydantic import Field
44

5-
from .dialog_data import DocumentReleaseDialogData, PartReleaseDialogData
5+
from .dialog_data import DocumentReleasedDialogData, PartReleasedDialogData
66
from .document_create_check import DocumentCreateCheckData, DocumentCreateCheckEvent
77
from .document_field_calculation import DocumentFieldCalculationData, DocumentFieldCalculationEvent
88
from .document_modify_check import DocumentModifyCheckData, DocumentModifyCheckEvent
9-
from .document_release import DocumentReleaseData, DocumentReleaseEvent
109
from .document_release_check import DocumentReleaseCheckData, DocumentReleaseCheckEvent
10+
from .document_released import DocumentReleasedData, DocumentReleasedEvent
1111
from .dummy import DummyEvent, DummyEventData
12-
from .engineering_change_release import EngineeringChangeRelease, EngineeringChangeReleaseData
13-
from .engineering_change_release_check import EngineeringChangeReleaseCheck, EngineeringChangeReleaseCheckData
12+
from .engineering_change_release_check import EngineeringChangeReleaseCheckData, EngineeringChangeReleaseCheckEvent
13+
from .engineering_change_released import EngineeringChangeReleasedData, EngineeringChangeReleasedEvent
1414
from .field_value_calculation import FieldValueCalculationData, FieldValueCalculationEvent
1515
from .part_create_check import PartCreateCheckData, PartCreateCheckEvent
1616
from .part_field_calculation import PartFieldCalculationData, PartFieldCalculationEvent
1717
from .part_modify_check import PartModifyCheckData, PartModifyCheckEvent
18-
from .part_release import PartReleaseData, PartReleaseEvent
1918
from .part_release_check import PartReleaseCheckData, PartReleaseCheckEvent
19+
from .part_released import PartReleasedData, PartReleasedEvent
2020
from .workflow_task_trigger import WorkflowTaskTriggerEvent, WorkflowTaskTriggerEventData
2121

2222
Event = Annotated[
2323
Union[
24-
DocumentReleaseEvent,
24+
DocumentReleasedEvent,
2525
DocumentReleaseCheckEvent,
2626
DocumentFieldCalculationEvent,
27-
PartReleaseEvent,
27+
PartReleasedEvent,
2828
PartReleaseCheckEvent,
2929
PartFieldCalculationEvent,
3030
FieldValueCalculationEvent,
3131
DummyEvent,
32-
EngineeringChangeRelease,
33-
EngineeringChangeReleaseCheck,
32+
EngineeringChangeReleasedEvent,
33+
EngineeringChangeReleaseCheckEvent,
3434
WorkflowTaskTriggerEvent,
3535
DocumentCreateCheckEvent,
3636
DocumentModifyCheckEvent,
@@ -40,15 +40,15 @@
4040
Field(discriminator="name"),
4141
]
4242
EventData = Union[
43-
DocumentReleaseData,
43+
DocumentReleasedData,
4444
DocumentReleaseCheckData,
4545
DocumentFieldCalculationData,
46-
PartReleaseData,
46+
PartReleasedData,
4747
PartReleaseCheckData,
4848
PartFieldCalculationData,
4949
FieldValueCalculationData,
5050
DummyEventData,
51-
EngineeringChangeReleaseData,
51+
EngineeringChangeReleasedData,
5252
EngineeringChangeReleaseCheckData,
5353
WorkflowTaskTriggerEventData,
5454
DocumentCreateCheckData,
@@ -58,29 +58,29 @@
5858
]
5959

6060
__all__ = [
61-
"DocumentReleaseEvent",
61+
"DocumentReleasedEvent",
6262
"DocumentReleaseCheckEvent",
6363
"DocumentFieldCalculationEvent",
64-
"PartReleaseEvent",
64+
"PartReleasedEvent",
6565
"PartReleaseCheckEvent",
6666
"PartFieldCalculationEvent",
6767
"FieldValueCalculationEvent",
6868
"DummyEvent",
69-
"EngineeringChangeRelease",
70-
"EngineeringChangeReleaseCheck",
69+
"EngineeringChangeReleasedEvent",
70+
"EngineeringChangeReleaseCheckEvent",
7171
"WorkflowTaskTriggerEvent",
72-
"DocumentReleaseData",
72+
"DocumentReleasedData",
7373
"DocumentReleaseCheckData",
7474
"DocumentFieldCalculationData",
75-
"PartReleaseData",
75+
"PartReleasedData",
7676
"PartReleaseCheckData",
7777
"FieldValueCalculationData",
7878
"DummyEventData",
79-
"EngineeringChangeReleaseData",
79+
"EngineeringChangeReleasedData",
8080
"EngineeringChangeReleaseCheckData",
8181
"WorkflowTaskTriggerEventData",
82-
"DocumentReleaseDialogData",
83-
"PartReleaseDialogData",
82+
"DocumentReleasedDialogData",
83+
"PartReleasedDialogData",
8484
"PartFieldCalculationData",
8585
"DocumentCreateCheckData",
8686
"DocumentCreateCheckEvent",

‎csfunctions/events/base.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55

66
class EventNames(str, Enum):
77
DUMMY = "dummy"
8-
DOCUMENT_RELEASE = "document_release"
8+
DOCUMENT_RELEASED = "document_released"
99
DOCUMENT_RELEASE_CHECK = "document_release_check"
1010
DOCUMENT_FIELD_CALCULATION = "document_field_calculation"
11-
PART_RELEASE = "part_release"
11+
PART_RELEASED = "part_released"
1212
PART_RELEASE_CHECK = "part_release_check"
1313
PART_FIELD_CALCULATION = "part_field_calculation"
14-
ENGINEERING_CHANGE_RELEASE = "engineering_change_release"
14+
ENGINEERING_CHANGE_RELEASED = "engineering_change_released"
1515
ENGINEERING_CHANGE_RELEASE_CHECK = "engineering_change_release_check"
1616
FIELD_VALUE_CALCULATION = "field_value_calculation"
1717
WORKFLOW_TASK_TRIGGER = "workflow_task_trigger"

‎csfunctions/events/dialog_data.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
from pydantic import BaseModel, Field
44

55

6-
class DocumentReleaseDialogData(BaseModel):
6+
class DocumentReleasedDialogData(BaseModel):
77
dialog_type: Literal["document_release"] = "document_release"
88
cdbprot_remark: str | None = Field(None, description="remark")
99
cdb_ec_id: str | None = Field(None, description="Engineering Change ID")
1010

1111

12-
class PartReleaseDialogData(BaseModel):
12+
class PartReleasedDialogData(BaseModel):
1313
dialog_type: Literal["part_release"] = "part_release"
1414
cdbprot_remark: str | None = Field("", description="remark")
1515
cdb_ec_id: str | None = Field("", description="Engineering Change ID")

‎csfunctions/events/document_release_check.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
from csfunctions.objects import Document, Part
66

77
from .base import BaseEvent, EventNames
8-
from .dialog_data import DocumentReleaseDialogData
8+
from .dialog_data import DocumentReleasedDialogData
99

1010

1111
class DocumentReleaseCheckData(BaseModel):
1212
documents: list[Document] = Field(..., description="List of documents that will be released.")
1313
attached_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
14-
dialog_data: DocumentReleaseDialogData
14+
dialog_data: DocumentReleasedDialogData
1515

1616

1717
class DocumentReleaseCheckEvent(BaseEvent):

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
from csfunctions.objects import Document, Part
66

77
from .base import BaseEvent, EventNames
8-
from .dialog_data import DocumentReleaseDialogData
8+
from .dialog_data import DocumentReleasedDialogData
99

1010

11-
class DocumentReleaseData(BaseModel):
11+
class DocumentReleasedData(BaseModel):
1212
documents: list[Document] = Field(..., description="List of documents that were released.")
1313
parts: list[Part] = Field(..., description="List of parts that belong to the released documents")
14-
dialog_data: DocumentReleaseDialogData
14+
dialog_data: DocumentReleasedDialogData
1515

1616

17-
class DocumentReleaseEvent(BaseEvent):
18-
name: Literal[EventNames.DOCUMENT_RELEASE] = EventNames.DOCUMENT_RELEASE
19-
data: DocumentReleaseData
17+
class DocumentReleasedEvent(BaseEvent):
18+
name: Literal[EventNames.DOCUMENT_RELEASED] = EventNames.DOCUMENT_RELEASED
19+
data: DocumentReleasedData

‎csfunctions/events/engineering_change_release_check.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ class EngineeringChangeReleaseCheckData(BaseModel):
1515
)
1616

1717

18-
class EngineeringChangeReleaseCheck(BaseEvent):
18+
class EngineeringChangeReleaseCheckEvent(BaseEvent):
1919
name: Literal[EventNames.ENGINEERING_CHANGE_RELEASE_CHECK] = EventNames.ENGINEERING_CHANGE_RELEASE_CHECK
2020
data: EngineeringChangeReleaseCheckData

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
from .base import BaseEvent, EventNames
88

99

10-
class EngineeringChangeReleaseData(BaseModel):
10+
class EngineeringChangeReleasedData(BaseModel):
1111
documents: list[Document] = Field(..., description="List of included documents.")
1212
parts: list[Part] = Field(..., description="List of included parts.")
1313
engineering_changes: list[EngineeringChange] = Field(
1414
..., description="List of engineering changes that were released."
1515
)
1616

1717

18-
class EngineeringChangeRelease(BaseEvent):
19-
name: Literal[EventNames.ENGINEERING_CHANGE_RELEASE] = EventNames.ENGINEERING_CHANGE_RELEASE
20-
data: EngineeringChangeReleaseData
18+
class EngineeringChangeReleasedEvent(BaseEvent):
19+
name: Literal[EventNames.ENGINEERING_CHANGE_RELEASED] = EventNames.ENGINEERING_CHANGE_RELEASED
20+
data: EngineeringChangeReleasedData

‎csfunctions/events/part_release_check.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
from csfunctions.objects import Document, Part
66

77
from .base import BaseEvent, EventNames
8-
from .dialog_data import PartReleaseDialogData
8+
from .dialog_data import PartReleasedDialogData
99

1010

1111
class PartReleaseCheckData(BaseModel):
1212
parts: list[Part] = Field(..., description="List of parts that will be released.")
1313
attached_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
14-
dialog_data: PartReleaseDialogData
14+
dialog_data: PartReleasedDialogData
1515

1616

1717
class PartReleaseCheckEvent(BaseEvent):

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
from csfunctions.objects import Document, Part
66

77
from .base import BaseEvent, EventNames
8-
from .dialog_data import PartReleaseDialogData
8+
from .dialog_data import PartReleasedDialogData
99

1010

11-
class PartReleaseData(BaseModel):
11+
class PartReleasedData(BaseModel):
1212
parts: list[Part] = Field(..., description="List if parts that were released.")
1313
documents: list[Document] = Field(..., description="List if documents that are referenced by the released part.")
14-
dialog_data: PartReleaseDialogData
14+
dialog_data: PartReleasedDialogData
1515

1616

17-
class PartReleaseEvent(BaseEvent):
18-
name: Literal[EventNames.PART_RELEASE] = EventNames.PART_RELEASE
19-
data: PartReleaseData
17+
class PartReleasedEvent(BaseEvent):
18+
name: Literal[EventNames.PART_RELEASED] = EventNames.PART_RELEASED
19+
data: PartReleasedData

‎docs/reference/events.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,22 +67,22 @@ Be aware that the document is not released yet and the release might still be ab
6767
|cdbprot_remark|str \| None | Remark|
6868
|cdb_ec_id|str \| None| Engineering Change ID|
6969

70-
## DocumentReleaseEvent
71-
`csfunctions.events.DocumentReleaseEvent`
70+
## DocumentReleasedEvent
71+
`csfunctions.events.DocumentReleasedEvent`
7272

7373
This event is fired **after** a document has been released. Raising an exception thus can not prevent the release.
7474

75-
**DocumentReleaseEvent.name:** document_release
75+
**DocumentReleasedEvent.name:** document_released
7676

77-
**DocumentReleaseEvent.data:**
77+
**DocumentReleasedEvent.data:**
7878

7979
|Attribute|Type|Description|
8080
|-|-|-|
8181
|documents| list[[Document](objects.md#document)]|List of documents that were released.|
8282
|parts| list[[Part](objects.md#part)]|List of parts that belong to the released documents.|
8383
|dialog_data|DocumentReleaseDialogData|Contents of the dialog.|
8484

85-
**DocumentReleaseDialogData:**
85+
**DocumentReleasedDialogData:**
8686

8787
|Attribute|Type|Description|
8888
|-|-|-|
@@ -131,14 +131,14 @@ Be aware that the engineering change is not released yet and the release might s
131131
|attached_parts| list[[Part](objects.md#part)]|List of included parts.|
132132

133133

134-
## EngineeringChangeRelease
135-
`csfunctions.events.EngineeringChangeRelease`
134+
## EngineeringChangeReleasedEvent
135+
`csfunctions.events.EngineeringChangeReleasedEvent`
136136

137137
This event is fired **after** an engineering change has been released. Raising an exception thus can not prevent the release.
138138

139-
**EngineeringChangeRelease.name:** engineering_change_release
139+
**EngineeringChangeReleasedEvent.name:** engineering_change_released
140140

141-
**EngineeringChangeRelease.data:**
141+
**EngineeringChangeReleasedEvent.data:**
142142

143143
|Attribute|Type|Description|
144144
|-|-|-|
@@ -212,22 +212,22 @@ Be aware that the part is not released yet and the release might still be aborte
212212
|cdb_ec_id|str \| None| Engineering Change ID|
213213

214214

215-
## PartReleaseEvent
216-
`csfunctions.events.PartReleaseEvent`
215+
## PartReleasedEvent
216+
`csfunctions.events.PartReleasedEvent`
217217

218218
This event is fired **after** a part has been released. Raising an exception thus can not prevent the release.
219219

220-
**PartReleaseEvent.name:** part_release
220+
**PartReleasedEvent.name:** part_released
221221

222-
**PartReleaseEvent.data:**
222+
**PartReleasedEvent.data:**
223223

224224
|Attribute|Type|Description|
225225
|-|-|-|
226226
|parts| list[[Part](objects.md#part)]|List of parts that were released.|
227227
|documents| list[[Document](objects.md#document)]|List of documents that belong to the released parts.|
228-
|dialog_data|PartReleaseDialogData|Contents of the dialog.|
228+
|dialog_data|PartReleasedDialogData|Contents of the dialog.|
229229

230-
**PartReleaseDialogData:**
230+
**PartReleasedDialogData:**
231231

232232
|Attribute|Type|Description|
233233
|-|-|-|

0 commit comments

Comments
 (0)