faust.cli.models

Program faust models used to list models available.

class faust.cli.models.models(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

List all available models as a tabulated list.

title = 'Models'

headers = ['name', 'help']

sortkey = operator.attrgetter('_options.namespace')

options = [option('--builtins/--no-builtins', default=False)]

async run(*, builtins: bool) → None

Dump list of available models in this application.

Return type

None

models(builtins: bool) → Sequence[Type[faust.types.models.ModelT]]

Convert list of models to terminal table rows.

Return type

Sequence[Type[ModelT]]

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

Convert model fields to terminal table columns.

Return type

Sequence[str]