klio.message.serializer

klio.message.serializer.to_klio_message(incoming_message, kconfig=None, logger=None)

Serialize bytes to a KlioMessage.

Tip

Set job_config.allow_non_klio_messages to True in klio-job.yaml in order to process non-KlioMessages as regular bytes. This function will create a new KlioMessage and set the incoming bytes to KlioMessage.data.element.

Parameters

• incoming_message (bytes) – Incoming bytes to parse into a KlioMessage.

• kconfig (klio_core.config.KlioConfig) – the current job’s configuration.

• logger (logging.Logger) – the logger associated with the Klio job.

Returns

a KlioMessage.

Return type

klio_core.proto.klio_pb2.KlioMessage

Raises

klio_core.proto.klio_pb2._message.DecodeError – incoming message can not be parsed into a KlioMessage and job_config.allow_non_klio_messages in klio-job.yaml is set to False.

klio.message.serializer.from_klio_message(klio_message, payload=None)

Deserialize a given KlioMessage to bytes.

Parameters

• klio_message (klio_core.proto.klio_pb2.KlioMessage) – the KlioMessage in which to deserialize into bytes

• payload (bytes or str) – Optional bytes or str to update the value of KlioMessage.data.payload with before deserializing into bytes. Default: None.

Returns

a KlioMessage as bytes.

Return type

bytes

Raises

exceptions.KlioMessagePayloadException – the provided payload value cannot be coerced into bytes.