herostools.actor.archiver.json_archiver

Classes

JsonArchiver

HERODataArchiver that saves dict payloads as .json files.

Module Contents

class herostools.actor.archiver.json_archiver.JsonArchiver(save_template: str, merge_metadata: bool = False, *args, **kwargs)[source]

Bases: herostools.actor.archiver.base.HERODataArchiver

HERODataArchiver that saves dict payloads as .json files.

Parameters:

  • object_selector – Zenoh object selector for the devices to subscribe to.

  • event_name – Name of the event.

  • save_template – Jinja2 template used to generate the output file path from the payload metadata.

  • merge_metadata – When True, the metadata dict is embedded in the saved JSON under the key metadata.

  • default_metadata – Default metadata available to the filename template.

  • max_retries – Number of times to retry a failed store before dropping the item.

name_template
merge_metadata = False
_store(source_name: str, payload: dict, metadata: dict) → None[source]

Save the payload as a .json file.

Parameters:

  • source_name – Name of the event source (the HERO).

  • payload – Data to save as a JSON-serialisable dict.

  • metadata – Incoming metadata merged with default_metadata.