Runner Class

Base runner class for interpreting yaml story files.

class archivist.runner._ActionMap(archivist_instance: Archivist)

Map of actions and keywords for an action

action(action_name: str) → Callable

Get valid action in map

delete(action_name: str)

Get delete_method in map

keywords(action_name: str) → tuple | None

Get keywords in map

label(noun: str, endpoint: str, action_name: str) → bool

Return whether this action uses or sets label

ops(action_name: str) → dict[str, Any]

Get valid entry in map

class archivist.runner._Runner(archivist_instance: Archivist)

ArchivistRunner takes a url, token_file.

delete()

Deletes all entities

identity(name: str) → str | None

Gets entity id

run_step(step: dict[str, Any])

Runs a step given parameters and the type of step.

Parameters:

step (dict) -- the steps map.

run_steps(config: dict[str, Any])

Runs all defined steps in self.config.

set_deletions(response: dict[str, Any], delete_method)

sets entry to be deleted

class archivist.runner._Step(archivist_instance: Archivist, **kwargs)

args(identity_method, step)

Add args and kwargs to action.

archivist.runner.tree()

Recursive dict of dicts