soulfire.script_connect.ScriptServiceSync

class soulfire.script_connect.ScriptServiceSync

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

create_script(request: soulfire.script_pb2.CreateScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.CreateScriptRequest, soulfire.script_pb2.CreateScriptResponse]) → soulfire.script_pb2.CreateScriptResponse

get_script(request: soulfire.script_pb2.GetScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.GetScriptRequest, soulfire.script_pb2.GetScriptResponse]) → soulfire.script_pb2.GetScriptResponse

update_script(request: soulfire.script_pb2.UpdateScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.UpdateScriptRequest, soulfire.script_pb2.UpdateScriptResponse]) → soulfire.script_pb2.UpdateScriptResponse

delete_script(request: soulfire.script_pb2.DeleteScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.DeleteScriptRequest, soulfire.script_pb2.DeleteScriptResponse]) → soulfire.script_pb2.DeleteScriptResponse

list_scripts(request: soulfire.script_pb2.ListScriptsRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.ListScriptsRequest, soulfire.script_pb2.ListScriptsResponse]) → soulfire.script_pb2.ListScriptsResponse

activate_script(request: soulfire.script_pb2.ActivateScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.ActivateScriptRequest, soulfire.script_pb2.ScriptEvent]) → collections.abc.Iterator[soulfire.script_pb2.ScriptEvent]

deactivate_script(request: soulfire.script_pb2.DeactivateScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.DeactivateScriptRequest, soulfire.script_pb2.DeactivateScriptResponse]) → soulfire.script_pb2.DeactivateScriptResponse

get_script_status(request: soulfire.script_pb2.GetScriptStatusRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.GetScriptStatusRequest, soulfire.script_pb2.GetScriptStatusResponse]) → soulfire.script_pb2.GetScriptStatusResponse

subscribe_script_logs(request: soulfire.script_pb2.SubscribeScriptLogsRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.SubscribeScriptLogsRequest, soulfire.script_pb2.ScriptLogEntry]) → collections.abc.Iterator[soulfire.script_pb2.ScriptLogEntry]

get_node_types(request: soulfire.script_pb2.GetNodeTypesRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.GetNodeTypesRequest, soulfire.script_pb2.GetNodeTypesResponse]) → soulfire.script_pb2.GetNodeTypesResponse

get_registry_data(request: soulfire.script_pb2.GetRegistryDataRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.GetRegistryDataRequest, soulfire.script_pb2.GetRegistryDataResponse]) → soulfire.script_pb2.GetRegistryDataResponse

validate_script(request: soulfire.script_pb2.ValidateScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.ValidateScriptRequest, soulfire.script_pb2.ValidateScriptResponse]) → soulfire.script_pb2.ValidateScriptResponse

dry_run_script(request: soulfire.script_pb2.DryRunScriptRequest, ctx: connectrpc.request.RequestContext[soulfire.script_pb2.DryRunScriptRequest, soulfire.script_pb2.ScriptEvent]) → collections.abc.Iterator[soulfire.script_pb2.ScriptEvent]