Skip to content

classes

SerialFunctionResponse dataclass

Bases: SerialFunctionResponseBase

A dataclass for passing msgpack serialization responses.

Parameters:

Name Type Description Default
success bool

True if operation success, False if operation failure

field(default=False)
detail Any

Append additional details to a response

field(default=None)
operation str

The operation that produced this response. Can be serialize/deserialize, or serialize/deserialize file.

field(default=None)
Source code in src/red_utils/ext/msgpack_utils/classes.py
@dataclass
class SerialFunctionResponse(SerialFunctionResponseBase):
    """A `dataclass` for passing `msgpack` serialization responses.

    Params:
        success (bool): `True` if operation success, `False` if operation failure
        detail (Any): Append additional details to a response
        operation (str): The operation that produced this response.
            Can be serialize/deserialize, or serialize/deserialize file.
    """

    pass