doot.cmds.list_cmd

The command which provides the user a listing of… things.

Each mixin does the work of creating the list, and provides its own set of cli args. The actual ListCmd joins them all and calls the necessary method, passing the result to the generic command _print_text method

Type Aliases

ListVal

Classes

`_DagLister_m`
`_TaskLister_m`	TODO: colour jobs
`_LocationLister_m`
`_LoggerLister_m`
`_FlagLister_m`
`_ActionLister_m`
`_PluginLister_m`
`_Listings_m`
`ListCmd`	Generic implementations of command methods

Module Contents

doot.cmds.list_cmd.ListVal: TypeAlias = Maybe[str | tuple[str, dict]]

class doot.cmds.list_cmd._DagLister_m[source]

build_param: collections.abc.Callable

param_specs() → list[source]

Return type:: list

class doot.cmds.list_cmd._TaskLister_m[source]

TODO: colour jobs

build_param: collections.abc.Callable

param_specs() → list[source]

Return type:: list

_list_tasks(idx: int, tasks) → list[ListVal][source]

Parameters:: idx (int)
Return type:: list[ListVal]

_build_format_strings( idx: int, ) → tuple[list[str], dict][source]

Builds the format string from args

Parameters:: idx (int)
Return type:: tuple[list[str], dict]

_filter_tasks(idx: int, data) → list[dict][source]

Parameters:: idx (int)
Return type:: list[dict]

_group_tasks(data: list[dict]) → dict[str, list][source]

Parameters:: data (list[dict])
Return type:: dict[str, list]

class doot.cmds.list_cmd._LocationLister_m[source]

build_param: collections.abc.Callable

param_specs() → list[source]

Return type:: list

_list_locations(idx) → list[ListVal][source]

Return type:: list[ListVal]

class doot.cmds.list_cmd._LoggerLister_m[source]

build_param: collections.abc.Callable

param_specs() → list[source]

Return type:: list

_list_loggers(idx) → list[ListVal][source]

Return type:: list[ListVal]

class doot.cmds.list_cmd._FlagLister_m[source]

build_param: collections.abc.Callable

param_specs() → list[source]

Return type:: list

_list_flags(idx) → list[ListVal][source]

Return type:: list[ListVal]

class doot.cmds.list_cmd._ActionLister_m[source]

build_param: collections.abc.Callable

param_specs() → list[source]

Return type:: list

_list_actions(idx, plugins) → list[ListVal][source]

Return type:: list[ListVal]

class doot.cmds.list_cmd._PluginLister_m[source]

build_param: collections.abc.Callable

param_specs() → list[source]

Return type:: list

_list_plugins(idx, plugins) → list[ListVal][source]

Return type:: list[ListVal]

class doot.cmds.list_cmd._Listings_m[source]

class doot.cmds.list_cmd.ListCmd(*args, **kwargs)[source]

Bases: doot.cmds._base.BaseCommand

Generic implementations of command methods

build_param: collections.abc.Callable

_help: ClassVar = ('A simple command to list all loaded task heads.', 'Set settings.commands.list.hide with a list...

param_specs() → list[jgdv.cli.ParamSpec_p][source]

Provide parameter specs for parsing into doot.args.cmds

Return type:: list[jgdv.cli.ParamSpec_p]