base

---

class Action

Inherits from: pydantic.BaseModel

Pydantic base model for actions (things you execute).

method execute

Call Type: async

Execute the action asynchronously.

View Source

class Action(BaseModel):
    '''
    Pydantic base model for actions (things you execute).
    '''
    # Lenient validation; allow non-pydantic objects in fields if needed
    model_config = ConfigDict(extra='forbid', arbitrary_types_allowed=True, ignored_types=(type(Enum),))

    async def execute(self) -> Any:
        '''
        Execute the action asynchronously.
        '''
        raise NotImplementedError

---

class Event

Inherits from: pydantic.BaseModel

Pydantic base model for events (things you wait/observe).

method check

Call Type: async

Check to see if the event has been completed.

View Source

class Event(BaseModel):
    '''
    Pydantic base model for events (things you wait/observe).
    '''
    # Lenient validation; allow non-pydantic objects in fields if needed
    model_config = ConfigDict(extra='forbid', arbitrary_types_allowed=True, ignored_types=(type(Enum),))

    async def check(self) -> bool:
        '''
        Check to see if the event has been completed.
        '''
        raise NotImplementedError

---

class Datatype

Inherits from: pydantic.BaseModel

Pydantic base model for a Protobuf message.

View Source

class Datatype(BaseModel):
    '''
    Pydantic base model for a Protobuf message.
    '''
    # Lenient validation; allow non-pydantic objects in fields if needed
    model_config = ConfigDict(extra='forbid', arbitrary_types_allowed=True, ignored_types=(type(Enum),))

---