parpg-source: serializers.py annotate

annotate serializers.py @ 40:2e3ab06a2f47

Made the component classes available in the __ini__.py file of the components package

author	KarstenBock@gmx.net
date	Mon, 05 Sep 2011 14:49:45 +0200
parents	7a89ea5404b1
children

rev	line source
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 # This file is part of PARPG.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	2
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	3 # PARPG is free software: you can redistribute it and/or modify
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	4 # it under the terms of the GNU General Public License as published by
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	5 # the Free Software Foundation, either version 3 of the License, or
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 # (at your option) any later version.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	7
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	8 # PARPG is distributed in the hope that it will be useful,
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 # GNU General Public License for more details.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	12
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	13 # You should have received a copy of the GNU General Public License
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	14 # along with PARPG. If not, see <http://www.gnu.org/licenses/>.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	16 Provides classes used to serialize and deserialize Python classes.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	17 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	18
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	19 from abc import ABCMeta, abstractmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20 try:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21 from xml.etree import cElementTree as ElementTree
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22 except ImportError:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23 from xml.etree import ElementTree
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24 try:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	25 from collections import OrderedDict
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26 except ImportError:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27 from .common.ordereddict import OrderedDict
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29 from .common.utils import dedent_chomp
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	30
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31 import logging
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33 logger = logging.getLogger('serializers')
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	35 class Serializable(object):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36 def __init__(self, class_, init_args=None, attributes=None):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37 self.class_ = class_
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38 if init_args is not None:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 self.init_args = OrderedDict(init_args)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41 self.init_args = OrderedDict()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42 if attributes is not None:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 self.attributes = OrderedDict(attributes)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45 self.attributes = OrderedDict()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	48 class SerializableRegistry(object):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	50 Class holding the data used to serialize and deserialize a particular
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51 Python object.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53 registered_classes = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55 @classmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56 def registerClass(cls, name, class_, init_args=None, attributes=None):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57 serializable = Serializable(class_, init_args, attributes)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58 cls.registered_classes[name] = serializable
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	61 class AbstractSerializer(object):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	62 __metaclass__ = ABCMeta
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64 @abstractmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 def serialize(self, object_, stream):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 pass
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 @abstractmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 def deserialize(self, stream):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70 pass
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	73 class XmlSerializer(AbstractSerializer):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	74 def serialize(self, statistic, stream):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	75 pass
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	76
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	77 @classmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	78 def deserialize(cls, stream):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	79 element_tree = ElementTree.parse(stream)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	80 root_element = element_tree.getroot()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	81 object_ = cls.construct_object(root_element)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	82 return object_
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	83
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 @classmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85 def construct_object(cls, element):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86 element_name = element.tag
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 if element_name in SerializableRegistry.registered_classes.keys():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	88 object_ = cls.construct_registered_class(element)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89 elif len(element) > 0:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90 # Element contains subelements, so we'll treat it as an
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 # OrderedDict.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92 if element_name == 'list':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93 object_ = cls.construct_list(element)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 object_ = cls.construct_ordered_dict(element)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	96 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	97 object_ = cls.construct_primitive(element)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 return object_
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100 @classmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101 def construct_registered_class(cls, element):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102 element_name = element.tag
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103 serializable = SerializableRegistry.registered_classes[element_name]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 class_ = serializable.class_
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105 init_args = OrderedDict()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	106 for subelement in element:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107 arg = cls.construct_object(subelement)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108 subelement_name = subelement.tag
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 init_args[subelement_name] = arg
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 try:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111 object_ = class_(**init_args)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112 except (TypeError, ValueError) as exception:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 logger.error(init_args)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	114 error_message = \
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	115 'unable to deserialize tag {0}: {1}'.format(element_name,
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 exception)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117 raise ValueError(error_message)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118 return object_
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120 @classmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121 def construct_ordered_dict(cls, element):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 object_ = OrderedDict()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 for subelement in element:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124 child = cls.construct_object(subelement)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	125 name = subelement.tag
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	126 object_[name] = child
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127 return object_
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 @classmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130 def construct_list(cls, element):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 object_ = []
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	132 for subelement in element:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	133 child = cls.construct_object(subelement)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	134 object_.append(child)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	135 return object_
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	136
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	137 @classmethod
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	138 def construct_primitive(cls, element):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	139 text = element.text
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	140 # Interpret the element's text as unicode by default.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	141 element_type = element.attrib.get('type', 'unicode')
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	142 if element_type == 'unicode':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	143 formatted_text = dedent_chomp(text)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	144 object_ = unicode(formatted_text)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	145 elif element_type == 'str':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	146 formatted_text = dedent_chomp(text)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	147 object_ = str(formatted_text)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	148 elif element_type == 'int':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	149 object_ = int(text)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	150 elif element_type == 'float':
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	151 object_ = float(text)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	152 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	153 error_message = '{0!r} is not a recognized primitive type'
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	154 error_message.format(element_type)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	155 raise ValueError(error_message)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	156 return object_

Mercurial > parpg-source

annotate serializers.py @ 40:2e3ab06a2f47