click.types.Choice

class documentation

class Choice(ParamType): (source)

The choice type allows a value to be checked against a fixed set of supported values. All of these values have to be strings. You should only pass a list or tuple of choices. Other iterables (like generators) may lead to surprising results. The resulting value will always be one of the originally passed choices regardless of ``case_sensitive`` or any ``ctx.token_normalize_func`` being specified. See :ref:`choice-opts` for an example. :param case_sensitive: Set to false to make choices case insensitive. Defaults to true.

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`convert`	Convert the value to the correct type. This is not called if the value is ``None`` (the missing value).
Method	`get_metavar`	Returns the metavar default for this param if it provides one.
Method	`get_missing_message`	Optionally might return extra information about a missing parameter.
Method	`shell_complete`	Complete choices that start with the incomplete value.
Method	`to_info_dict`	Gather information that could be useful for a tool generating user-facing documentation.
Class Variable	`name`	Undocumented
Instance Variable	`case_sensitive`	Undocumented
Instance Variable	`choices`	Undocumented

Inherited from ParamType:

Method	`__call__`	Undocumented
Method	`fail`	Helper method to fail with an invalid value message.
Method	`split_envvar_value`	Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.
Class Variable	`arity`	Undocumented
Class Variable	`envvar_list_splitter`	Undocumented
Class Variable	`is_composite`	Undocumented

def __init__(self, choices, case_sensitive=True): (source)

Undocumented

Parameters
choices:`t.Sequence[str]`	Undocumented
case_sensitive:`bool`	Undocumented

def __repr__(self): (source)

Undocumented

Returns
`str`	Undocumented

def convert(self, value, param, ctx): (source)

overrides click.types.ParamType.convert

Convert the value to the correct type. This is not called if the value is ``None`` (the missing value). This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types. The ``param`` and ``ctx`` arguments may be ``None`` in certain situations, such as when converting prompt input. If the value cannot be converted, call :meth:`fail` with a descriptive message. :param value: The value to convert. :param param: The parameter that is using this type to convert its value. May be ``None``. :param ctx: The current context that arrived at this value. May be ``None``.

Parameters
value:`t.Any`	Undocumented
param:`t.Optional[Parameter]`	Undocumented
ctx:`t.Optional[Context]`	Undocumented
Returns
`t.Any`	Undocumented

def get_metavar(self, param): (source)

overrides click.types.ParamType.get_metavar

Returns the metavar default for this param if it provides one.

Parameters
param:`Parameter`	Undocumented
Returns
`str`	Undocumented

def get_missing_message(self, param): (source)

overrides click.types.ParamType.get_missing_message

Optionally might return extra information about a missing parameter. .. versionadded:: 2.0

Parameters
param:`Parameter`	Undocumented
Returns
`str`	Undocumented

def shell_complete(self, ctx, param, incomplete): (source)

overrides click.types.ParamType.shell_complete

Complete choices that start with the incomplete value. :param ctx: Invocation context for this command. :param param: The parameter that is requesting completion. :param incomplete: Value being completed. May be empty. .. versionadded:: 8.0

Parameters
ctx:`Context`	Undocumented
param:`Parameter`	Undocumented
incomplete:`str`	Undocumented
Returns
`t.List[CompletionItem]`	Undocumented

def to_info_dict(self): (source)

overrides click.types.ParamType.to_info_dict

Gather information that could be useful for a tool generating user-facing documentation. Use :meth:`click.Context.to_info_dict` to traverse the entire CLI structure. .. versionadded:: 8.0

Returns
`t.Dict[str, t.Any]`	Undocumented

name: str = (source)

overrides click.types.ParamType.name

Undocumented

case_sensitive = (source)

Undocumented

choices = (source)

Undocumented