click.core.Argument Class Reference

Inheritance diagram for click.core.Argument:

Collaboration diagram for click.core.Argument:

Public Member Functions
None	__init__ (self, cabc.Sequence[str] param_decls, bool|None required=None, **t.Any attrs)
str	human_readable_name (self)
str	make_metavar (self, Context ctx)
list[str]	get_usage_pieces (self, Context ctx)
str	get_error_hint (self, Context ctx)
None	add_to_parser (self, _OptionParser parser, Context ctx)
Public Member Functions inherited from click.core.Parameter
dict[str, t.Any]	to_info_dict (self)
str	__repr__ (self)
t.Any|None	get_default (self, Context ctx, t.Literal[True] call=True)
t.Any|t.Callable[[], t.Any]|None	get_default (self, Context ctx, bool call=...)
t.Any|t.Callable[[], t.Any]|None	get_default (self, Context ctx, bool call=True)
tuple[t.Any, ParameterSource]	consume_value (self, Context ctx, cabc.Mapping[str, t.Any] opts)
t.Any	type_cast_value (self, Context ctx, t.Any value)
bool	value_is_missing (self, t.Any value)
t.Any	process_value (self, Context ctx, t.Any value)
str|None	resolve_envvar_value (self, Context ctx)
str|cabc.Sequence[str]|None	value_from_envvar (self, Context ctx)
tuple[t.Any, list[str]]	handle_parse_result (self, Context ctx, cabc.Mapping[str, t.Any] opts, list[str] args)
tuple[str, str]|None	get_help_record (self, Context ctx)
list[CompletionItem]	shell_complete (self, Context ctx, str incomplete)

Static Public Attributes
str	param_type_name = "argument"
Static Public Attributes inherited from click.core.Parameter
str	param_type_name = "parameter"

Protected Member Functions
tuple[str|None, list[str], list[str]]	_parse_decls (self, cabc.Sequence[str] decls, bool expose_value)

Additional Inherited Members
Public Attributes inherited from click.core.Parameter
	name
	opts
	secondary_opts
	required
	callback
	nargs
	multiple
	expose_value
	is_eager
	metavar
	envvar
	deprecated
	param_type_name
Protected Attributes inherited from click.core.Parameter
	_custom_shell_complete

Detailed Description

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 constructor of :class:`Parameter`.

Constructor & Destructor Documentation

__init__()

None click.core.Argument.__init__	(		self,
		cabc.Sequence[str]	param_decls,
		bool | None	required = None,
		**t.Any	attrs
	)

Reimplemented from click.core.Parameter.

Member Function Documentation

_parse_decls()

tuple[str | None, list[str], list[str]] click.core.Argument._parse_decls (   self, cabc.Sequence[str]  decls, bool   expose_value  )

protected

Reimplemented from click.core.Parameter.

add_to_parser()

None click.core.Argument.add_to_parser	(		self,
		_OptionParser	parser,
		Context	ctx
	)

Reimplemented from click.core.Parameter.

get_error_hint()

str click.core.Argument.get_error_hint	(		self,
		Context	ctx
	)

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

Reimplemented from click.core.Parameter.

get_usage_pieces()

list[str] click.core.Argument.get_usage_pieces	(		self,
		Context	ctx
	)

Reimplemented from click.core.Parameter.

human_readable_name()

str click.core.Argument.human_readable_name

(

self

)

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

Reimplemented from click.core.Parameter.

make_metavar()

str click.core.Argument.make_metavar	(		self,
		Context	ctx
	)

Reimplemented from click.core.Parameter.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/click/core.py