koi_net.components.interfaces.deref_handler

Classes

DerefHandler(log, effector)

Base class for dereference handler components.

class koi_net.components.interfaces.deref_handler.DerefHandler(log, effector)

Bases: object

Base class for dereference handler components.

Derived classes MUST set the rid_types to a tuple of acceptable types. The handle() method MUST be overriden, and may be passed any RID of the specified allowed RID types.

Note

If you only want to allow a single RID type, remember to add a trailing comma after so it is a valid tuple.

Example:

@dataclass
class MyDerefHandler(DerefHandler):
    rid_types=(CustomType,)

    def handle(self, rid: CustomType):
        return

Parameters:

• log (Logger)

• effector (Effector)

effector: Effector

handle(rid)

Return type:

Bundle | None

Parameters:

rid (RID)

log: Logger

rid_types: tuple[RIDType]