click.types.ParamType

class documentation

class ParamType: (source)

Known subclasses: click.types.BoolParamType, click.types.Choice, click.types.CompositeParamType, click.types.DateTime, click.types.File, click.types.FuncParamType, click.types.Path, click.types.StringParamType, click.types.UnprocessedParamType, click.types.UUIDParameterType, click.types._NumberParamTypeBase

View In Hierarchy

Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type. To implement a custom type, subclass and implement at least the following: - The :attr:`name` class attribute must be set. - Calling an instance of the type with ``None`` must return ``None``. This is already implemented by default. - :meth:`convert` must convert string values to the correct type. - :meth:`convert` must accept values that are already the correct type. - It must be able to convert a value if the ``ctx`` and ``param`` arguments are ``None``. This can occur when converting prompt input.

Method	`__call__`	Undocumented
Method	`convert`	Convert the value to the correct type. This is not called if the value is ``None`` (the missing value).
Method	`fail`	Helper method to fail with an invalid value message.
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`	Return a list of :class:`~click.shell_completion.CompletionItem` objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.
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.
Method	`to_info_dict`	Gather information that could be useful for a tool generating user-facing documentation.
Class Variable	`arity`	Undocumented
Class Variable	`envvar_list_splitter`	Undocumented
Class Variable	`is_composite`	Undocumented
Class Variable	`name`	Undocumented

def __call__(self, value, param=None, ctx=None): (source)

Undocumented

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

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

overridden in click.types.BoolParamType, click.types.Choice, click.types.DateTime, click.types.File, click.types.FuncParamType, click.types.Path, click.types.StringParamType, click.types.Tuple, click.types.UnprocessedParamType, click.types.UUIDParameterType, click.types._NumberParamTypeBase

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 fail(self, message, param=None, ctx=None): (source)

Helper method to fail with an invalid value message.

Parameters
message:`str`	Undocumented
param:`t.Optional[Parameter]`	Undocumented
ctx:`t.Optional[Context]`	Undocumented
Returns
`t.NoReturn`	Undocumented

def get_metavar(self, param): (source)

overridden in click.types.Choice, click.types.DateTime

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

Parameters
param:`Parameter`	Undocumented
Returns
`t.Optional[str]`	Undocumented

def get_missing_message(self, param): (source)

overridden in click.types.Choice

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

Parameters
param:`Parameter`	Undocumented
Returns
`t.Optional[str]`	Undocumented

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

overridden in click.types.Choice, click.types.File, click.types.Path

Return a list of :class:`~click.shell_completion.CompletionItem` objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well. :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 split_envvar_value(self, rv): (source)

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter. If the splitter is set to `None`, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

Parameters
rv:`str`	Undocumented
Returns
`t.Sequence[str]`	Undocumented

def to_info_dict(self): (source)

overridden in click.types.Choice, click.types.DateTime, click.types.File, click.types.FuncParamType, click.types.Path, click.types.Tuple, click.types._NumberRangeBase

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

arity: t.ClassVar[int] = (source)

overridden in click.types.CompositeParamType

Undocumented

envvar_list_splitter: t.ClassVar[t.Optional[str]] = (source)

Undocumented

is_composite: t.ClassVar[bool] = (source)

overridden in click.types.CompositeParamType

Undocumented

name: str = (source)

overridden in click.types.BoolParamType, click.types.Choice, click.types.DateTime, click.types.File, click.types.FloatParamType, click.types.FloatRange, click.types.FuncParamType, click.types.IntParamType, click.types.IntRange, click.types.Path, click.types.StringParamType, click.types.Tuple, click.types.UnprocessedParamType, click.types.UUIDParameterType

Undocumented