click.types.Tuple Class Reference

Inheritance diagram for click.types.Tuple:

Collaboration diagram for click.types.Tuple:

Public Member Functions
None	__init__ (self, cabc.Sequence[type[t.Any]|ParamType] types)
dict[str, t.Any]	to_info_dict (self)
str	name (self)
int	arity (self)
t.Any	convert (self, t.Any value, Parameter|None param, Context|None ctx)
Public Member Functions inherited from click.types.ParamType
t.Any	__call__ (self, t.Any value, Parameter|None param=None, Context|None ctx=None)
str|None	get_metavar (self, Parameter param, Context ctx)
str|None	get_missing_message (self, Parameter param, Context|None ctx)
cabc.Sequence[str]	split_envvar_value (self, str rv)
t.NoReturn	fail (self, str message, Parameter|None param=None, Context|None ctx=None)
list[CompletionItem]	shell_complete (self, Context ctx, Parameter param, str incomplete)

Public Attributes
	types
Public Attributes inherited from click.types.ParamType
	envvar_list_splitter

Additional Inherited Members
Static Public Attributes inherited from click.types.CompositeParamType
bool	is_composite = True
Static Public Attributes inherited from click.types.ParamType
t	is_composite = False
t	envvar_list_splitter = None

Detailed Description

The default behavior of Click is to apply a type on a value directly.
This works well in most cases, except for when `nargs` is set to a fixed
count and different types should be used for different items.  In this
case the :class:`Tuple` type can be used.  This type can only be used
if `nargs` is set to a fixed number.

For more information see :ref:`tuple-type`.

This can be selected by using a Python tuple literal as a type.

:param types: a list of types that should be used for the tuple items.

Member Function Documentation

arity()

int click.types.Tuple.arity

(

self

)

Reimplemented from click.types.CompositeParamType.

convert()

t.Any click.types.Tuple.convert	(		self,
		t.Any	value,
		Parameter | None	param,
		Context | None	ctx
	)

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``.

Reimplemented from click.types.ParamType.

name()

str click.types.Tuple.name

(

self

)

Reimplemented from click.types.ParamType.

to_info_dict()

dict[str, t.Any] click.types.Tuple.to_info_dict

(

self

)

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

Reimplemented from click.types.ParamType.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/click/types.py