click.types.Choice

class documentation

class Choice(ParamType):

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.

Parameters
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):

Undocumented

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

def __repr__(self):

Undocumented

Returns
`str`	Undocumented

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

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 fail with a descriptive message.

Parameters
value:`t.Any`	The value to convert.
param:`t.Optional[Parameter]`	The parameter that is using this type to convert its value. May be `None`.
ctx:`t.Optional[Context]`	The current context that arrived at this value. May be `None`.
Returns
`t.Any`	Undocumented

def get_metavar(self, param):

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):

overrides click.types.ParamType.get_missing_message

Optionally might return extra information about a missing parameter.

New in version 2.0.

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

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

overrides click.types.ParamType.shell_complete

Complete choices that start with the incomplete value.

New in version 8.0.

Parameters
ctx:`Context`	Invocation context for this command.
param:`Parameter`	The parameter that is requesting completion.
incomplete:`str`	Value being completed. May be empty.
Returns
`t.List[CompletionItem]`	Undocumented

def to_info_dict(self):

overrides click.types.ParamType.to_info_dict

Gather information that could be useful for a tool generating user-facing documentation.

Use click.Context.to_info_dict to traverse the entire CLI structure.

New in version 8.0.

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

name: str =

overrides click.types.ParamType.name

Undocumented

case_sensitive =

Undocumented

choices =

Undocumented