vpype_cli.TextType

class TextType(*args, **kwargs)

click.ParamType sub-class to automatically perform property substitution on user input.

Example:

>>> import click
>>> import vpype_cli
>>> import vpype
>>> @vpype_cli.cli.command(group="my commands")
... @click.argument("text", type=vpype_cli.TextType())
... @vpype_cli.generator
... def my_command(text: str):
...     pass

Methods

Attributes

name

the descriptive name of this type

Methods

Attributes

TextType.name: str = 'text'

the descriptive name of this type