MWOption

class lsst.daf.butler.cli.utils.MWOption(param_decls=None, show_default=False, prompt=False, confirmation_prompt=False, hide_input=False, is_flag=None, flag_value=None, multiple=False, count=False, allow_from_autoenv=True, type=None, help=None, hidden=False, show_choices=True, show_envvar=False, **attrs)

Bases: click.core.Option

Overrides click.Option with desired behaviors.

Attributes Summary

human_readable_name	Returns the human readable name of this parameter.
param_type_name

Methods Summary

add_to_parser(parser, ctx)
consume_value(ctx, opts)
full_process_value(ctx, value)
get_default(ctx)	Given a context variable this calculates the default value.
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)
make_metavar()	Overrides click.Option.make_metavar.
process_value(ctx, value)	Given a value and context this runs the logic to convert the value as necessary.
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)
type_cast_value(ctx, value)	Given a value this runs it properly through the type system.
value_from_envvar(ctx)
value_is_missing(value)

Attributes Documentation

human_readable_name

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'

Methods Documentation

add_to_parser(parser, ctx)

consume_value(ctx, opts)

full_process_value(ctx, value)

get_default(ctx)

Given a context variable this calculates the default value.

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)

make_metavar() → str

Overrides click.Option.make_metavar. Makes the metavar for the help menu. Adds a space and an elipsis after the metavar name if the option accepts multiple inputs, otherwise defers to the base implementation.

By default click does not add an elipsis when multiple is True and nargs is 1. And when nargs does not equal 1 click adds an elipsis without a space between the metavar and the elipsis, but we prefer a space between.

Does not get called for some option types (e.g. flag) so metavar transformation that must apply to all types should be applied in get_help_record.

process_value(ctx, value)

Given a value and context this runs the logic to convert the value as necessary.

prompt_for_value(ctx)

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.

resolve_envvar_value(ctx)

type_cast_value(ctx, value)

Given a value this runs it properly through the type system. This automatically handles things like nargs and multiple as well as composite types.

value_from_envvar(ctx)

value_is_missing(value)