click.core.Argument

class documentation

class Argument(Parameter):

Arguments are positional parameters to a command. They generally provide fewer features than options but can have infinite nargs and are required by default.

All parameters are passed onwards to the parameter constructor.

Method	`__init__`	Undocumented
Method	`_parse_decls`	Undocumented
Method	`add_to_parser`	Undocumented
Method	`get_error_hint`	Get a stringified version of the param for use in error messages to indicate which param caused the error.
Method	`get_usage_pieces`	Undocumented
Method	`make_metavar`	Undocumented
Class Variable	`param_type_name`	Undocumented
Property	`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.

Inherited from Parameter:

Method	`__repr__`	Undocumented
Method	`consume_value`	Undocumented
Method	`get_default`	Get the default for the parameter. Tries `Context.lookup_default` first, then the local default.
Method	`get_help_record`	Undocumented
Method	`handle_parse_result`	Undocumented
Method	`process_value`	Undocumented
Method	`resolve_envvar_value`	Undocumented
Method	`shell_complete`	No summary
Method	`to_info_dict`	Gather information that could be useful for a tool generating user-facing documentation.
Method	`type_cast_value`	Convert and validate a value against the option's `type`, `multiple`, and `nargs`.
Method	`value_from_envvar`	Undocumented
Method	`value_is_missing`	Undocumented
Instance Variable	`_custom_shell_complete`	Undocumented
Instance Variable	`callback`	Undocumented
Instance Variable	`default`	Undocumented
Instance Variable	`envvar`	Undocumented
Instance Variable	`expose_value`	Undocumented
Instance Variable	`is_eager`	Undocumented
Instance Variable	`metavar`	Undocumented
Instance Variable	`multiple`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`nargs`	Undocumented
Instance Variable	`opts`	Undocumented
Instance Variable	`required`	Undocumented
Instance Variable	`secondary_opts`	Undocumented
Instance Variable	`type`	Undocumented

def __init__(self, param_decls, required=None, **attrs):

overrides click.core.Parameter.__init__

Undocumented

Parameters
param_decls:`t.Sequence[str]`	Undocumented
required:`t.Optional[bool]`	Undocumented
**attrs:`t.Any`	Undocumented

def _parse_decls(self, decls, expose_value):

overrides click.core.Parameter._parse_decls

Undocumented

Parameters
decls:`t.Sequence[str]`	Undocumented
expose_value:`bool`	Undocumented
Returns
`t.Tuple[t.Optional[str], t.List[str], t.List[str]]`	Undocumented

def add_to_parser(self, parser, ctx):

overrides click.core.Parameter.add_to_parser

Undocumented

Parameters
parser:`OptionParser`	Undocumented
ctx:`Context`	Undocumented

def get_error_hint(self, ctx):

overrides click.core.Parameter.get_error_hint

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

Parameters
ctx:`Context`	Undocumented
Returns
`str`	Undocumented

def get_usage_pieces(self, ctx):

overrides click.core.Parameter.get_usage_pieces

Undocumented

Parameters
ctx:`Context`	Undocumented
Returns
`t.List[str]`	Undocumented

def make_metavar(self):

overrides click.core.Parameter.make_metavar

Undocumented

Returns
`str`	Undocumented

param_type_name: str =

overrides click.core.Parameter.param_type_name

Undocumented

@property
human_readable_name: str =

overrides click.core.Parameter.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.