click.types._NumberRangeBase

class documentation

class _NumberRangeBase(_NumberParamTypeBase): (source)

Known subclasses: click.types.FloatRange, click.types.IntRange

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method __repr__ Undocumented
Method convert Convert the value to the correct type. This is not called if the value is ``None`` (the missing value).
Method to_info_dict Gather information that could be useful for a tool generating user-facing documentation.
Instance Variable clamp Undocumented
Instance Variable max Undocumented
Instance Variable max_open Undocumented
Instance Variable min Undocumented
Instance Variable min_open Undocumented
Method _clamp Find the valid value to clamp to bound in the given direction.
Method _describe_range Describe the range for use in help text.

Inherited from _NumberParamTypeBase:

Class Variable _number_class Undocumented

Inherited from ParamType (via _NumberParamTypeBase):

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 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_envvar_value Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.
Class Variable arity Undocumented
Class Variable envvar_list_splitter Undocumented
Class Variable is_composite Undocumented
Class Variable name Undocumented
def __init__(self, min=None, max=None, min_open=False, max_open=False, clamp=False): (source)
overridden in click.types.FloatRange

Undocumented

Parameters
min:t.Optional[float]Undocumented
max:t.Optional[float]Undocumented
min_open:boolUndocumented
max_open:boolUndocumented
clamp:boolUndocumented
def __repr__(self): (source)

Undocumented

Returns
strUndocumented
def convert(self, value, param, ctx): (source)
overrides click.types._NumberParamTypeBase.convert

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

Parameters
value:t.AnyUndocumented
param:t.Optional[Parameter]Undocumented
ctx:t.Optional[Context]Undocumented
Returns
t.AnyUndocumented
def to_info_dict(self): (source)
overrides click.types.ParamType.to_info_dict

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

Returns
t.Dict[str, t.Any]Undocumented
clamp = (source)

Undocumented

max = (source)

Undocumented

max_open = (source)

Undocumented

min = (source)

Undocumented

min_open = (source)

Undocumented

def _clamp(self, bound, dir, open): (source)
overridden in click.types.FloatRange, click.types.IntRange

Find the valid value to clamp to bound in the given direction. :param bound: The boundary value. :param dir: 1 or -1 indicating the direction to move. :param open: If true, the range does not include the bound.

Parameters
bound:floatUndocumented
dir:te.Literal[1, -1]Undocumented
open:boolUndocumented
Returns
floatUndocumented
def _describe_range(self): (source)

Describe the range for use in help text.

Returns
strUndocumented