module documentation

Undocumented

Class BoolParamType Undocumented
Class Choice The choice type allows a value to be checked against a fixed set of supported values. All of these values have to be strings.
Class CompositeParamType Undocumented
Class DateTime The DateTime type converts date strings into `datetime` objects.
Class File Declares a parameter to be a file for reading or writing. The file is automatically closed once the context tears down (after the command finished working).
Class FloatParamType Undocumented
Class FloatRange Restrict a :data:`click.FLOAT` value to a range of accepted values. See :ref:`ranges`.
Class FuncParamType Undocumented
Class IntParamType Undocumented
Class IntRange Restrict an :data:`click.INT` value to a range of accepted values. See :ref:`ranges`.
Class ParamType Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.
Class Path The ``Path`` type is similar to the :class:`File` type, but returns the filename instead of an open file. Various checks can be enabled to validate the type of file and permissions.
Class StringParamType Undocumented
Class Tuple 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...
Class UnprocessedParamType Undocumented
Class UUIDParameterType Undocumented
Function convert_type Find the most appropriate :class:`ParamType` for the given Python type. If the type isn't provided, it can be inferred from a default value.
Constant BOOL Undocumented
Constant FLOAT Undocumented
Constant INT Undocumented
Constant STRING Undocumented
Constant UNPROCESSED Undocumented
Constant UUID Undocumented
Class _NumberParamTypeBase Undocumented
Class _NumberRangeBase No class docstring; 0/5 instance variable, 2/6 methods documented
def convert_type(ty, default=None): (source)

Find the most appropriate :class:`ParamType` for the given Python type. If the type isn't provided, it can be inferred from a default value.

Parameters
ty:t.Optional[t.Any]Undocumented
default:t.Optional[t.Any]Undocumented
Returns
ParamTypeUndocumented
BOOL = (source)

Undocumented

Value
BoolParamType()
FLOAT = (source)

Undocumented

Value
FloatParamType()

Undocumented

Value
IntParamType()
STRING = (source)

Undocumented

Value
StringParamType()
UNPROCESSED = (source)

Undocumented

Value
UnprocessedParamType()
UUID = (source)

Undocumented

Value
UUIDParameterType()