click.palletsprojects.com

https://click.palletsprojects.com/en/latest

py:exception

Identifier Project Name Version Location Display Name Usage example
click.Abort Click 8.5.x api/#click.Abort - :py:exception:`click.Abort`
click.BadArgumentUsage Click 8.5.x api/#click.BadArgumentUsage - :py:exception:`click.BadArgumentUsage`
click.BadOptionUsage Click 8.5.x api/#click.BadOptionUsage - :py:exception:`click.BadOptionUsage`
click.BadParameter Click 8.5.x api/#click.BadParameter - :py:exception:`click.BadParameter`
click.ClickException Click 8.5.x api/#click.ClickException - :py:exception:`click.ClickException`
click.FileError Click 8.5.x api/#click.FileError - :py:exception:`click.FileError`
click.NoSuchCommand Click 8.5.x api/#click.NoSuchCommand - :py:exception:`click.NoSuchCommand`
click.NoSuchOption Click 8.5.x api/#click.NoSuchOption - :py:exception:`click.NoSuchOption`
click.UsageError Click 8.5.x api/#click.UsageError - :py:exception:`click.UsageError`
click.exceptions.Abort Click 8.5.x api/#click.Abort - :py:exception:`click.exceptions.Abort`
click.exceptions.BadArgumentUsage Click 8.5.x api/#click.BadArgumentUsage - :py:exception:`click.exceptions.BadArgumentUsage`
click.exceptions.BadOptionUsage Click 8.5.x api/#click.BadOptionUsage - :py:exception:`click.exceptions.BadOptionUsage`
click.exceptions.BadParameter Click 8.5.x api/#click.BadParameter - :py:exception:`click.exceptions.BadParameter`
click.exceptions.ClickException Click 8.5.x api/#click.ClickException - :py:exception:`click.exceptions.ClickException`
click.exceptions.FileError Click 8.5.x api/#click.FileError - :py:exception:`click.exceptions.FileError`
click.exceptions.NoSuchCommand Click 8.5.x api/#click.NoSuchCommand - :py:exception:`click.exceptions.NoSuchCommand`
click.exceptions.NoSuchOption Click 8.5.x api/#click.NoSuchOption - :py:exception:`click.exceptions.NoSuchOption`
click.exceptions.UsageError Click 8.5.x api/#click.UsageError - :py:exception:`click.exceptions.UsageError`

py:class

Identifier Project Name Version Location Display Name Usage example
click.Argument Click 8.5.x api/#click.Argument - :py:class:`click.Argument`
click.Choice Click 8.5.x api/#click.Choice - :py:class:`click.Choice`
click.Command Click 8.5.x api/#click.Command - :py:class:`click.Command`
click.CommandCollection Click 8.5.x api/#click.CommandCollection - :py:class:`click.CommandCollection`
click.Context Click 8.5.x api/#click.Context - :py:class:`click.Context`
click.DateTime Click 8.5.x api/#click.DateTime - :py:class:`click.DateTime`
click.File Click 8.5.x api/#click.File - :py:class:`click.File`
click.FloatRange Click 8.5.x api/#click.FloatRange - :py:class:`click.FloatRange`
click.Group Click 8.5.x api/#click.Group - :py:class:`click.Group`
click.HelpFormatter Click 8.5.x api/#click.HelpFormatter - :py:class:`click.HelpFormatter`
click.IntRange Click 8.5.x api/#click.IntRange - :py:class:`click.IntRange`
click.Option Click 8.5.x api/#click.Option - :py:class:`click.Option`
click.ParamType Click 8.5.x api/#click.ParamType - :py:class:`click.ParamType`
click.Parameter Click 8.5.x api/#click.Parameter - :py:class:`click.Parameter`
click.Path Click 8.5.x api/#click.Path - :py:class:`click.Path`
click.Tuple Click 8.5.x api/#click.Tuple - :py:class:`click.Tuple`
click.core.Argument Click 8.5.x api/#click.Argument - :py:class:`click.core.Argument`
click.core.Command Click 8.5.x api/#click.Command - :py:class:`click.core.Command`
click.core.CommandCollection Click 8.5.x api/#click.CommandCollection - :py:class:`click.core.CommandCollection`
click.core.Context Click 8.5.x api/#click.Context - :py:class:`click.core.Context`
click.core.Group Click 8.5.x api/#click.Group - :py:class:`click.core.Group`
click.core.Option Click 8.5.x api/#click.Option - :py:class:`click.core.Option`
click.core.Parameter Click 8.5.x api/#click.Parameter - :py:class:`click.core.Parameter`
click.core.ParameterSource Click 8.5.x api/#click.core.ParameterSource - :py:class:`click.core.ParameterSource`
click.formatting.HelpFormatter Click 8.5.x api/#click.HelpFormatter - :py:class:`click.formatting.HelpFormatter`
click.shell_completion.CompletionItem Click 8.5.x api/#click.shell_completion.CompletionItem - :py:class:`click.shell_completion.CompletionItem`
click.shell_completion.ShellComplete Click 8.5.x api/#click.shell_completion.ShellComplete - :py:class:`click.shell_completion.ShellComplete`
click.testing.CliRunner Click 8.5.x api/#click.testing.CliRunner - :py:class:`click.testing.CliRunner`
click.testing.Result Click 8.5.x api/#click.testing.Result - :py:class:`click.testing.Result`
click.types.Choice Click 8.5.x api/#click.Choice - :py:class:`click.types.Choice`
click.types.DateTime Click 8.5.x api/#click.DateTime - :py:class:`click.types.DateTime`
click.types.File Click 8.5.x api/#click.File - :py:class:`click.types.File`
click.types.FloatRange Click 8.5.x api/#click.FloatRange - :py:class:`click.types.FloatRange`
click.types.IntRange Click 8.5.x api/#click.IntRange - :py:class:`click.types.IntRange`
click.types.ParamType Click 8.5.x api/#click.ParamType - :py:class:`click.types.ParamType`
click.types.Path Click 8.5.x api/#click.Path - :py:class:`click.types.Path`
click.types.Tuple Click 8.5.x api/#click.Tuple - :py:class:`click.types.Tuple`

py:data

Identifier Project Name Version Location Display Name Usage example
click.BOOL Click 8.5.x api/#click.BOOL - :py:data:`click.BOOL`
click.FLOAT Click 8.5.x api/#click.FLOAT - :py:data:`click.FLOAT`
click.INT Click 8.5.x api/#click.INT - :py:data:`click.INT`
click.STRING Click 8.5.x api/#click.STRING - :py:data:`click.STRING`
click.UNPROCESSED Click 8.5.x api/#click.UNPROCESSED - :py:data:`click.UNPROCESSED`
click.UUID Click 8.5.x api/#click.UUID - :py:data:`click.UUID`

py:attribute

Identifier Project Name Version Location Display Name Usage example
click.BaseCommand Click 8.5.x api/#click.BaseCommand - :py:attribute:`click.BaseCommand`
click.Choice.name Click 8.5.x api/#click.Choice.name - :py:attribute:`click.Choice.name`
click.Command.allow_extra_args Click 8.5.x api/#click.Command.allow_extra_args - :py:attribute:`click.Command.allow_extra_args`
click.Command.allow_interspersed_args Click 8.5.x api/#click.Command.allow_interspersed_args - :py:attribute:`click.Command.allow_interspersed_args`
click.Command.callback Click 8.5.x api/#click.Command.callback - :py:attribute:`click.Command.callback`
click.Command.context_class Click 8.5.x api/#click.Command.context_class - :py:attribute:`click.Command.context_class`
click.Command.context_settings Click 8.5.x api/#click.Command.context_settings - :py:attribute:`click.Command.context_settings`
click.Command.ignore_unknown_options Click 8.5.x api/#click.Command.ignore_unknown_options - :py:attribute:`click.Command.ignore_unknown_options`
click.Command.name Click 8.5.x api/#click.Command.name - :py:attribute:`click.Command.name`
click.Command.params Click 8.5.x api/#click.Command.params - :py:attribute:`click.Command.params`
click.CommandCollection.sources Click 8.5.x api/#click.CommandCollection.sources - :py:attribute:`click.CommandCollection.sources`
click.Context.allow_extra_args Click 8.5.x api/#click.Context.allow_extra_args - :py:attribute:`click.Context.allow_extra_args`
click.Context.allow_interspersed_args Click 8.5.x api/#click.Context.allow_interspersed_args - :py:attribute:`click.Context.allow_interspersed_args`
click.Context.args Click 8.5.x api/#click.Context.args - :py:attribute:`click.Context.args`
click.Context.color Click 8.5.x api/#click.Context.color - :py:attribute:`click.Context.color`
click.Context.command Click 8.5.x api/#click.Context.command - :py:attribute:`click.Context.command`
click.Context.formatter_class Click 8.5.x api/#click.Context.formatter_class - :py:attribute:`click.Context.formatter_class`
click.Context.help_option_names Click 8.5.x api/#click.Context.help_option_names - :py:attribute:`click.Context.help_option_names`
click.Context.ignore_unknown_options Click 8.5.x api/#click.Context.ignore_unknown_options - :py:attribute:`click.Context.ignore_unknown_options`
click.Context.info_name Click 8.5.x api/#click.Context.info_name - :py:attribute:`click.Context.info_name`
click.Context.invoked_subcommand Click 8.5.x api/#click.Context.invoked_subcommand - :py:attribute:`click.Context.invoked_subcommand`
click.Context.max_content_width Click 8.5.x api/#click.Context.max_content_width - :py:attribute:`click.Context.max_content_width`
click.Context.obj Click 8.5.x api/#click.Context.obj - :py:attribute:`click.Context.obj`
click.Context.params Click 8.5.x api/#click.Context.params - :py:attribute:`click.Context.params`
click.Context.parent Click 8.5.x api/#click.Context.parent - :py:attribute:`click.Context.parent`
click.Context.resilient_parsing Click 8.5.x api/#click.Context.resilient_parsing - :py:attribute:`click.Context.resilient_parsing`
click.Context.show_default Click 8.5.x api/#click.Context.show_default - :py:attribute:`click.Context.show_default`
click.Context.terminal_width Click 8.5.x api/#click.Context.terminal_width - :py:attribute:`click.Context.terminal_width`
click.Context.token_normalize_func Click 8.5.x api/#click.Context.token_normalize_func - :py:attribute:`click.Context.token_normalize_func`
click.Group.allow_extra_args Click 8.5.x api/#click.Group.allow_extra_args - :py:attribute:`click.Group.allow_extra_args`
click.Group.allow_interspersed_args Click 8.5.x api/#click.Group.allow_interspersed_args - :py:attribute:`click.Group.allow_interspersed_args`
click.Group.command_class Click 8.5.x api/#click.Group.command_class - :py:attribute:`click.Group.command_class`
click.Group.commands Click 8.5.x api/#click.Group.commands - :py:attribute:`click.Group.commands`
click.Group.group_class Click 8.5.x api/#click.Group.group_class - :py:attribute:`click.Group.group_class`
click.MultiCommand Click 8.5.x api/#click.MultiCommand - :py:attribute:`click.MultiCommand`
click.OptionParser Click 8.5.x api/#click.OptionParser - :py:attribute:`click.OptionParser`
click.ParamType.envvar_list_splitter Click 8.5.x api/#click.ParamType.envvar_list_splitter - :py:attribute:`click.ParamType.envvar_list_splitter`
click.ParamType.name Click 8.5.x api/#click.ParamType.name - :py:attribute:`click.ParamType.name`
click.core.ParameterSource.COMMANDLINE Click 8.5.x api/#click.core.ParameterSource.COMMANDLINE - :py:attribute:`click.core.ParameterSource.COMMANDLINE`
click.core.ParameterSource.DEFAULT Click 8.5.x api/#click.core.ParameterSource.DEFAULT - :py:attribute:`click.core.ParameterSource.DEFAULT`
click.core.ParameterSource.DEFAULT_MAP Click 8.5.x api/#click.core.ParameterSource.DEFAULT_MAP - :py:attribute:`click.core.ParameterSource.DEFAULT_MAP`
click.core.ParameterSource.ENVIRONMENT Click 8.5.x api/#click.core.ParameterSource.ENVIRONMENT - :py:attribute:`click.core.ParameterSource.ENVIRONMENT`
click.core.ParameterSource.PROMPT Click 8.5.x api/#click.core.ParameterSource.PROMPT - :py:attribute:`click.core.ParameterSource.PROMPT`
click.shell_completion.ShellComplete.name Click 8.5.x api/#click.shell_completion.ShellComplete.name - :py:attribute:`click.shell_completion.ShellComplete.name`
click.shell_completion.ShellComplete.source_template Click 8.5.x api/#click.shell_completion.ShellComplete.source_template - :py:attribute:`click.shell_completion.ShellComplete.source_template`

py:method

Identifier Project Name Version Location Display Name Usage example
click.Choice.convert Click 8.5.x api/#click.Choice.convert - :py:method:`click.Choice.convert`
click.Choice.get_invalid_choice_message Click 8.5.x api/#click.Choice.get_invalid_choice_message - :py:method:`click.Choice.get_invalid_choice_message`
click.Choice.get_metavar Click 8.5.x api/#click.Choice.get_metavar - :py:method:`click.Choice.get_metavar`
click.Choice.get_missing_message Click 8.5.x api/#click.Choice.get_missing_message - :py:method:`click.Choice.get_missing_message`
click.Choice.normalize_choice Click 8.5.x api/#click.Choice.normalize_choice - :py:method:`click.Choice.normalize_choice`
click.Choice.shell_complete Click 8.5.x api/#click.Choice.shell_complete - :py:method:`click.Choice.shell_complete`
click.Choice.to_info_dict Click 8.5.x api/#click.Choice.to_info_dict - :py:method:`click.Choice.to_info_dict`
click.Command.collect_usage_pieces Click 8.5.x api/#click.Command.collect_usage_pieces - :py:method:`click.Command.collect_usage_pieces`
click.Command.format_arguments Click 8.5.x api/#click.Command.format_arguments - :py:method:`click.Command.format_arguments`
click.Command.format_epilog Click 8.5.x api/#click.Command.format_epilog - :py:method:`click.Command.format_epilog`
click.Command.format_help Click 8.5.x api/#click.Command.format_help - :py:method:`click.Command.format_help`
click.Command.format_help_text Click 8.5.x api/#click.Command.format_help_text - :py:method:`click.Command.format_help_text`
click.Command.format_options Click 8.5.x api/#click.Command.format_options - :py:method:`click.Command.format_options`
click.Command.format_usage Click 8.5.x api/#click.Command.format_usage - :py:method:`click.Command.format_usage`
click.Command.get_help Click 8.5.x api/#click.Command.get_help - :py:method:`click.Command.get_help`
click.Command.get_help_option Click 8.5.x api/#click.Command.get_help_option - :py:method:`click.Command.get_help_option`
click.Command.get_help_option_names Click 8.5.x api/#click.Command.get_help_option_names - :py:method:`click.Command.get_help_option_names`
click.Command.get_short_help_str Click 8.5.x api/#click.Command.get_short_help_str - :py:method:`click.Command.get_short_help_str`
click.Command.get_usage Click 8.5.x api/#click.Command.get_usage - :py:method:`click.Command.get_usage`
click.Command.invoke Click 8.5.x api/#click.Command.invoke - :py:method:`click.Command.invoke`
click.Command.main Click 8.5.x api/#click.Command.main - :py:method:`click.Command.main`
click.Command.make_context Click 8.5.x api/#click.Command.make_context - :py:method:`click.Command.make_context`
click.Command.make_parser Click 8.5.x api/#click.Command.make_parser - :py:method:`click.Command.make_parser`
click.Command.shell_complete Click 8.5.x api/#click.Command.shell_complete - :py:method:`click.Command.shell_complete`
click.CommandCollection.add_source Click 8.5.x api/#click.CommandCollection.add_source - :py:method:`click.CommandCollection.add_source`
click.CommandCollection.get_command Click 8.5.x api/#click.CommandCollection.get_command - :py:method:`click.CommandCollection.get_command`
click.CommandCollection.list_commands Click 8.5.x api/#click.CommandCollection.list_commands - :py:method:`click.CommandCollection.list_commands`
click.Context.abort Click 8.5.x api/#click.Context.abort - :py:method:`click.Context.abort`
click.Context.call_on_close Click 8.5.x api/#click.Context.call_on_close - :py:method:`click.Context.call_on_close`
click.Context.close Click 8.5.x api/#click.Context.close - :py:method:`click.Context.close`
click.Context.ensure_object Click 8.5.x api/#click.Context.ensure_object - :py:method:`click.Context.ensure_object`
click.Context.exit Click 8.5.x api/#click.Context.exit - :py:method:`click.Context.exit`
click.Context.fail Click 8.5.x api/#click.Context.fail - :py:method:`click.Context.fail`
click.Context.find_object Click 8.5.x api/#click.Context.find_object - :py:method:`click.Context.find_object`
click.Context.find_root Click 8.5.x api/#click.Context.find_root - :py:method:`click.Context.find_root`
click.Context.forward Click 8.5.x api/#click.Context.forward - :py:method:`click.Context.forward`
click.Context.get_help Click 8.5.x api/#click.Context.get_help - :py:method:`click.Context.get_help`
click.Context.get_parameter_source Click 8.5.x api/#click.Context.get_parameter_source - :py:method:`click.Context.get_parameter_source`
click.Context.get_usage Click 8.5.x api/#click.Context.get_usage - :py:method:`click.Context.get_usage`
click.Context.invoke Click 8.5.x api/#click.Context.invoke - :py:method:`click.Context.invoke`
click.Context.lookup_default Click 8.5.x api/#click.Context.lookup_default - :py:method:`click.Context.lookup_default`
click.Context.make_formatter Click 8.5.x api/#click.Context.make_formatter - :py:method:`click.Context.make_formatter`
click.Context.scope Click 8.5.x api/#click.Context.scope - :py:method:`click.Context.scope`
click.Context.set_parameter_source Click 8.5.x api/#click.Context.set_parameter_source - :py:method:`click.Context.set_parameter_source`
click.Context.to_info_dict Click 8.5.x api/#click.Context.to_info_dict - :py:method:`click.Context.to_info_dict`
click.Context.with_resource Click 8.5.x api/#click.Context.with_resource - :py:method:`click.Context.with_resource`
click.Group.add_command Click 8.5.x api/#click.Group.add_command - :py:method:`click.Group.add_command`
click.Group.collect_usage_pieces Click 8.5.x api/#click.Group.collect_usage_pieces - :py:method:`click.Group.collect_usage_pieces`
click.Group.command Click 8.5.x api/#click.Group.command - :py:method:`click.Group.command`
click.Group.format_commands Click 8.5.x api/#click.Group.format_commands - :py:method:`click.Group.format_commands`
click.Group.format_options Click 8.5.x api/#click.Group.format_options - :py:method:`click.Group.format_options`
click.Group.get_command Click 8.5.x api/#click.Group.get_command - :py:method:`click.Group.get_command`
click.Group.group Click 8.5.x api/#click.Group.group - :py:method:`click.Group.group`
click.Group.invoke Click 8.5.x api/#click.Group.invoke - :py:method:`click.Group.invoke`
click.Group.list_commands Click 8.5.x api/#click.Group.list_commands - :py:method:`click.Group.list_commands`
click.Group.result_callback Click 8.5.x api/#click.Group.result_callback - :py:method:`click.Group.result_callback`
click.Group.shell_complete Click 8.5.x api/#click.Group.shell_complete - :py:method:`click.Group.shell_complete`
click.HelpFormatter.dedent Click 8.5.x api/#click.HelpFormatter.dedent - :py:method:`click.HelpFormatter.dedent`
click.HelpFormatter.getvalue Click 8.5.x api/#click.HelpFormatter.getvalue - :py:method:`click.HelpFormatter.getvalue`
click.HelpFormatter.indent Click 8.5.x api/#click.HelpFormatter.indent - :py:method:`click.HelpFormatter.indent`
click.HelpFormatter.indentation Click 8.5.x api/#click.HelpFormatter.indentation - :py:method:`click.HelpFormatter.indentation`
click.HelpFormatter.section Click 8.5.x api/#click.HelpFormatter.section - :py:method:`click.HelpFormatter.section`
click.HelpFormatter.write Click 8.5.x api/#click.HelpFormatter.write - :py:method:`click.HelpFormatter.write`
click.HelpFormatter.write_dl Click 8.5.x api/#click.HelpFormatter.write_dl - :py:method:`click.HelpFormatter.write_dl`
click.HelpFormatter.write_heading Click 8.5.x api/#click.HelpFormatter.write_heading - :py:method:`click.HelpFormatter.write_heading`
click.HelpFormatter.write_paragraph Click 8.5.x api/#click.HelpFormatter.write_paragraph - :py:method:`click.HelpFormatter.write_paragraph`
click.HelpFormatter.write_text Click 8.5.x api/#click.HelpFormatter.write_text - :py:method:`click.HelpFormatter.write_text`
click.HelpFormatter.write_usage Click 8.5.x api/#click.HelpFormatter.write_usage - :py:method:`click.HelpFormatter.write_usage`
click.ParamType.convert Click 8.5.x api/#click.ParamType.convert - :py:method:`click.ParamType.convert`
click.ParamType.fail Click 8.5.x api/#click.ParamType.fail - :py:method:`click.ParamType.fail`
click.ParamType.get_metavar Click 8.5.x api/#click.ParamType.get_metavar - :py:method:`click.ParamType.get_metavar`
click.ParamType.get_missing_message Click 8.5.x api/#click.ParamType.get_missing_message - :py:method:`click.ParamType.get_missing_message`
click.ParamType.shell_complete Click 8.5.x api/#click.ParamType.shell_complete - :py:method:`click.ParamType.shell_complete`
click.ParamType.split_envvar_value Click 8.5.x api/#click.ParamType.split_envvar_value - :py:method:`click.ParamType.split_envvar_value`
click.ParamType.to_info_dict Click 8.5.x api/#click.ParamType.to_info_dict - :py:method:`click.ParamType.to_info_dict`
click.Parameter.get_default Click 8.5.x api/#click.Parameter.get_default - :py:method:`click.Parameter.get_default`
click.Parameter.get_error_hint Click 8.5.x api/#click.Parameter.get_error_hint - :py:method:`click.Parameter.get_error_hint`
click.Parameter.shell_complete Click 8.5.x api/#click.Parameter.shell_complete - :py:method:`click.Parameter.shell_complete`
click.Parameter.to_info_dict Click 8.5.x api/#click.Parameter.to_info_dict - :py:method:`click.Parameter.to_info_dict`
click.Parameter.type_cast_value Click 8.5.x api/#click.Parameter.type_cast_value - :py:method:`click.Parameter.type_cast_value`
click.shell_completion.ShellComplete.complete Click 8.5.x api/#click.shell_completion.ShellComplete.complete - :py:method:`click.shell_completion.ShellComplete.complete`
click.shell_completion.ShellComplete.format_completion Click 8.5.x api/#click.shell_completion.ShellComplete.format_completion - :py:method:`click.shell_completion.ShellComplete.format_completion`
click.shell_completion.ShellComplete.get_completion_args Click 8.5.x api/#click.shell_completion.ShellComplete.get_completion_args - :py:method:`click.shell_completion.ShellComplete.get_completion_args`
click.shell_completion.ShellComplete.get_completions Click 8.5.x api/#click.shell_completion.ShellComplete.get_completions - :py:method:`click.shell_completion.ShellComplete.get_completions`
click.shell_completion.ShellComplete.source Click 8.5.x api/#click.shell_completion.ShellComplete.source - :py:method:`click.shell_completion.ShellComplete.source`
click.shell_completion.ShellComplete.source_vars Click 8.5.x api/#click.shell_completion.ShellComplete.source_vars - :py:method:`click.shell_completion.ShellComplete.source_vars`
click.testing.CliRunner.get_default_prog_name Click 8.5.x api/#click.testing.CliRunner.get_default_prog_name - :py:method:`click.testing.CliRunner.get_default_prog_name`
click.testing.CliRunner.invoke Click 8.5.x api/#click.testing.CliRunner.invoke - :py:method:`click.testing.CliRunner.invoke`
click.testing.CliRunner.isolated_filesystem Click 8.5.x api/#click.testing.CliRunner.isolated_filesystem - :py:method:`click.testing.CliRunner.isolated_filesystem`
click.testing.CliRunner.isolation Click 8.5.x api/#click.testing.CliRunner.isolation - :py:method:`click.testing.CliRunner.isolation`
click.testing.CliRunner.make_env Click 8.5.x api/#click.testing.CliRunner.make_env - :py:method:`click.testing.CliRunner.make_env`

py:property

Identifier Project Name Version Location Display Name Usage example
click.Context.command_path Click 8.5.x api/#click.Context.command_path - :py:property:`click.Context.command_path`
click.Context.meta Click 8.5.x api/#click.Context.meta - :py:property:`click.Context.meta`
click.Parameter.human_readable_name Click 8.5.x api/#click.Parameter.human_readable_name - :py:property:`click.Parameter.human_readable_name`
click.shell_completion.ShellComplete.func_name Click 8.5.x api/#click.shell_completion.ShellComplete.func_name - :py:property:`click.shell_completion.ShellComplete.func_name`
click.testing.Result.output Click 8.5.x api/#click.testing.Result.output - :py:property:`click.testing.Result.output`
click.testing.Result.stderr Click 8.5.x api/#click.testing.Result.stderr - :py:property:`click.testing.Result.stderr`
click.testing.Result.stdout Click 8.5.x api/#click.testing.Result.stdout - :py:property:`click.testing.Result.stdout`

py:function

Identifier Project Name Version Location Display Name Usage example
click.argument Click 8.5.x api/#click.argument - :py:function:`click.argument`
click.clear Click 8.5.x api/#click.clear - :py:function:`click.clear`
click.command Click 8.5.x api/#click.command - :py:function:`click.command`
click.confirm Click 8.5.x api/#click.confirm - :py:function:`click.confirm`
click.confirmation_option Click 8.5.x api/#click.confirmation_option - :py:function:`click.confirmation_option`
click.decorators.pass_meta_key Click 8.5.x api/#click.decorators.pass_meta_key - :py:function:`click.decorators.pass_meta_key`
click.echo Click 8.5.x api/#click.echo - :py:function:`click.echo`
click.echo_via_pager Click 8.5.x api/#click.echo_via_pager - :py:function:`click.echo_via_pager`
click.edit Click 8.5.x api/#click.edit - :py:function:`click.edit`
click.format_filename Click 8.5.x api/#click.format_filename - :py:function:`click.format_filename`
click.get_app_dir Click 8.5.x api/#click.get_app_dir - :py:function:`click.get_app_dir`
click.get_binary_stream Click 8.5.x api/#click.get_binary_stream - :py:function:`click.get_binary_stream`
click.get_current_context Click 8.5.x api/#click.get_current_context - :py:function:`click.get_current_context`
click.get_pager_file Click 8.5.x api/#click.get_pager_file - :py:function:`click.get_pager_file`
click.get_text_stream Click 8.5.x api/#click.get_text_stream - :py:function:`click.get_text_stream`
click.getchar Click 8.5.x api/#click.getchar - :py:function:`click.getchar`
click.group Click 8.5.x api/#click.group - :py:function:`click.group`
click.help_option Click 8.5.x api/#click.help_option - :py:function:`click.help_option`
click.launch Click 8.5.x api/#click.launch - :py:function:`click.launch`
click.make_pass_decorator Click 8.5.x api/#click.make_pass_decorator - :py:function:`click.make_pass_decorator`
click.open_file Click 8.5.x api/#click.open_file - :py:function:`click.open_file`
click.option Click 8.5.x api/#click.option - :py:function:`click.option`
click.pass_context Click 8.5.x api/#click.pass_context - :py:function:`click.pass_context`
click.pass_obj Click 8.5.x api/#click.pass_obj - :py:function:`click.pass_obj`
click.password_option Click 8.5.x api/#click.password_option - :py:function:`click.password_option`
click.pause Click 8.5.x api/#click.pause - :py:function:`click.pause`
click.progressbar Click 8.5.x api/#click.progressbar - :py:function:`click.progressbar`
click.prompt Click 8.5.x api/#click.prompt - :py:function:`click.prompt`
click.secho Click 8.5.x api/#click.secho - :py:function:`click.secho`
click.shell_completion.add_completion_class Click 8.5.x api/#click.shell_completion.add_completion_class - :py:function:`click.shell_completion.add_completion_class`
click.style Click 8.5.x api/#click.style - :py:function:`click.style`
click.unstyle Click 8.5.x api/#click.unstyle - :py:function:`click.unstyle`
click.version_option Click 8.5.x api/#click.version_option - :py:function:`click.version_option`
click.wrap_text Click 8.5.x api/#click.wrap_text - :py:function:`click.wrap_text`

std:doc

Identifier Project Name Version Location Display Name Usage example
advanced Click 8.5.x advanced/ Advanced Patterns :std:doc:`advanced`
api Click 8.5.x api/ API :std:doc:`api`
arguments Click 8.5.x arguments/ Arguments :std:doc:`arguments`
changes Click 8.5.x changes/ Changes :std:doc:`changes`
click-concepts Click 8.5.x click-concepts/ Click Concepts :std:doc:`click-concepts`
command-line-reference Click 8.5.x command-line-reference/ General Command Line Topics :std:doc:`command-line-reference`
commands Click 8.5.x commands/ Advanced Groups and Context :std:doc:`commands`
commands-and-groups Click 8.5.x commands-and-groups/ Basic Commands, Groups, Context :std:doc:`commands-and-groups`
complex Click 8.5.x complex/ Complex Applications :std:doc:`complex`
contrib Click 8.5.x contrib/ click-contrib :std:doc:`contrib`
contributing Click 8.5.x contributing/ Contributing :std:doc:`contributing`
design-opinions Click 8.5.x design-opinions/ CLI Design Opinions :std:doc:`design-opinions`
documentation Click 8.5.x documentation/ Help Pages :std:doc:`documentation`
entry-points Click 8.5.x entry-points/ Packaging Entry Points :std:doc:`entry-points`
exceptions Click 8.5.x exceptions/ Exception Handling and Exit Codes :std:doc:`exceptions`
extending-click Click 8.5.x extending-click/ Extending Click :std:doc:`extending-click`
faqs Click 8.5.x faqs/ Frequently Asked Questions :std:doc:`faqs`
handling-files Click 8.5.x handling-files/ Handling Files :std:doc:`handling-files`
license Click 8.5.x license/ BSD-3-Clause License :std:doc:`license`
option-decorators Click 8.5.x option-decorators/ Options Shortcut Decorators :std:doc:`option-decorators`
options Click 8.5.x options/ Options :std:doc:`options`
parameter-types Click 8.5.x parameter-types/ Parameter Types :std:doc:`parameter-types`
parameters Click 8.5.x parameters/ Parameters :std:doc:`parameters`
prompts Click 8.5.x prompts/ User Input Prompts :std:doc:`prompts`
quickstart Click 8.5.x quickstart/ Quickstart :std:doc:`quickstart`
setuptools Click 8.5.x setuptools/ Setuptools Integration :std:doc:`setuptools`
shell-completion Click 8.5.x shell-completion/ Shell Completion :std:doc:`shell-completion`
standalone-apps Click 8.5.x standalone-apps/ Standalone Application with Briefcase :std:doc:`standalone-apps`
support-multiple-versions Click 8.5.x support-multiple-versions/ Supporting Multiple Versions :std:doc:`support-multiple-versions`
testing Click 8.5.x testing/ Testing Click Applications :std:doc:`testing`
unicode-support Click 8.5.x unicode-support/ Unicode Support :std:doc:`unicode-support`
upgrade-guides Click 8.5.x upgrade-guides/ Upgrade Guides :std:doc:`upgrade-guides`
utils Click 8.5.x utils/ Utilities :std:doc:`utils`
virtualenv Click 8.5.x virtualenv/ Virtualenv :std:doc:`virtualenv`
why Click 8.5.x why/ Why Click? :std:doc:`why`
wincmd Click 8.5.x wincmd/ Windows Console Notes :std:doc:`wincmd`

std:label

Identifier Project Name Version Location Display Name Usage example
aliases Click 8.5.x extending-click/#aliases Command Aliases :std:ref:`aliases`
ansi-colors Click 8.5.x utils/#ansi-colors ANSI Colors :std:ref:`ansi-colors`
arguments Click 8.5.x arguments/#arguments Arguments :std:ref:`arguments`
callback-evaluation-order Click 8.5.x click-concepts/#callback-evaluation-order Callback Evaluation Order :std:ref:`callback-evaluation-order`
choice-opts Click 8.5.x parameter-types/#choice-opts Choice :std:ref:`choice-opts`
click-api-types Click 8.5.x api/#click-api-types Types :std:ref:`click-api-types`
command-chaining Click 8.5.x commands/#command-chaining Command Chaining :std:ref:`command-chaining`
command-pipelines Click 8.5.x commands/#command-pipelines Command Pipelines :std:ref:`command-pipelines`
complex-guide Click 8.5.x complex/#complex-guide Complex Applications :std:ref:`complex-guide`
contrib Click 8.5.x contrib/#contrib click-contrib :std:ref:`contrib`
custom-groups Click 8.5.x extending-click/#custom-groups Custom Groups :std:ref:`custom-groups`
doc-meta-variables Click 8.5.x documentation/#doc-meta-variables Placeholder / Meta Variable :std:ref:`doc-meta-variables`
documenting-arguments Click 8.5.x documentation/#documenting-arguments Documenting Arguments :std:ref:`documenting-arguments`
environment-variables Click 8.5.x arguments/#environment-variables Environment Variables :std:ref:`environment-variables`
exception-handling-exit-codes Click 8.5.x exceptions/#exception-handling-exit-codes Exception Handling and Exit Codes :std:ref:`exception-handling-exit-codes`
exit-codes Click 8.5.x command-line-reference/#exit-codes Exit Codes :std:ref:`exit-codes`
file-args Click 8.5.x handling-files/#file-args File Arguments :std:ref:`file-args`
forwarding-unknown-options Click 8.5.x advanced/#forwarding-unknown-options Forwarding Unknown Options :std:ref:`forwarding-unknown-options`
genindex Click 8.5.x genindex/ Index :std:ref:`genindex`
handling-files Click 8.5.x handling-files/#handling-files Handling Files :std:ref:`handling-files`
help-page-exit-codes Click 8.5.x exceptions/#help-page-exit-codes Help Pages and Exit Codes :std:ref:`help-page-exit-codes`
modindex Click 8.5.x py-modindex/ Module Index :std:ref:`modindex`
multiple-options Click 8.5.x options/#multiple-options Multiple Options :std:ref:`multiple-options`
option-boolean-flag Click 8.5.x options/#option-boolean-flag Boolean :std:ref:`option-boolean-flag`
option-prompting Click 8.5.x prompts/#option-prompting Option Prompts :std:ref:`option-prompting`
optional-value Click 8.5.x options/#optional-value Optional Value :std:ref:`optional-value`
options Click 8.5.x options/#options Options :std:ref:`options`
parameter-names Click 8.5.x parameters/#parameter-names Parameter Names :std:ref:`parameter-names`
parameter-types Click 8.5.x parameter-types/#parameter-types Parameter Types :std:ref:`parameter-types`
parameters Click 8.5.x parameters/#parameters Parameters :std:ref:`parameters`
py-modindex Click 8.5.x py-modindex/ Python Module Index :std:ref:`py-modindex`
ranges Click 8.5.x parameter-types/#ranges Int and Float Ranges :std:ref:`ranges`
search Click 8.5.x search/ Search Page :std:ref:`search`
shell-completion Click 8.5.x shell-completion/#shell-completion Shell Completion :std:ref:`shell-completion`
testing Click 8.5.x api/#testing Testing :std:ref:`testing`
tuple-type Click 8.5.x options/#tuple-type Multi Value Options as Tuples :std:ref:`tuple-type`
version 1.0 Click 8.5.x changes/#version-1-0 Version 1.0 :std:ref:`version 1.0`
version 1.1 Click 8.5.x changes/#version-1-1 Version 1.1 :std:ref:`version 1.1`
version 2.0 Click 8.5.x changes/#version-2-0 Version 2.0 :std:ref:`version 2.0`
version 2.1 Click 8.5.x changes/#version-2-1 Version 2.1 :std:ref:`version 2.1`
version 2.2 Click 8.5.x changes/#version-2-2 Version 2.2 :std:ref:`version 2.2`
version 2.3 Click 8.5.x changes/#version-2-3 Version 2.3 :std:ref:`version 2.3`
version 2.4 Click 8.5.x changes/#version-2-4 Version 2.4 :std:ref:`version 2.4`
version 2.5 Click 8.5.x changes/#version-2-5 Version 2.5 :std:ref:`version 2.5`
version 2.6 Click 8.5.x changes/#version-2-6 Version 2.6 :std:ref:`version 2.6`
version 3.0 Click 8.5.x changes/#version-3-0 Version 3.0 :std:ref:`version 3.0`
version 3.1 Click 8.5.x changes/#version-3-1 Version 3.1 :std:ref:`version 3.1`
version 3.2 Click 8.5.x changes/#version-3-2 Version 3.2 :std:ref:`version 3.2`
version 3.3 Click 8.5.x changes/#version-3-3 Version 3.3 :std:ref:`version 3.3`
version 4.0 Click 8.5.x changes/#version-4-0 Version 4.0 :std:ref:`version 4.0`
version 4.1 Click 8.5.x changes/#version-4-1 Version 4.1 :std:ref:`version 4.1`
version 5.0 Click 8.5.x changes/#version-5-0 Version 5.0 :std:ref:`version 5.0`
version 5.1 Click 8.5.x changes/#version-5-1 Version 5.1 :std:ref:`version 5.1`
version 6.0 Click 8.5.x changes/#version-6-0 Version 6.0 :std:ref:`version 6.0`
version 6.1 Click 8.5.x changes/#version-6-1 Version 6.1 :std:ref:`version 6.1`
version 6.2 Click 8.5.x changes/#version-6-2 Version 6.2 :std:ref:`version 6.2`
version 6.3 Click 8.5.x changes/#version-6-3 Version 6.3 :std:ref:`version 6.3`
version 6.4 Click 8.5.x changes/#version-6-4 Version 6.4 :std:ref:`version 6.4`
version 6.6 Click 8.5.x changes/#version-6-6 Version 6.6 :std:ref:`version 6.6`
version 6.7 Click 8.5.x changes/#version-6-7 Version 6.7 :std:ref:`version 6.7`
version 7.0 Click 8.5.x changes/#version-7-0 Version 7.0 :std:ref:`version 7.0`
version 7.1 Click 8.5.x changes/#version-7-1 Version 7.1 :std:ref:`version 7.1`
version 7.1.1 Click 8.5.x changes/#version-7-1-1 Version 7.1.1 :std:ref:`version 7.1.1`
version 7.1.2 Click 8.5.x changes/#version-7-1-2 Version 7.1.2 :std:ref:`version 7.1.2`
version 8.0.0 Click 8.5.x changes/#version-8-0-0 Version 8.0.0 :std:ref:`version 8.0.0`
version 8.0.1 Click 8.5.x changes/#version-8-0-1 Version 8.0.1 :std:ref:`version 8.0.1`
version 8.0.2 Click 8.5.x changes/#version-8-0-2 Version 8.0.2 :std:ref:`version 8.0.2`
version 8.0.3 Click 8.5.x changes/#version-8-0-3 Version 8.0.3 :std:ref:`version 8.0.3`
version 8.0.4 Click 8.5.x changes/#version-8-0-4 Version 8.0.4 :std:ref:`version 8.0.4`
version 8.1.0 Click 8.5.x changes/#version-8-1-0 Version 8.1.0 :std:ref:`version 8.1.0`
version 8.1.1 Click 8.5.x changes/#version-8-1-1 Version 8.1.1 :std:ref:`version 8.1.1`
version 8.1.2 Click 8.5.x changes/#version-8-1-2 Version 8.1.2 :std:ref:`version 8.1.2`
version 8.1.3 Click 8.5.x changes/#version-8-1-3 Version 8.1.3 :std:ref:`version 8.1.3`
version 8.1.4 Click 8.5.x changes/#version-8-1-4 Version 8.1.4 :std:ref:`version 8.1.4`
version 8.1.5 Click 8.5.x changes/#version-8-1-5 Version 8.1.5 :std:ref:`version 8.1.5`
version 8.1.6 Click 8.5.x changes/#version-8-1-6 Version 8.1.6 :std:ref:`version 8.1.6`
version 8.1.7 Click 8.5.x changes/#version-8-1-7 Version 8.1.7 :std:ref:`version 8.1.7`
version 8.1.8 Click 8.5.x changes/#version-8-1-8 Version 8.1.8 :std:ref:`version 8.1.8`
version 8.2.0 Click 8.5.x changes/#version-8-2-0 Version 8.2.0 :std:ref:`version 8.2.0`
version 8.2.1 Click 8.5.x changes/#version-8-2-1 Version 8.2.1 :std:ref:`version 8.2.1`
version 8.2.2 Click 8.5.x changes/#version-8-2-2 Version 8.2.2 :std:ref:`version 8.2.2`
version 8.3.0 Click 8.5.x changes/#version-8-3-0 Version 8.3.0 :std:ref:`version 8.3.0`
version 8.3.1 Click 8.5.x changes/#version-8-3-1 Version 8.3.1 :std:ref:`version 8.3.1`
version 8.3.2 Click 8.5.x changes/#version-8-3-2 Version 8.3.2 :std:ref:`version 8.3.2`
version 8.3.3 Click 8.5.x changes/#version-8-3-3 Version 8.3.3 :std:ref:`version 8.3.3`
version 8.4.0 Click 8.5.x changes/#version-8-4-0 Version 8.4.0 :std:ref:`version 8.4.0`
version 8.4.1 Click 8.5.x changes/#version-8-4-1 Version 8.4.1 :std:ref:`version 8.4.1`
version 8.4.2 Click 8.5.x changes/#version-8-4-2 Version 8.4.2 :std:ref:`version 8.4.2`
version 8.5.0 Click 8.5.x changes/#version-8-5-0 Version 8.5.0 :std:ref:`version 8.5.0`
virtualenv-heading Click 8.5.x virtualenv/#virtualenv-heading Virtualenv :std:ref:`virtualenv-heading`