OptionEatAll#
- class OptionEatAll[source]#
Bases:
Option
Attributes
Returns the human readable name of this parameter.
Methods
__init__
(*args, **kwargs)add_to_parser
(parser, ctx)consume_value
(ctx, opts)get_default
(ctx[, call])Get the default for the parameter.
get_error_hint
(ctx)Get a stringified version of the param for use in error messages to indicate which param caused the error.
get_help_record
(ctx)get_usage_pieces
(ctx)handle_parse_result
(ctx, opts, args)process_value
(ctx, value)prompt_for_value
(ctx)This is an alternative flow that can be activated in the full value processing if a value does not exist.
resolve_envvar_value
(ctx)shell_complete
(ctx, incomplete)Return a list of completions for the incomplete value.
Gather information that could be useful for a tool generating user-facing documentation.
type_cast_value
(ctx, value)Convert and validate a value against the option's
type
,multiple
, andnargs
.value_from_envvar
(ctx)value_is_missing
(value)- get_default(ctx: Context, call: bool = True) Optional[Union[Any, Callable[[], Any]]] #
Get the default for the parameter. Tries
Context.lookup_default()
first, then the local default.- Parameters:
ctx (Context) – Current context.
call (bool) – If the default is a callable, call it. Disable to return the callable instead.
- Return type:
Changed in version 8.0.2: Type casting is no longer performed when getting a default.
Changed in version 8.0.1: Type casting can fail in resilient parsing mode. Invalid defaults will not prevent showing help text.
Changed in version 8.0: Looks at
ctx.default_map
first.Changed in version 8.0: Added the
call
parameter.
- get_error_hint(ctx: Context) str #
Get a stringified version of the param for use in error messages to indicate which param caused the error.
- Parameters:
ctx (Context) –
- Return type:
- prompt_for_value(ctx: Context) Any #
This is an alternative flow that can be activated in the full value processing if a value does not exist. It will prompt the user until a valid value exists and then returns the processed value as result.
- Parameters:
ctx (Context) –
- Return type:
- shell_complete(ctx: Context, incomplete: str) List[CompletionItem] #
Return a list of completions for the incomplete value. If a
shell_complete
function was given during init, it is used. Otherwise, thetype
shell_complete()
function is used.- Parameters:
ctx (Context) – Invocation context for this command.
incomplete (str) – Value being completed. May be empty.
- Return type:
List[CompletionItem]
New in version 8.0.
- to_info_dict() Dict[str, Any] #
Gather information that could be useful for a tool generating user-facing documentation.
Use
click.Context.to_info_dict()
to traverse the entire CLI structure.New in version 8.0.
- type_cast_value(ctx: Context, value: Any) Any #
Convert and validate a value against the option’s
type
,multiple
, andnargs
.
- property human_readable_name: str#
Returns the human readable name of this parameter. This is the same as the name for options, but the metavar for arguments.
- param_type_name = 'option'#