Skip to content

Base event

BaseEvent

Bases: ABC

Source code in griptape/griptape/events/base_event.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@define
class BaseEvent(ABC):
    timestamp: float = field(default=Factory(lambda: time.time()), kw_only=True)
    type: str = field(default=Factory(lambda self: self.__class__.__name__, takes_self=True), kw_only=True)

    @classmethod
    def from_dict(cls, event_dict: dict) -> BaseEvent:
        from griptape.schemas import (
            StartPromptEventSchema,
            FinishPromptEventSchema,
            StartTaskEventSchema,
            FinishTaskEventSchema,
            StartActionSubtaskEventSchema,
            FinishActionSubtaskEventSchema,
            StartStructureRunEventSchema,
            FinishStructureRunEventSchema,
            CompletionChunkEventSchema,
        )

        class_registry.register("StartPromptEvent", StartPromptEventSchema)
        class_registry.register("FinishPromptEvent", FinishPromptEventSchema)
        class_registry.register("StartTaskEvent", StartTaskEventSchema)
        class_registry.register("FinishTaskEvent", FinishTaskEventSchema)
        class_registry.register("StartActionSubtaskEvent", StartActionSubtaskEventSchema)
        class_registry.register("FinishActionSubtaskEvent", FinishActionSubtaskEventSchema)
        class_registry.register("StartStructureRunEvent", StartStructureRunEventSchema)
        class_registry.register("FinishStructureRunEvent", FinishStructureRunEventSchema)
        class_registry.register("CompletionChunkEvent", CompletionChunkEventSchema)

        try:
            return class_registry.get_class(event_dict["type"])().load(event_dict)
        except RegistryError:
            raise ValueError("Unsupported event type")

    @classmethod
    def from_json(cls, artifact_str: str) -> BaseEvent:
        return cls.from_dict(json.loads(artifact_str))

    def __str__(self) -> str:
        return json.dumps(self.to_dict())

    def to_json(self) -> str:
        return json.dumps(self.to_dict())

    @abstractmethod
    def to_dict(self) -> dict:
        ...

timestamp: float = field(default=Factory(lambda : time.time()), kw_only=True) class-attribute instance-attribute

type: str = field(default=Factory(lambda : self.__class__.__name__, takes_self=True), kw_only=True) class-attribute instance-attribute

__str__()

Source code in griptape/griptape/events/base_event.py 
48
49
def __str__(self) -> str:
    return json.dumps(self.to_dict())

from_dict(event_dict) classmethod

Source code in griptape/griptape/events/base_event.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@classmethod
def from_dict(cls, event_dict: dict) -> BaseEvent:
    from griptape.schemas import (
        StartPromptEventSchema,
        FinishPromptEventSchema,
        StartTaskEventSchema,
        FinishTaskEventSchema,
        StartActionSubtaskEventSchema,
        FinishActionSubtaskEventSchema,
        StartStructureRunEventSchema,
        FinishStructureRunEventSchema,
        CompletionChunkEventSchema,
    )

    class_registry.register("StartPromptEvent", StartPromptEventSchema)
    class_registry.register("FinishPromptEvent", FinishPromptEventSchema)
    class_registry.register("StartTaskEvent", StartTaskEventSchema)
    class_registry.register("FinishTaskEvent", FinishTaskEventSchema)
    class_registry.register("StartActionSubtaskEvent", StartActionSubtaskEventSchema)
    class_registry.register("FinishActionSubtaskEvent", FinishActionSubtaskEventSchema)
    class_registry.register("StartStructureRunEvent", StartStructureRunEventSchema)
    class_registry.register("FinishStructureRunEvent", FinishStructureRunEventSchema)
    class_registry.register("CompletionChunkEvent", CompletionChunkEventSchema)

    try:
        return class_registry.get_class(event_dict["type"])().load(event_dict)
    except RegistryError:
        raise ValueError("Unsupported event type")

from_json(artifact_str) classmethod

Source code in griptape/griptape/events/base_event.py 
44
45
46
@classmethod
def from_json(cls, artifact_str: str) -> BaseEvent:
    return cls.from_dict(json.loads(artifact_str))

to_dict() abstractmethod

Source code in griptape/griptape/events/base_event.py 
54
55
56
@abstractmethod
def to_dict(self) -> dict:
    ...

to_json()

Source code in griptape/griptape/events/base_event.py 
51
52
def to_json(self) -> str:
    return json.dumps(self.to_dict())