|
| None | __init__ (self, str|None name=None, cabc.MutableMapping[str, Command]|cabc.Sequence[Command]|None commands=None, bool invoke_without_command=False, bool|None no_args_is_help=None, str|None subcommand_metavar=None, bool chain=False, t.Callable[..., t.Any]|None result_callback=None, **t.Any kwargs) |
| |
| 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) |
| |
| Command|None | get_command (self, Context ctx, str cmd_name) |
| |
| list[str] | list_commands (self, Context ctx) |
| |
| 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) |
| |
|
bool | __subclasscheck__ (cls, type subclass) |
| |
|
bool | __instancecheck__ (cls, t.Any instance) |
| |
|
| 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 |
| |
|
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) |
| |
|
| _result_callback |
| |
Protected Attributes inherited from click.core.Command |
|
| _help_option |
| |
.. deprecated:: 8.2
Will be removed in Click 9.0. Use ``Group`` instead.