Program faust models used to list models available.

class faust.cli.models.models(ctx: Context, *args: Any, key_serializer: Optional[Union[CodecT, str]] = None, value_serializer: Optional[Union[CodecT, str]] = None, **kwargs: Any)[source]

List all available models as a tabulated list.

title = 'Models'
headers = ['name', 'help']
sortkey = operator.attrgetter('_options.namespace')
options: Optional[OptionList] = [option('--builtins/--no-builtins', default=False)]
async run(*, builtins: bool) None[source]

Dump list of available models in this application.

Return type:


models(builtins: bool) Sequence[Type[ModelT]][source]

Convert list of models to terminal table rows.

Return type:


model_to_row(model: Type[ModelT]) Sequence[str][source]

Convert model fields to terminal table columns.

Return type:


app: AppT
key_serializer: CodecArg

The codec used to serialize keys. Taken from instance parameters or key_serializer.

value_serialier: CodecArg

The codec used to serialize values. Taken from instance parameters or value_serializer.

debug: bool
quiet: bool
workdir: str
datadir: str
json: bool
logfile: str
stdout: IO
stderr: IO
args: Tuple
kwargs: Dict