soulfire.client.SoulFireService¶

class soulfire.client.SoulFireService[source]¶

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:
        ...

property admin: soulfire.admin.SoulFireAdmin¶

property plugins: soulfire.plugins.PluginCatalog¶

property server: soulfire.connection.ServerMetadata¶

property capabilities: soulfire.connection.CapabilitySet¶

instances(*, headers: dict[str, str] | None = None, timeout_ms: int | None = None) → effect_py.Effect[list[soulfire.instance_pb2.InstanceListResponse.Instance], soulfire.errors.SoulFireOperationError][source]¶

create_instance(friendly_name: str, *, headers: dict[str, str] | None = None, timeout_ms: int | None = None) → effect_py.Effect[SoulFireInstance, soulfire.errors.SoulFireOperationError][source]¶

instance(instance_id: str) → SoulFireInstance[source]¶

get_or_create_instance(name: str, *, server: str | None = None, timeout_ms: int | None = None) → effect_py.Effect[SoulFireInstance, soulfire.errors.SoulFireOperationError][source]¶