SupervisorContainerGt

Python class corresponding to the GridWorks type supervisor.container.gt.000 (VersionedTypeName).

class gridworks.types.SupervisorContainerGt(*, SupervisorContainerId, Status, WorldInstanceName, SupervisorGNodeInstanceId, SupervisorGNodeAlias, TypeName='supervisor.container.gt', Version='000')

Used to send and receive updates about SupervisorContainers.

Sent from a GNodeRegistry to a World, and used also by the World as it spawns GNodeInstances in docker instances (i.e., the SupervisorContainers). [More info](https://gridworks.readthedocs.io/en/latest/supervisor.html).

Parameters:

  • SupervisorContainerId (str) –

  • Status (SupervisorContainerStatus) –

  • WorldInstanceName (str) –

  • SupervisorGNodeInstanceId (str) –

  • SupervisorGNodeAlias (str) –

  • TypeName (Literal['supervisor.container.gt']) –

  • Version (str) –

SupervisorContainerId:

  • Description: Id of the docker SupervisorContainer

  • Format: UuidCanonicalTextual

Status:

  • Description:

WorldInstanceName:

  • Description: Name of the WorldInstance. For example, d1__1 is a potential name for a World whose World GNode has alias d1.

  • Format: WorldInstanceNameFormat

SupervisorGNodeInstanceId:

  • Description: Id of the SupervisorContainer’s prime actor (aka the Supervisor GNode)

  • Format: UuidCanonicalTextual

SupervisorGNodeAlias:

  • Description: Alias of the SupervisorContainer’s prime actor (aka the Supervisor GNode)

  • Format: LeftRightDot

class gridworks.types.supervisor_container_gt.check_is_world_instance_name_format(v)

WorldInstanceName format: A single alphanumerical word starting with an alphabet char (the root GNodeAlias) and an integer, seperated by ‘__’. For example ‘d1__1’

Raises:

ValueError – if not WorldInstanceNameFormat format

Parameters:

v (str) –

class gridworks.types.supervisor_container_gt.check_is_uuid_canonical_textual(v)

UuidCanonicalTextual format: A string of hex words separated by hyphens of length 8-4-4-4-12.

Raises:

ValueError – if not UuidCanonicalTextual format

Parameters:

v (str) –

class gridworks.types.supervisor_container_gt.check_is_left_right_dot(v)

LeftRightDot format: Lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character.

Raises:

ValueError – if not LeftRightDot format

Parameters:

v (str) –

class gridworks.types.SupervisorContainerGt_Maker(supervisor_container_id, status, world_instance_name, supervisor_g_node_instance_id, supervisor_g_node_alias)
Parameters:

  • supervisor_container_id (str) –

  • status (SupervisorContainerStatus) –

  • world_instance_name (str) –

  • supervisor_g_node_instance_id (str) –

  • supervisor_g_node_alias (str) –

classmethod tuple_to_type(tuple)

Given a Python class object, returns the serialized JSON type object

Parameters:

tuple (SupervisorContainerGt) –

Return type:

str

classmethod type_to_tuple(t)

Given a serialized JSON type object, returns the Python class object

Parameters:

t (str) –

Return type:

SupervisorContainerGt