click.types._NumberParamTypeBase

class documentation

class _NumberParamTypeBase(ParamType):

Known subclasses: click.types._NumberRangeBase, click.types.FloatParamType, click.types.IntParamType

Undocumented

Method	`convert`	Convert the value to the correct type. This is not called if the value is `None` (the missing value).
Class Variable	`_number_class`	Undocumented

Inherited from ParamType:

Method	`__call__`	Undocumented
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`	No summary
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 convert(self, value, param, ctx):

overrides click.types.ParamType.convert

overridden in click.types._NumberRangeBase

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

_number_class: t.ClassVar[t.Type] =

Undocumented