dob.clickux package

Submodules

dob.clickux.add_fact_help_group module

Click Group wrapper tweaks usage for the dob add --help help.

class dob.clickux.add_fact_help_group.ClickAddFactHelpGroup(*args, **kwargs)

Bases: dob.clickux.aliasable_bunchy_plugin.ClickAliasableBunchyPluginGroup

ADD_FACT_GROUP_HELP = 'add --help'

ADD_FACT_GROUP_NAME = 'add'

ADD_FACT_SKIP_ALIASED = ['on', 'until', 'next']

format_help_text(ctx, formatter)

Writes the help text to the formatter if it exists.

help_usage_command_path_postfix(ctx)

dob.clickux.aliasable_bunchy_plugin module

Click Group wrapper combines all our custom classes.

class dob.clickux.aliasable_bunchy_plugin.ClickAliasableBunchyPluginGroup(*args, **kwargs)

Bases: dob.clickux.bunchy_group.ClickBunchyGroup, click_hotoffthehamster_alias.ClickAliasedGroup, dob.clickux.plugin_group.ClickPluginGroup, dob.clickux.better_format_usage.ClickBetterUsageGroup, dob.clickux.better_help_headers.ClickBetterHeadersGroup

command(*args, **kwargs)

A shortcut decorator for declaring and attaching a command to the group. This takes the same arguments as command() but immediately registers the created command with this instance by calling into add_command().

dob.clickux.better_format_usage module

Click Group wrapper combines all our custom classes.

class dob.clickux.better_format_usage.ClickBetterUsageGroup(*args, **kwargs)

Bases: click_hotoffthehamster.core.Group

USAGE_HINT_ALL_OPTS = '--GLOBAL...'

USAGE_HINT_CMD_ARGS = 'ARGS...'

USAGE_HINT_CMD_OPTS = '--OPTION...'

collect_usage_pieces(*args, **kwargs)

Show ‘[OPTIONS]’ in usage unless command takes none.

format_help(ctx, formatter)

Override Click.Command: shorter help for commandless root command action.

format_usage(ctx, formatter)

Writes the usage line into the formatter.

This is a low-level method called by get_usage().

Overriden by dob to emphasize with _underline_ and bold.

help_usage_command_path_postfix(ctx)

dob.clickux.better_help_headers module

Click Group wrapper combines all our custom classes.

class dob.clickux.better_help_headers.ClickBetterHeadersGroup(*args, **kwargs)

Bases: click_hotoffthehamster.core.Group

help_header_commands

help_header_options

dob.clickux.bunchy_group module

Click Group wrapper adds plugin support.

class dob.clickux.bunchy_group.ClickBunchyGroup(*args, help_weight=10, **kwargs)

Bases: click_hotoffthehamster.core.Group

add_command(cmd, name=None)

Registers another Command with this group. If the name is not provided, the name of the command is used.

add_to_bunch(cmd, bunchy_name, sort_key=0)

bunchies_regroup(cmd, bunchy_name)

format_commands(ctx, formatter)

Extra format methods for multi methods that adds all the commands after the options.

format_commands_fetch(ctx, bunchy_name)

sortkeys_update(cmd, bunchy_name, sort_key)

dob.clickux.bunchy_help module

Module to define command group decorators and section headers.

dob.clickux.bunchy_help.cmd_bunch_group_add_fact(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_dbms(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_edit(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_generate_report(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_get_meta(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_introducing(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_ongoing_fact(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_personalize(cmd)

dob.clickux.bunchy_help.cmd_bunch_group_plugin(cmd)

dob.clickux.cmd_options module

dob.clickux.cmd_options.cmd_options_edit_item(func)

dob.clickux.cmd_options.cmd_options_fact_add(func)

dob.clickux.cmd_options.cmd_options_fact_dryable(func)

dob.clickux.cmd_options.cmd_options_fact_edit(func)

dob.clickux.cmd_options.cmd_options_fact_import(func)

dob.clickux.cmd_options.cmd_options_factoid(func)

dob.clickux.cmd_options.cmd_options_factoid_verify_none(func)

dob.clickux.cmd_options.cmd_options_factoid_verify_start(func)

dob.clickux.cmd_options.cmd_options_factoid_verify_end(func)

dob.clickux.cmd_options.cmd_options_factoid_verify_both(func)

dob.clickux.cmd_options.cmd_options_rule_name(func)

dob.clickux.cmd_options.cmd_options_styles_internal(func)

dob.clickux.cmd_options.cmd_options_styles_named(func)

dob.clickux.cmd_options_search module

dob.clickux.cmd_options_search.cmd_options_any_search_query(command='', item='', match=False, group=False)

dob.clickux.cmd_options_search.cmd_options_output_format_any_input(func)

dob.clickux.cmd_options_search.cmd_options_output_format_facts_only()

dob.clickux.cmd_options_search.postprocess_options_normalize_search_args(kwargs, cmd_journal=False)

dob.clickux.cmd_options_search.postprocess_options_output_format_any_input(kwargs, cmd_journal=False)

dob.clickux.help_command module

dob.clickux.help_command.help_command_help(ctx, command=None)

dob.clickux.help_detect module

dob.clickux.help_detect.show_help_finally(func)

Click command callback decorator to show help if requested. This changes the behavior of option parsing: The old behavior of dob –help command would show the general help, i.e., it would show the same help as dob –help. By telling Click to cool it, we can show the help for the specified sub-command instead, i.e., dob –help command will now show the help for command.

dob.clickux.help_detect.show_help_if_no_command(func)

dob.clickux.help_header module

dob.clickux.help_header.help_header_format(text)

dob.clickux.help_string_add_fact module

Module to provide u18n friendly help text strings for our CLI commands.

dob.clickux.help_string_add_fact.ADD_FACT_COMMON(ctx)

dob.clickux.help_strings module

Module to provide u18n friendly help text strings for our CLI commands.

dob.clickux.help_strings.ADD_FACT_AFTER(ctx)

dob.clickux.help_strings.ADD_FACT_AT(ctx)

dob.clickux.help_strings.ADD_FACT_FROM(ctx)

dob.clickux.help_strings.ADD_FACT_REFERRAL()

dob.clickux.help_strings.ADD_FACT_THEN(ctx)

dob.clickux.help_strings.ADD_FACT_UNTIL(ctx)

dob.clickux.help_strings.CONFIG_GROUP_HELP(ctx)

dob.clickux.help_strings.DEMO_HELP(ctx)

dob.clickux.help_strings.EXPORT_HELP(ctx)

dob.clickux.help_strings.IGNORE_GROUP_HELP(ctx)

dob.clickux.help_strings.INIT_HELP_OVERVIEW(ctx)

dob.clickux.help_strings.NO_ACTIVE_FACT_HELP(ctx)

dob.clickux.help_strings.REPORT_HELP(ctx)

dob.clickux.help_strings.RULES_GROUP_HELP(ctx)

dob.clickux.help_strings.RUN_HELP_COMPLETE()

dob.clickux.help_strings.RUN_HELP_HEADER()

dob.clickux.help_strings.RUN_HELP_OVERVIEW(ctx)

dob.clickux.help_strings.RUN_HELP_QUICKIE()

dob.clickux.help_strings.RUN_HELP_TLDR()

dob.clickux.help_strings.RUN_HELP_TRYME()

dob.clickux.help_strings.RUN_HELP_WHATIS()

dob.clickux.help_strings.STYLES_GROUP_HELP(ctx)

dob.clickux.help_strings.common_format()

dob.clickux.induct_newbies module

dob.clickux.induct_newbies.induct_newbies(func)

dob.clickux.induct_newbies.insist_germinated(func)

dob.clickux.plugin_group module

Click Group wrapper adds plugin support.

dob.clickux.plugin_group.ensure_plugged_in(func)

class dob.clickux.plugin_group.ClickPluginGroup(*args, **kwargs)

Bases: click_hotoffthehamster.core.Group

ensure_plugged_in(controller)

get_command(ctx, name)

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

get_commands_from_plugins(ctx, name)

list_commands(ctx)

Return list of commands.

open_source_eval_and_poke_around(py_path, name)

plugin_paths

probe_source_for_commands(eval_globals, name)

dob.clickux.post_processor module

dob.clickux.post_processor.post_processor(func)

dob.clickux.query_assist module

dob.clickux.query_assist.error_exit_no_results(item_type, more_msg=None)

Module contents

Top-level package module for clickux modules.