src.fairreckitlib.core.events.event_args

This module contains the base event arguments dataclasses.

Classes:

EventArgs: base event args for all events.
MessageEventArgs: event args that has a message.

This program has been developed by students from the bachelor Computer Science at Utrecht University within the Software Project course. © Copyright Utrecht University (Department of Information and Computing Sciences)

 1"""This module contains the base event arguments dataclasses.
 2
 3Classes:
 4
 5    EventArgs: base event args for all events.
 6    MessageEventArgs: event args that has a message.
 7
 8This program has been developed by students from the bachelor Computer Science at
 9Utrecht University within the Software Project course.
10© Copyright Utrecht University (Department of Information and Computing Sciences)
11"""
12
13from dataclasses import dataclass
14
15
16@dataclass
17class EventArgs:
18    """Base Event Arguments.
19
20    Event arguments classes are allowed to be shared for different event ids.
21
22    event_id: the unique ID that classifies the event.
23    """
24
25    event_id: str
26
27@dataclass
28class MessageEventArgs(EventArgs):
29    """Message Event Arguments.
30
31    event_id: the unique ID that classifies the message event.
32    message: the message.
33    """
34
35    message: str
@dataclass
class EventArgs:
17@dataclass
18class EventArgs:
19    """Base Event Arguments.
20
21    Event arguments classes are allowed to be shared for different event ids.
22
23    event_id: the unique ID that classifies the event.
24    """
25
26    event_id: str

Base Event Arguments.

Event arguments classes are allowed to be shared for different event ids.

event_id: the unique ID that classifies the event.

EventArgs(event_id: str)
@dataclass
class MessageEventArgs(EventArgs):
28@dataclass
29class MessageEventArgs(EventArgs):
30    """Message Event Arguments.
31
32    event_id: the unique ID that classifies the message event.
33    message: the message.
34    """
35
36    message: str

Message Event Arguments.

event_id: the unique ID that classifies the message event. message: the message.

MessageEventArgs(event_id: str, message: str)