Framework

class salo.salo.Event(model: Dict, session: salo.salo.Session, options: Dict, exclude_none: bool = True)

get_saved_value(key: str, index: Optional[int] = None, is_random: bool = False) → Any

Set the value of an attribute for the event if a saved_value exists and is defined

run() → None

Create log event

save_value(key: str, value: str) → None

Update Session object with values if a saved_value is defined

set_options() → None

Set Event options

update_cadence() → None

Update the cadence and timestamp for this Event

update_saved_values(event: Union[salo.stencils.SaloStencilModel, salo.events.SaloEventModel]) → None

Ensure saved_values are updated if defined in the recipe

class salo.salo.Session(model: Dict, cadence: salo.cadence.Cadence, defaults: Dict, saved_values: Optional[Dict] = None)

generate(with_stencils: bool = False) → Generator

Iterate over Event objects for this Session

spawn(model: Dict, options: Dict) → None

Iterate over event objects in recipe, generate Event objects, and spawn additional child Event objects.

class salo.salo.Sessions(config: str, outputs: Optional[List] = None, output_config: Optional[str] = None)

create_session(model: Dict) → None

Create a new Session object for this collection of Sessions

generate(with_stencils: bool = False) → Generator

Iterate over Event objects for each Session object

load_config(config: pathlib.Path) → Dict

Load Salo configuration file for recipe or output

save() → None

Pass all Sessions to outputs for saving/post-processing