doot.control._interface

Protocols

Overlord_p	protocol for the doot accesspoint,
Overlord_i	protocol for the doot accesspoint,
Main_p	protocol for doot as a main program
Main_i	protocol for doot as a main program

Module Contents

class doot.control._interface.Overlord_p

Bases: Protocol

protocol for the doot accesspoint, used for setting up and using Doot programmatically

setup(

*,

targets: jgdv.Maybe[list[doot._interface.Loadable]] = None,

prefix: str,

) → None

Parameters:

• targets (jgdv.Maybe[list[doot._interface.Loadable]])

• prefix (str)

Return type:

None

load() → None

Return type:

None

load_reporter(target: str = 'default') → None

Parameters:

target (str)

Return type:

None

verify_config_version(

ver: jgdv.Maybe[str],

sources: str | pathlib.Path,

*,

override: jgdv.Maybe[str] = None,

) → None

Parameters:

• ver (jgdv.Maybe[str])

• sources (str | pathlib.Path)

• override (jgdv.Maybe[str])

Return type:

None

update_aliases(

*,

data: dict | jgdv.structs.chainguard.ChainGuard,

) → None

Parameters:

data (dict | jgdv.structs.chainguard.ChainGuard)

Return type:

None

update_cmd_args(

data: jgdv.cli._interface.ParseReport_d | dict,

) → None

Parameters:

data (jgdv.cli._interface.ParseReport_d | dict)

Return type:

None

update_global_task_state(

data: jgdv.structs.chainguard.ChainGuard,

*,

source: jgdv.Maybe[str] = None,

) → None

Parameters:

• data (jgdv.structs.chainguard.ChainGuard)

• source (jgdv.Maybe[str])

Return type:

None

update_import_path(*paths: pathlib.Path) → None

Parameters:

paths (pathlib.Path)

Return type:

None

class doot.control._interface.Overlord_i

Bases: Overlord_p, Protocol

protocol for the doot accesspoint, used for setting up and using Doot programmatically

config: jgdv.structs.chainguard.ChainGuard

constants: jgdv.structs.chainguard.ChainGuard

aliases: jgdv.structs.chainguard.ChainGuard

cmd_aliases: jgdv.structs.chainguard.ChainGuard

args: jgdv.structs.chainguard.ChainGuard

locs: jgdv.structs.locator.JGDVLocator

configs_loaded_from: list[str | pathlib.Path]

global_task_state: dict

path_ext: list[str]

is_setup: bool

loaded_plugins: jgdv.structs.chainguard.ChainGuard

loaded_cmds: jgdv.structs.chainguard.ChainGuard

loaded_tasks: jgdv.structs.chainguard.ChainGuard

class doot.control._interface.Main_p(*, args: jgdv.Maybe[list] = None)

Bases: Protocol

protocol for doot as a main program

Parameters:

args (jgdv.Maybe[list])

property name: str

Return type:

str

handle_cli_args() → jgdv.Maybe[int]

Return type:

jgdv.Maybe[int]

help() → str

Return type:

str

setup_logging() → None

Return type:

None

class doot.control._interface.Main_i(*, args: jgdv.Maybe[list] = None)

Bases: Main_p, Protocol

protocol for doot as a main program

Parameters:

args (jgdv.Maybe[list])

result_code: int

prog_name: str

raw_args: list[str]

current_cmd: jgdv.Maybe[doot.cmd._interface.Command_p]

parser: jgdv.Maybe[jgdv.cli.ParseMachine]

log_config: jgdv.logging.JGDVLogConfig