cottax.consumers.json.interface_types module

What a spelling writes and reads a node through (Writer, Reader), and Json, what it writes.

type Json = Any

class Writer[N: Label, V: Place](*args, **kwargs)

Bases: Protocol, Generic[N, V]

What a spelling writes a node through, for the node bound at name.

name: N

place(place: V)

Return type:

Json

places(places: tuple[V, ...])

Return type:

list

label(name: N)

Return type:

Json

node(node: NodeDefinition[V])

A node it holds, by its own final’s spelling.

Return type:

dict

implementation(obj: object)

What runs a node: by name, or a dataclass as a value.

Return type:

dict

value(obj: object)

A dataclass as its class and fields: a driver, say.

Return type:

dict

refuse(what: str, reason: str)

What to raise where what is not written: the export’s check reports it.

Return type:

Exception

class Reader[N: Label, V: Place](*args, **kwargs)

Bases: Protocol, Generic[N, V]

What a spelling reads a node through, for the node bound at name.

name: N

place(data: Json)

Return type:

V

places(data: list)

Return type:

tuple[V, ...]

label(data: Json)

Return type:

N

node(data: dict)

Return type:

NodeDefinition[V]

implementation(data: dict)

Return type:

object

value(data: dict)

Return type:

Any