nrel.hive.runner.runner_payload_ops

Module Contents

Functions

update_instruction_generator_safe(...)	Inject an updated InstructionGenerator into a runner payload
update_instruction_generator(...)	Inject an updated InstructionGenerator into a runner payload
get_instruction_generator_safe(...)	Extract an instruction generator from a runner payload
get_instruction_generator(...)	Extract an instruction generator from a runner payload
set_instruction_generators(...)	Set the instruction generators on a runner payload.
modify_entities_safe(...)	Modify entities in a runner payload
modify_entities(...)	Modify entities in a runner payload

nrel.hive.runner.runner_payload_ops.update_instruction_generator_safe(rp: nrel.hive.runner.runner_payload.RunnerPayload, ig: nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator) → returns.result.ResultE[nrel.hive.runner.runner_payload.RunnerPayload]

Inject an updated InstructionGenerator into a runner payload

Safe method

nrel.hive.runner.runner_payload_ops.update_instruction_generator(rp: nrel.hive.runner.runner_payload.RunnerPayload, ig: nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator) → nrel.hive.runner.runner_payload.RunnerPayload

Inject an updated InstructionGenerator into a runner payload

Unsafe method

nrel.hive.runner.runner_payload_ops.get_instruction_generator_safe(rp: nrel.hive.runner.runner_payload.RunnerPayload, ig: str | Type[nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator]) → returns.result.ResultE[nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator]

Extract an instruction generator from a runner payload

nrel.hive.runner.runner_payload_ops.get_instruction_generator(rp: nrel.hive.runner.runner_payload.RunnerPayload, ig: str | Type[nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator]) → nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator

Extract an instruction generator from a runner payload

nrel.hive.runner.runner_payload_ops.set_instruction_generators(rp: nrel.hive.runner.runner_payload.RunnerPayload, instruction_generators: Tuple[nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator]) → nrel.hive.runner.runner_payload.RunnerPayload

Set the instruction generators on a runner payload. Overwrites any existing instruction generators.

Parameters:

• rp – The runner payload to update

• instruction_generators – The instruction generators to set

Returns:

The updated runner payload

nrel.hive.runner.runner_payload_ops.modify_entities_safe(rp: nrel.hive.runner.runner_payload.RunnerPayload, entities: Iterable[nrel.hive.model.entity.Entity]) → returns.result.ResultE[nrel.hive.runner.runner_payload.RunnerPayload]

Modify entities in a runner payload

nrel.hive.runner.runner_payload_ops.modify_entities(rp: nrel.hive.runner.runner_payload.RunnerPayload, entities: Iterable[nrel.hive.model.entity.Entity]) → nrel.hive.runner.runner_payload.RunnerPayload

Modify entities in a runner payload