sshmitm.moduleparser.pluginbrowser.formatters module

Text and Markdown formatting helpers for the plugin browser.

class sshmitm.moduleparser.pluginbrowser.formatters.ActionRenderContext(default_items=<factory>, user_items=<factory>, config_label=None, config_section=None, group_title=None)

Bases: object

Config/display context passed to action_markdown.

Parameters:

• default_items (dict[str, str], default: <factory>)

• user_items (dict[str, str], default: <factory>)

• config_label (str | None, default: None)

• config_section (str | None, default: None)

• group_title (str | None, default: None)

__init__(default_items=<factory>, user_items=<factory>, config_label=None, config_section=None, group_title=None)

Parameters:

• default_items (dict[str, str], default: <factory>)

• user_items (dict[str, str], default: <factory>)

• config_label (str | None, default: None)

• config_section (str | None, default: None)

• group_title (str | None, default: None)

config_label: str | None = None

config_section: str | None = None

default_items: dict[str, str]

group_title: str | None = None

user_items: dict[str, str]

sshmitm.moduleparser.pluginbrowser.formatters.action_markdown(action, ctx)

Parameters:

• action (Action)

• ctx (ActionRenderContext)

Return type:

str

sshmitm.moduleparser.pluginbrowser.formatters.cfg_get(items, dest)

Parameters:

• items (dict[str, str])

• dest (str)

Return type:

str | None

sshmitm.moduleparser.pluginbrowser.formatters.cli_help_to_markdown(text)

Convert CLI-formatted module help text to Markdown.

Parameters:

text (str)

Return type:

str

sshmitm.moduleparser.pluginbrowser.formatters.flag_str(action)

Parameters:

action (Action)

Return type:

str

sshmitm.moduleparser.pluginbrowser.formatters.fmt_cfg_val(val, in_config=True)

Parameters:

• val (str | None)

• in_config (bool, default: True)

Return type:

str

sshmitm.moduleparser.pluginbrowser.formatters.group_markdown(group)

Parameters:

group (_ArgumentGroup)

Return type:

str

sshmitm.moduleparser.pluginbrowser.formatters.help_module_section(text)

Extract only the ‘default module’ and ‘available modules’ lines from help text.

Parameters:

text (str)

Return type:

str

sshmitm.moduleparser.pluginbrowser.formatters.type_label(action)

Parameters:

action (Action)

Return type:

str