heronpy/api/serializer.py

#!/usr/bin/env python3
# -*- encoding: utf-8 -*-

#  Licensed to the Apache Software Foundation (ASF) under one
#  or more contributor license agreements.  See the NOTICE file
#  distributed with this work for additional information
#  regarding copyright ownership.  The ASF licenses this file
#  to you under the Apache License, Version 2.0 (the
#  "License"); you may not use this file except in compliance
#  with the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#  KIND, either express or implied.  See the License for the
#  specific language governing permissions and limitations
#  under the License.

'''serializer.py: common python serializer for heron'''
from abc import abstractmethod

try:
  import cPickle as pickle
except:
  import pickle

import heronpy.api.cloudpickle as cloudpickle

class IHeronSerializer:
  """Serializer interface for Heron"""
  @abstractmethod
  def initialize(self, config):
    """Initializes the serializer"""

  @abstractmethod
  def serialize(self, obj) -> bytes:
    """Serialize an object

    :param obj: The object to be serialized
    :returns: Serialized object as byte string
    """

  @abstractmethod
  def deserialize(self, input_str: bytes):
    """Deserialize an object

    :param input_str: Serialized object as byte string
    :returns: Deserialized object
    """

class PythonSerializer(IHeronSerializer):
  """Default serializer"""
  def initialize(self, config=None):
    pass

  def serialize(self, obj) -> bytes:
    return cloudpickle.dumps(obj)

  def deserialize(self, input_str: bytes):
    return pickle.loads(input_str)

default_serializer = PythonSerializer()