code.grnet.gr Git - ganeti-local/blob - lib/serializer.py

   1 #
   2 #
   3
   4 # Copyright (C) 2007, 2008 Google Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301, USA.
  20
  21 """Serializer abstraction module
  22
  23 This module introduces a simple abstraction over the serialization
  24 backend (currently json).
  25
  26 """
  27
  28 import simplejson
  29 import re
  30
  31
  32 # Check whether the simplejson module supports indentation
  33 _JSON_INDENT = 2
  34 try:
  35   simplejson.dumps(1, indent=_JSON_INDENT)
  36 except TypeError:
  37   _JSON_INDENT = None
  38
  39 _RE_EOLSP = re.compile('[ \t]+$', re.MULTILINE)
  40
  41
  42 def DumpJson(data, indent=True):
  43   """Serialize a given object.
  44
  45   @param data: the data to serialize
  46   @param indent: whether to indent output (depends on simplejson version)
  47
  48   @return: the string representation of data
  49
  50   """
  51   if not indent or _JSON_INDENT is None:
  52     txt = simplejson.dumps(data)
  53   else:
  54     txt = simplejson.dumps(data, indent=_JSON_INDENT)
  55
  56   txt = _RE_EOLSP.sub("", txt)
  57   if not txt.endswith('\n'):
  58     txt += '\n'
  59   return txt
  60
  61
  62 def LoadJson(txt):
  63   """Unserialize data from a string.
  64
  65   @param txt: the json-encoded form
  66
  67   @return: the original data
  68
  69   """
  70   return simplejson.loads(txt)
  71
  72
  73 Dump = DumpJson
  74 Load = LoadJson