baseimage-tutorial-framework/lib/tfw/networking/serialization.py

98 lines
2.0 KiB
Python
Raw Normal View History

# Copyright (C) 2018 Avatao.com Innovative Learning Kft.
# All Rights Reserved. See LICENSE file for details.
"""
TFW JSON message format
message:
{
"key": string, # addressing
"data": {...}, # payload
"trigger": string # FSM trigger
}
ZeroMQ's sub-pub sockets use enveloped messages
(http://zguide.zeromq.org/page:all#Pub-Sub-Message-Envelopes)
and TFW also uses them internally. This means that on ZMQ sockets
2018-04-16 10:50:08 +00:00
we always send the messages key separately and then the actual
message (which contains the key as well) like so:
socket.send_multipart([message['key'], message])
The purpose of this module is abstracting away this low level behaviour.
"""
import json
def validate_message(message):
2018-04-16 10:51:44 +00:00
return 'key' in message
def serialize_tfw_msg(message):
2018-05-11 12:36:56 +00:00
"""
Create TFW multipart data from message dict
"""
return _serialize_all(message['key'], message)
def deserialize_tfw_msg(*args):
2018-05-11 12:36:56 +00:00
"""
Return message from TFW multipart data
"""
return _deserialize_all(*args)[1]
def _serialize_all(*args):
return tuple(
_serialize_single(arg)
for arg in args
)
def _deserialize_all(*args):
return tuple(
_deserialize_single(arg)
for arg in args
)
def _serialize_single(data):
2018-05-11 12:36:56 +00:00
"""
Return input as bytes
(serialize input if it is JSON)
"""
if not isinstance(data, str):
data = json.dumps(data)
return _encode_if_needed(data)
def _deserialize_single(data):
2018-05-11 12:36:56 +00:00
"""
Try parsing input as JSON, return it as
string if parsing fails.
"""
try:
return json.loads(data)
except ValueError:
return _decode_if_needed(data)
def _encode_if_needed(value):
2018-05-11 12:36:56 +00:00
"""
Return input as bytes
(encode if input is string)
"""
2018-02-02 16:30:26 +00:00
if isinstance(value, str):
value = value.encode('utf-8')
return value
def _decode_if_needed(value):
2018-05-11 12:36:56 +00:00
"""
Return input as string
(decode if input is bytes)
"""
2018-02-02 16:30:26 +00:00
if isinstance(value, (bytes, bytearray)):
value = value.decode('utf-8')
return value