404bebccac
The plan is still to remove it to avoid any dependency on oslo.context. Change-Id: I9fc982c89f537b385dda37800fe46b086eb4daf6
112 lines
3.3 KiB
Python
112 lines
3.3 KiB
Python
# Copyright 2013 IBM Corp.
|
|
#
|
|
# Licensed 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.
|
|
|
|
__all__ = ['Serializer', 'NoOpSerializer', 'JsonPayloadSerializer',
|
|
'RequestContextSerializer']
|
|
|
|
"""Provides the definition of a message serialization handler"""
|
|
|
|
import abc
|
|
|
|
from debtcollector import removals
|
|
from oslo_context import context as common_context
|
|
from oslo_serialization import jsonutils
|
|
import six
|
|
|
|
|
|
@six.add_metaclass(abc.ABCMeta)
|
|
class Serializer(object):
|
|
"""Generic (de-)serialization definition base class."""
|
|
|
|
@abc.abstractmethod
|
|
def serialize_entity(self, ctxt, entity):
|
|
"""Serialize something to primitive form.
|
|
|
|
:param ctxt: Request context, in deserialized form
|
|
:param entity: Entity to be serialized
|
|
:returns: Serialized form of entity
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def deserialize_entity(self, ctxt, entity):
|
|
"""Deserialize something from primitive form.
|
|
|
|
:param ctxt: Request context, in deserialized form
|
|
:param entity: Primitive to be deserialized
|
|
:returns: Deserialized form of entity
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def serialize_context(self, ctxt):
|
|
"""Serialize a request context into a dictionary.
|
|
|
|
:param ctxt: Request context
|
|
:returns: Serialized form of context
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def deserialize_context(self, ctxt):
|
|
"""Deserialize a dictionary into a request context.
|
|
|
|
:param ctxt: Request context dictionary
|
|
:returns: Deserialized form of entity
|
|
"""
|
|
|
|
|
|
@removals.removed_class("RequestContextSerializer",
|
|
version="4.6",
|
|
removal_version="5.0")
|
|
class RequestContextSerializer(Serializer):
|
|
|
|
def __init__(self, base):
|
|
self._base = base
|
|
|
|
def serialize_entity(self, context, entity):
|
|
if not self._base:
|
|
return entity
|
|
return self._base.serialize_entity(context, entity)
|
|
|
|
def deserialize_entity(self, context, entity):
|
|
if not self._base:
|
|
return entity
|
|
return self._base.deserialize_entity(context, entity)
|
|
|
|
def serialize_context(self, context):
|
|
return context.to_dict()
|
|
|
|
def deserialize_context(self, context):
|
|
return common_context.RequestContext.from_dict(context)
|
|
|
|
|
|
class NoOpSerializer(Serializer):
|
|
"""A serializer that does nothing."""
|
|
|
|
def serialize_entity(self, ctxt, entity):
|
|
return entity
|
|
|
|
def deserialize_entity(self, ctxt, entity):
|
|
return entity
|
|
|
|
def serialize_context(self, ctxt):
|
|
return ctxt
|
|
|
|
def deserialize_context(self, ctxt):
|
|
return ctxt
|
|
|
|
|
|
class JsonPayloadSerializer(NoOpSerializer):
|
|
@staticmethod
|
|
def serialize_entity(context, entity):
|
|
return jsonutils.to_primitive(entity, convert_instances=True)
|