yggdrasil.interface package

Submodules

yggdrasil.interface.CisInterface module

yggdrasil.interface.YggInterface module

Module contents

Routines for interfacing with framework from Python.

yggdrasil.interface.YggInput(name, format_str=None, **kwargs)[source]

Get class for handling input from a message queue.

Parameters:

  • name (str) – The name of the message queue. Combined with the suffix ‘_IN’, it should match an environment variable containing a message queue key.

  • format_str (str, optional) – C style format string that should be used to deserialize messages that are receieved into a list of python objects. Defaults to None and raw string messages are returned.

  • **kwargs – Additional keyword arguments are passed to the underlying comm.

Returns:

Communication object.

Return type:

DefaultComm

yggdrasil.interface.YggOutput(name, format_str=None, **kwargs)[source]

Get class for handling output to a message queue.

Parameters:

  • name (str) – The name of the message queue. Combined with the suffix ‘_OUT’, it should match an environment variable containing a message queue key.

  • format_str (str, optional) – C style format string that should be used to create a message from a list of python ojbects. Defaults to None and raw string messages are sent.

  • **kwargs – Additional keyword arguments are passed to the underlying comm.

Returns:

Communication object.

Return type:

DefaultComm