hap.client.base¶

Classes¶

HAPClientProtocol

Base class for protocol classes.

Module Contents¶

class hap.client.base.HAPClientProtocol¶

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

run_agent(entrypoint: str, *, inputs: Mapping[str, Any] | None = None) → hap.models.context.HAPContext¶

Parameters:

entrypoint (str)
inputs (Mapping[str, Any] | None)

Return type:

hap.models.context.HAPContext

run_graph(graph: hap.models.graph.AgentGraph, *, inputs: Mapping[str, Any] | None = None) → hap.models.context.HAPContext¶

Parameters:

graph (hap.models.graph.AgentGraph)
inputs (Mapping[str, Any] | None)

Return type:

hap.models.context.HAPContext