click.core.CommandCollection Class Reference

Inheritance diagram for click.core.CommandCollection:

Collaboration diagram for click.core.CommandCollection:

Public Member Functions
None	__init__ (self, str|None name=None, list[Group]|None sources=None, **t.Any kwargs)
None	add_source (self, Group group)
Command|None	get_command (self, Context ctx, str cmd_name)
list[str]	list_commands (self, Context ctx)
Public Member Functions inherited from click.core.Group
dict[str, t.Any]	to_info_dict (self, Context ctx)
None	add_command (self, Command cmd, str|None name=None)
Command	command (self, t.Callable[..., t.Any] __func)
t.Callable[[t.Callable[..., t.Any]], Command]	command (self, *t.Any args, **t.Any kwargs)
t.Callable[[t.Callable[..., t.Any]], Command]|Command	command (self, *t.Any args, **t.Any kwargs)
Group	group (self, t.Callable[..., t.Any] __func)
t.Callable[[t.Callable[..., t.Any]], Group]	group (self, *t.Any args, **t.Any kwargs)
t.Callable[[t.Callable[..., t.Any]], Group]|Group	group (self, *t.Any args, **t.Any kwargs)
t.Callable[[F], F]	result_callback (self, bool replace=False)
list[str]	collect_usage_pieces (self, Context ctx)
None	format_options (self, Context ctx, HelpFormatter formatter)
None	format_commands (self, Context ctx, HelpFormatter formatter)
list[str]	parse_args (self, Context ctx, list[str] args)
t.Any	invoke (self, Context ctx)
tuple[str|None, Command|None, list[str]]	resolve_command (self, Context ctx, list[str] args)
list[CompletionItem]	shell_complete (self, Context ctx, str incomplete)
Public Member Functions inherited from click.core.Command
str	__repr__ (self)
str	get_usage (self, Context ctx)
list[Parameter]	get_params (self, Context ctx)
None	format_usage (self, Context ctx, HelpFormatter formatter)
list[str]	get_help_option_names (self, Context ctx)
Option|None	get_help_option (self, Context ctx)
_OptionParser	make_parser (self, Context ctx)
str	get_help (self, Context ctx)
str	get_short_help_str (self, int limit=45)
None	format_help (self, Context ctx, HelpFormatter formatter)
None	format_help_text (self, Context ctx, HelpFormatter formatter)
None	format_epilog (self, Context ctx, HelpFormatter formatter)
Context	make_context (self, str|None info_name, list[str] args, Context|None parent=None, **t.Any extra)
t.NoReturn	main (self, cabc.Sequence[str]|None args=None, str|None prog_name=None, str|None complete_var=None, t.Literal[True] standalone_mode=True, **t.Any extra)
t.Any	main (self, cabc.Sequence[str]|None args=None, str|None prog_name=None, str|None complete_var=None, bool standalone_mode=..., **t.Any extra)
t.Any	main (self, cabc.Sequence[str]|None args=None, str|None prog_name=None, str|None complete_var=None, bool standalone_mode=True, bool windows_expand_args=True, **t.Any extra)
t.Any	__call__ (self, *t.Any args, **t.Any kwargs)

Additional Inherited Members
Public Attributes inherited from click.core.Group
	no_args_is_help
	invoke_without_command
	subcommand_metavar
	chain
	commands
Public Attributes inherited from click.core.Command
	name
	callback
	help
	epilog
	options_metavar
	short_help
	add_help_option
	no_args_is_help
	hidden
	deprecated
Static Public Attributes inherited from click.core.Group
bool	allow_extra_args = True
bool	allow_interspersed_args = False
type	command_class = None
type	group_class = None
Static Public Attributes inherited from click.core.Command
type	context_class = Context
bool	allow_extra_args = False
bool	allow_interspersed_args = True
bool	ignore_unknown_options = False
Protected Member Functions inherited from click.core.Command
None	_main_shell_completion (self, cabc.MutableMapping[str, t.Any] ctx_args, str prog_name, str|None complete_var=None)
Protected Attributes inherited from click.core.Group
	_result_callback
Protected Attributes inherited from click.core.Command
	_help_option

Detailed Description

A :class:`Group` that looks up subcommands on other groups. If a command
is not found on this group, each registered source is checked in order.
Parameters on a source are not added to this group, and a source's callback
is not invoked when invoking its commands. In other words, this "flattens"
commands in many groups into this one group.

:param name: The name of the group command.
:param sources: A list of :class:`Group` objects to look up commands from.
:param kwargs: Other arguments passed to :class:`Group`.

.. versionchanged:: 8.2
    This is a subclass of ``Group``. Commands are looked up first on this
    group, then each of its sources.

Constructor & Destructor Documentation

__init__()

None click.core.CommandCollection.__init__	(		self,
		str | None	name = None,
		list[Group] | None	sources = None,
		**t.Any	kwargs
	)

Reimplemented from click.core.Group.

Member Function Documentation

add_source()

None click.core.CommandCollection.add_source	(		self,
		Group	group
	)

Add a group as a source of commands.

get_command()

Command | None click.core.CommandCollection.get_command	(		self,
		Context	ctx,
		str	cmd_name
	)

Given a context and a command name, this returns a :class:`Command`
object if it exists or returns ``None``.

Reimplemented from click.core.Group.

list_commands()

list[str] click.core.CommandCollection.list_commands	(		self,
		Context	ctx
	)

Returns a list of subcommand names in the order they should appear.

Reimplemented from click.core.Group.

---

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

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