openfl.utilities.click_types.InputSpec

openfl.utilities.click_types.InputSpec#

class openfl.utilities.click_types.InputSpec(param_decls=None, show_default=None, prompt=False, confirmation_prompt=False, prompt_required=True, 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)[source]#

Bases: Option

List or dictionary that corresponds to the input shape for a model

Parameters:

  • param_decls (Sequence[str] | None)

  • show_default (bool | str | None)

  • prompt (bool | str)

  • confirmation_prompt (bool | str)

  • prompt_required (bool)

  • hide_input (bool)

  • is_flag (bool | None)

  • flag_value (Any | None)

  • multiple (bool)

  • count (bool)

  • allow_from_autoenv (bool)

  • type (ParamType | Any | None)

  • help (str | None)

  • hidden (bool)

  • show_choices (bool)

  • show_envvar (bool)

  • attrs (Any)

__init__(param_decls=None, show_default=None, prompt=False, confirmation_prompt=False, prompt_required=True, 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)[source]#
Parameters:

  • param_decls (Sequence[str] | None)

  • show_default (bool | str | None)

  • prompt (bool | str)

  • confirmation_prompt (bool | str)

  • prompt_required (bool)

  • hide_input (bool)

  • is_flag (bool | None)

  • flag_value (Any | None)

  • multiple (bool)

  • count (bool)

  • allow_from_autoenv (bool)

  • type (ParamType | Any | None)

  • help (str | None)

  • hidden (bool)

  • show_choices (bool)

  • show_envvar (bool)

  • attrs (Any)

Return type:

None

Methods

__init__([param_decls, show_default, ...])

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)

make_metavar()

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.

to_info_dict()

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, and nargs.

value_from_envvar(ctx)

value_is_missing(value)

Attributes

human_readable_name

Returns the human readable name of this parameter.

param_type_name

get_default(ctx, call=True)[source]#

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:

Any | Callable[[], Any] | None

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)[source]#

Get a stringified version of the param for use in error messages to indicate which param caused the error.

Parameters:

ctx (Context)

Return type:

str

property human_readable_name: str[source]#

Returns the human readable name of this parameter. This is the same as the name for options, but the metavar for arguments.

prompt_for_value(ctx)[source]#

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:

Any

shell_complete(ctx, incomplete)[source]#

Return a list of completions for the incomplete value. If a shell_complete function was given during init, it is used. Otherwise, the type 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]

Added in version 8.0.

to_info_dict()[source]#

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.

Added in version 8.0.

Return type:

Dict[str, Any]

type_cast_value(ctx, value)[source]#

Convert and validate a value against the option’s type, multiple, and nargs.