doot.cmds.help_cmd

Classes

_HelpDoot_m

_HelpCmd_m

_HelpTask_m

HelpCmd

Generic implementations of command methods

Module Contents

class doot.cmds.help_cmd._HelpDoot_m[source]
_doot_help(
plugins: jgdv.structs.chainguard.ChainGuard,
) → list[str][source]
Parameters:

plugins (jgdv.structs.chainguard.ChainGuard)

Return type:

list[str]

class doot.cmds.help_cmd._HelpCmd_m[source]
_cmd_help(*, idx: int, cmd: Any) → list[str][source]
Parameters:

  • idx (int)

  • cmd (Any)

Return type:

list[str]

_cmd_param_assignments(
idx: int,
cmd: Any,
) → list[jgdv.Maybe[str]][source]
Parameters:

  • idx (int)

  • cmd (Any)

Return type:

list[jgdv.Maybe[str]]

class doot.cmds.help_cmd._HelpTask_m[source]
_task_help(
count: int,
spec: doot.workflow._interface.TaskSpec_i,
) → list[jgdv.Maybe[str]][source]

Print the help for a task spec

Parameters:
Return type:

list[jgdv.Maybe[str]]

_task_param_assignments(
spec: doot.workflow._interface.TaskSpec_i,
) → list[source]
Parameters:

spec (doot.workflow._interface.TaskSpec_i)

Return type:

list

class doot.cmds.help_cmd.HelpCmd(name: jgdv.Maybe[str] = None)[source]

Bases: doot.cmds._base.BaseCommand

Generic implementations of command methods

Parameters:

name (jgdv.Maybe[str])

_name = 'help'
_help = ('Print info about the specified cmd or task', 'Can also be triggered by passing --help to any...
param_specs() → list[source]

Provide parameter specs for parsing into doot.args.cmds

Return type:

list