doot.cmds._interface

Protocols

`AcceptsSubcmds_p`	Protocol for marking cmds as able to allow subcmds in cli parsing
`Command_p`	Holds command information and performs it

Module Contents

class doot.cmds._interface.AcceptsSubcmds_p[source]

Bases: Protocol

Protocol for marking cmds as able to allow subcmds in cli parsing

_accept_subcmds() → Literal[True][source]

Return type:: Literal[True]

class doot.cmds._interface.Command_p[source]

Bases: jgdv.cli._interface.CLIParamProvider_p, Protocol

Holds command information and performs it

property name: str[source]

Return type:: str

property help: list[str][source]

Return type:: list[str]

property helpline: str[source]

Return type:: str

shutdown( tasks: jgdv.structs.chainguard.ChainGuard, plugins: jgdv.structs.chainguard.ChainGuard, errored: jgdv.Maybe[Exception] = None, ) → None[source]

A Handler called on doot shutting down. only the triggered cmd’s shutdown gets called

Parameters:

tasks (jgdv.structs.chainguard.ChainGuard)
plugins (jgdv.structs.chainguard.ChainGuard)
errored (jgdv.Maybe[Exception])

Return type:

None