module documentation

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 ​Date​Time 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 ​Float​Range Restrict a click.FLOAT value to a range of accepted values. See :ref:`ranges`.
Class ​Int​Range Restrict an click.INT value to a range of accepted values. See :ref:`ranges`.
Class ​Param​Type Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.
Class ​Path No summary
Class ​Tuple No summary
Constant BOOL Undocumented
Constant FLOAT Undocumented
Constant INT Undocumented
Constant STRING Undocumented
Constant UNPROCESSED Undocumented
Constant UUID Undocumented
Class _​Number​Param​Type​Base Undocumented
Class _​Number​Range​Base No class docstring; 0/5 instance variable, 2/6 methods documented
Class ​Bool​Param​Type Undocumented
Class ​Composite​Param​Type Undocumented
Class ​Float​Param​Type Undocumented
Class ​Func​Param​Type Undocumented
Class ​Int​Param​Type Undocumented
Class ​String​Param​Type Undocumented
Class ​Unprocessed​Param​Type Undocumented
Class ​UUIDParameter​Type Undocumented
Function convert​_type Find the most appropriate ParamType for the given Python type. If the type isn't provided, it can be inferred from a default value.
BOOL =

Undocumented

Value
BoolParamType()
FLOAT =

Undocumented

Value
FloatParamType()
INT =

Undocumented

Value
IntParamType()
STRING =

Undocumented

Value
StringParamType()
UNPROCESSED =

Undocumented

Value
UnprocessedParamType()
UUID =

Undocumented

Value
UUIDParameterType()
def convert_type(ty, default=None):
Find the most appropriate 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