home *** CD-ROM | disk | FTP | other *** search
/ Freelog 125 / Freelog_MarsAvril2015_No125.iso / Internet / gpodder / gpodder-portable.exe / gpodder-portable / src / mygpoclient / json.py < prev    next >
Text File  |  2014-10-30  |  3KB  |  91 lines
  1. # -*- coding: utf-8 -*-
  2. # gpodder.net API Client
  3. # Copyright (C) 2009-2013 Thomas Perl and the gPodder Team
  4. #
  5. # This program is free software: you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation, either version 3 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17.  
  18. # Fix gPodder bug 900 (so "import json" doesn't import this module)
  19. from __future__ import absolute_import
  20.  
  21. import mygpoclient
  22.  
  23. try:
  24.     # Prefer the usage of the simplejson module, as it
  25.     # is most likely newer if it's installed as module
  26.     # than the built-in json module (and is mandatory
  27.     # in Python versions before 2.6, anyway).
  28.     import simplejson as json
  29. except ImportError:
  30.     # Python 2.6 ships the "json" module by default
  31.     import json
  32.  
  33. from mygpoclient import http
  34.  
  35. # Additional exceptions for JSON-related errors
  36. class JsonException(Exception): pass
  37.  
  38. class JsonClient(http.HttpClient):
  39.     """A HttpClient with built-in JSON support
  40.  
  41.     This client will automatically marshal and unmarshal data for
  42.     JSON-related web services so that code using this class will
  43.     not need to care about (de-)serialization of data structures.
  44.     """
  45.     def __init__(self, username=None, password=None):
  46.         http.HttpClient.__init__(self, username, password)
  47.  
  48.     @staticmethod
  49.     def encode(data):
  50.         """Encodes a object into its JSON string repesentation
  51.  
  52.         >>> JsonClient.encode(None)
  53.         ''
  54.         >>> JsonClient.encode([1,2,3])
  55.         '[1, 2, 3]'
  56.         >>> JsonClient.encode(42)
  57.         '42'
  58.         """
  59.         if data is None:
  60.             return ''
  61.         else:
  62.             return json.dumps(data)
  63.  
  64.     @staticmethod
  65.     def decode(data):
  66.         """Decodes a response string to a Python object
  67.  
  68.         >>> JsonClient.decode('')
  69.         >>> JsonClient.decode('[1,2,3]')
  70.         [1, 2, 3]
  71.         >>> JsonClient.decode('42')
  72.         42
  73.         """
  74.         if data == '':
  75.             return None
  76.         else:
  77.             try:
  78.                 return json.loads(data)
  79.             except ValueError, ve:
  80.                 raise JsonException('Value error while parsing response: ' + data)
  81.  
  82.     @staticmethod
  83.     def _prepare_request(method, uri, data):
  84.         data = JsonClient.encode(data)
  85.         return http.HttpClient._prepare_request(method, uri, data)
  86.  
  87.     @staticmethod
  88.     def _process_response(response):
  89.         data = http.HttpClient._process_response(response)
  90.         return JsonClient.decode(data)
  91.