click.core.Argument

class documentation

class Argument(Parameter): (source)

View In Hierarchy

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 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.
Method _parse_decls Undocumented

Inherited from Parameter:

Method __repr__ Undocumented
Method consume_value Undocumented
Method get_default Get the default for the parameter. Tries :meth:`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 Return a list of completions for the incomplete value. If a ``shell_complete`` function was given during init, it is used. Otherwise, the :attr:`type` :meth:`~click.types.ParamType.shell_complete` function is used.
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 :attr:`type`, :attr:`multiple`, and :attr:`nargs`.
Method value_from_envvar Undocumented
Method value_is_missing 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
Instance Variable _custom_shell_complete Undocumented
def __init__(self, param_decls, required=None, **attrs): (source)
overrides click.core.Parameter.__init__

Undocumented

Parameters
param_decls:t.Sequence[str]Undocumented
required:t.Optional[bool]Undocumented
**attrs:t.AnyUndocumented
def add_to_parser(self, parser, ctx): (source)
overrides click.core.Parameter.add_to_parser

Undocumented

Parameters
parser:OptionParserUndocumented
ctx:ContextUndocumented
def get_error_hint(self, ctx): (source)
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:ContextUndocumented
Returns
strUndocumented
def get_usage_pieces(self, ctx): (source)
overrides click.core.Parameter.get_usage_pieces

Undocumented

Parameters
ctx:ContextUndocumented
Returns
t.List[str]Undocumented
def make_metavar(self): (source)
overrides click.core.Parameter.make_metavar

Undocumented

Returns
strUndocumented
param_type_name: str = (source)
overrides click.core.Parameter.param_type_name

Undocumented

@property
human_readable_name: str = (source)
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.

def _parse_decls(self, decls, expose_value): (source)
overrides click.core.Parameter._parse_decls

Undocumented

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