class documentation
class FloatParamType(_NumberParamTypeBase): (source)
Known subclasses: click.types.FloatRange
Undocumented
Method | __repr__ |
Undocumented |
Class Variable | name |
Undocumented |
Inherited from _NumberParamTypeBase
:
Method | convert |
Convert the value to the correct type. This is not called if the value is ``None`` (the missing value). |
Class Variable | _number |
Undocumented |
Inherited from ParamType
(via _NumberParamTypeBase
):
Method | __call__ |
Undocumented |
Method | fail |
Helper method to fail with an invalid value message. |
Method | get |
Returns the metavar default for this param if it provides one. |
Method | get |
Optionally might return extra information about a missing parameter. |
Method | shell |
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 |
Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter. |
Method | to |
Gather information that could be useful for a tool generating user-facing documentation. |
Class Variable | arity |
Undocumented |
Class Variable | envvar |
Undocumented |
Class Variable | is |
Undocumented |