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 # pylint: disable-msg=C0103
  28
  29 # C0103: Invalid name, since pylint doesn't see that Dump points to a
  30 # function and not a constant
  31
  32 import simplejson
  33 import re
  34
  35
  36 # Check whether the simplejson module supports indentation
  37 _JSON_INDENT = 2
  38 try:
  39   simplejson.dumps(1, indent=_JSON_INDENT)
  40 except TypeError:
  41   _JSON_INDENT = None
  42
  43 _RE_EOLSP = re.compile('[ \t]+$', re.MULTILINE)
  44
  45
  46 def DumpJson(data, indent=True):
  47   """Serialize a given object.
  48
  49   @param data: the data to serialize
  50   @param indent: whether to indent output (depends on simplejson version)
  51
  52   @return: the string representation of data
  53
  54   """
  55   if not indent or _JSON_INDENT is None:
  56     txt = simplejson.dumps(data)
  57   else:
  58     txt = simplejson.dumps(data, indent=_JSON_INDENT)
  59
  60   txt = _RE_EOLSP.sub("", txt)
  61   if not txt.endswith('\n'):
  62     txt += '\n'
  63   return txt
  64
  65
  66 def LoadJson(txt):
  67   """Unserialize data from a string.
  68
  69   @param txt: the json-encoded form
  70
  71   @return: the original data
  72
  73   """
  74   return simplejson.loads(txt)
  75
  76
  77 Dump = DumpJson
  78 Load = LoadJson