faust.cli.model

Program faust model used to list details about a model.

class faust.cli.model.model(ctx: click.core.Context, *args: Any, key_serializer: Union[faust.types.codecs.CodecT, str, None] = None, value_serializer: Union[faust.types.codecs.CodecT, str, None] = None, **kwargs: Any) → None[source]

Show model detail.

headers = ['field', 'type', 'default']
options = [argument('name')]
async run(name: str) → None[source]

Dump list of registered models to terminal.

Return type

None

model_fields(model: Type[faust.types.models.ModelT]) → Sequence[Sequence[str]][source]

Convert model fields to terminal table rows.

Return type

Sequence[Sequence[str]]

field(field: faust.types.models.FieldDescriptorT) → Sequence[str][source]

Convert model field model to terminal table columns.

Return type

Sequence[str]

model_to_row(model: Type[faust.types.models.ModelT]) → Sequence[str][source]

Convert model to terminal table row.

Return type

Sequence[str]