@@ -40,15 +40,13 @@ add and subtract:

    :tab-width: 2

    :lines: 2,3,34-

-To use the server, start the client this way:

+To use this server (which is included as jsonrpc.example_server), start it and the client in this way:

-.. code-block:: bash

+.. code-block:: console

-   # Python 2.6

-   % python2.6 -i -m jsonrpc.__main__ http://localhost:8007

+   % python -m jsonrpc.example_server &

-   # Python 2.7

-   % python2.7 -i -m jsonrpc http://localhost:8007

+   % python -i -m jsonrpc.__main__ http://localhost:8007

 .. code-block:: python

@@ -47,7 +47,7 @@ Contents:

    getting_started

    server

    proxy

-   jsonutil

+.. jsonutil

 Indices and tables

 ==================

new file mode 100644

@@ -0,0 +1,187 @@

+#

+#  Copyright (c) 2011 Edward Langley

+#  All rights reserved.

+#

+#  Redistribution and use in source and binary forms, with or without

+#  modification, are permitted provided that the following conditions

+#  are met:

+#

+#  Redistributions of source code must retain the above copyright notice,

+#  this list of conditions and the following disclaimer.

+#

+#  Redistributions in binary form must reproduce the above copyright

+#  notice, this list of conditions and the following disclaimer in the

+#  documentation and/or other materials provided with the distribution.

+#

+#  Neither the name of the project's author nor the names of its

+#  contributors may be used to endorse or promote products derived from

+#  this software without specific prior written permission.

+#

+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

+#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

+#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

+#  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

+#  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

+#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED

+#  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

+#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

+#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

+#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

+#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+#

+#

+from jsonrpc.utilities import public

+import jsonrpc.jsonutil

+

+@public

+class RPCError(Exception):

+	'''Base Exception for JSON-RPC Errors, if this or a subclass of this is raised by a JSON-RPC method,

+	The server will convert it into an appropriate error object

+	'''

+

+	#: Error code

+	code = 0

+	#: Error message

+	msg = ""

+

+	@classmethod

+	def from_dict(cls, err):

+		self = cls()

+		self.code = err['code']

+		self.msg = err['message']

+		return self

+

+	def json_equivalent(self):

+		'''return a dictionary which matches an JSON-RPC Response'''

+		return dict(code=self.code, message=self.msg)

+

+	def __str__(self):

+		return jsonrpc.jsonutil.encode(self)

+

+@public

+class InvalidRequest(RPCError):

+	'''Raise this when the Request object does not match the schema'''

+	code = -32600

+	msg = "Invalid Request."

+

+@public

+class MethodNotFound(RPCError):

+	'''Raise this when the desired method is not found'''

+	code = -32601

+	msg = "Procedure not found."

+

+@public

+class ParseError(RPCError):

+	'''Raise this when the request contains invalid JSON'''

+	code = -32700

+	msg = "Parse error."

+

+codemap = {0: RPCError}

+codemap.update( (e.code, e) for e in RPCError.__subclasses__() )

+

+class JsonInstantiate:

+   @classmethod

+   def from_json(cls, json):

+      data = jsonrpc.jsonutil.decode(json)

+      if isinstance(data, list):

+         result = cls.from_list(data)

+      else:

+         result = cls.from_dict(data)

+      return result

+

+   @classmethod

+   def from_list(cls, responses):

+      return [cls.from_dict(r) for r in responses]

+

+

+class Request(object, JsonInstantiate):

+	def __init__(self, id, method, args=None, kwargs=None, extra=None, version='2.0'):

+		self.version = version

+		self.id = id

+		self.method = method

+		self.args = args

+		self.kwargs = kwargs

+		self.extra = extra or {}

+

+	@classmethod

+	def from_dict(cls, content):

+		version = content.pop('jsonrpc', None)

+		id = content.pop('id', None)

+

+		method = content.pop('method', None)

+

+		kwargs = content.pop('params', {})

+		args = ()

+		if not isinstance(kwargs, dict):

+			args = tuple(kwargs)

+			kwargs = {}

+		else:

+			args = kwargs.pop('__args', args)

+

+		args = args

+		kwargs = dict( (str(k), v) for k,v in kwargs.items() )

+		extra = content

+		return cls(id, method, args, kwargs, extra, version)

+

+

+	def check(self):

+		if self.version != '2.0': raise InvalidRequest

+		if not isinstance(self.method, (str, unicode)): raise InvalidRequest

+

+

+	def json_equivalent(self):

+		if self.kwargs.has_key('__args'):

+			raise ValueError, 'invalid argument name: __args'

+

+		params = self.args

+		if self.args and self.kwargs:

+			self.kwargs['__args'] = self.args

+		if self.kwargs:

+			result['params'] = self.kwargs

+

+		return dict(

+			jsonrpc = self.version,

+			id = self.id,

+			method = self.method,

+			params = params

+		)

+

+

+

+class Response(object, JsonInstantiate):

+	def __init__(self, id=None, result=None, error=None, version='2.0'):

+		self.version = version

+		self.id = id

+		self.result = result

+		self.error = error

+

+

+	@classmethod

+	def from_dict(cls, response):

+		version = response.get('jsonrpc', None)

+		id = response['id']

+		result = response.get('result', None)

+		error = response.get('error', None)

+

+		return cls(id, result, error, version)

+

+	def json_equivalent(self):

+		res = dict(jsonrpc=self.version, id=self.id)

+		if self.error is None:

+			res['result'] = self.result

+		else:

+			res['error'] = self.error

+		return res

+

+	def get_result(self):

+		'''get result and raise any errors'''

+		if self.error:

+			code = self.error['code']

+			raise codemap.get(code, RPCError).from_dict(self.error)

+		return self.result

+

+	def get_output(self):

+		'''get tuple (result, error)'''

+		return self.result, self.error

+

+

@@ -42,10 +42,10 @@ class ExampleServer(ServerEvents):

 	def log(self, responses, txrequest):

 		if isinstance(responses, list):

 			for response in responses:

-				msg = self.get_msg(response)

+				msg = self._get_msg(response)

 				print txrequest, msg

 		else:

-			msg = self.get_msg(response)

+			msg = self._get_msg(responses)

 			print txrequest, msg

 	def findmethod(self, method):

@@ -57,7 +57,7 @@ class ExampleServer(ServerEvents):

 	# helper methods

 	methods = set(['add', 'subtract'])

 	def _get_msg(self, response):

-		return ' '.join([response.id, response.result or response.error])

+		return ' '.join(str(x) for x in [response.id, response.result or response.error])

 	def subtract(self, a, b):

 		return a-b

@@ -65,7 +65,7 @@ class ExampleServer(ServerEvents):

 	def add(self, a, b):

 		return a+b

-root = JSON_RPC().customize(JSONRPCTest)

+root = JSON_RPC().customize(ExampleServer)

 site = server.Site(root)

@@ -1,24 +1,24 @@

 # $Id: proxy.py,v 1.20 2011/05/26 20:19:17 edwlan Exp $

-#  

+#

 #  Copyright (c) 2011 Edward Langley

 #  All rights reserved.

-#  

+#

 #  Redistribution and use in source and binary forms, with or without

 #  modification, are permitted provided that the following conditions

 #  are met:

-#  

+#

 #  Redistributions of source code must retain the above copyright notice,

 #  this list of conditions and the following disclaimer.

-#  

+#

 #  Redistributions in binary form must reproduce the above copyright

 #  notice, this list of conditions and the following disclaimer in the

 #  documentation and/or other materials provided with the distribution.

-#  

+#

 #  Neither the name of the project's author nor the names of its

 #  contributors may be used to endorse or promote products derived from

 #  this software without specific prior written permission.

-#  

+#

 #  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 #  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 #  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

@@ -30,7 +30,7 @@

 #  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

 #  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 #  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-#  

+#

 #

 import copy

 import urllib

@@ -44,6 +44,7 @@ collections.Mapping.register(UserDict.DictMixin)

 from hashlib import sha1

 import jsonrpc.jsonutil

+from jsonrpc.common import Response, Request

 __all__ = ['JSONRPCProxy', 'ProxyEvents']

@@ -56,13 +57,6 @@ class NewStyleBaseException(Exception):

     message = property(_get_message, _set_message)

-class JSONRPCException(NewStyleBaseException):

-	def __init__(self, rpcError):

-		Exception.__init__(self, rpcError.get('message'))

-		self.data = rpcError.get('data')

-		self.message = rpcError.get('message')

-		self.code = rpcError.get('code')

-

 class IDGen(object):

 	def __init__(self):

 		self._hasher = sha1()

@@ -98,33 +92,6 @@ class ProxyEvents(object):

 		'''allow a subclass to access the response data before it is returned to the user'''

 		return data

-

-class Request(object):

-

-	def __init__(self, id, method, args=None, kwargs=None):

-		self.version = '2.0'

-		self.id = id

-		self.method = method

-		self.args = args

-		self.kwargs = kwargs

-

-	def json_equivalent(self):

-		if kwargs.has_key('__args'):

-			raise ValueError, 'invalid argument name: __args'

-

-		result = dict(

-			jsonrpc = self.version,

-			id = self.id,

-			method = self.method

-		)

-

-		if self.args and self.kwargs:

-			self.kwargs['__args'] = self.args

-

-

-

-

-

 class JSONRPCProxy(object):

 	'''A class implementing a JSON-RPC Proxy.

@@ -182,9 +149,8 @@ class JSONRPCProxy(object):

 	def _get_postdata(self, args=None, kwargs=None):

 		args,kwargs = self._eventhandler.get_postdata(args, kwargs)

 		id = self._eventhandler.IDGen

-		return Request(id, self._serviceNams, args, kwargs)

-		postdata = jsonrpc.jsonutil.encode({	})

-		return postdata

+		result = Request(id, self._serviceName, args, kwargs)

+		return jsonrpc.jsonutil.encode(result)

 	def __call__(self, *args, **kwargs):

@@ -192,14 +158,10 @@ class JSONRPCProxy(object):

 		url = '%(host)s%(path)s' % dict(host = self.serviceURL, path = self._path)

 		postdata = self._get_postdata(args, kwargs)

 		respdata = urllib.urlopen(url, postdata).read()

-		resp = jsonrpc.jsonutil.decode(respdata)

+		resp = Response.from_dict(jsonrpc.jsonutil.decode(respdata))

+		resp = self._eventhandler.proc_response(resp)

-		if resp.get('error') != None:

-			raise JSONRPCException(resp['error'])

-		else:

-			resp = self._eventhandler.proc_response(resp)

-			result = resp['result']

-			return result

+		return resp.get_result()

 	def call(self, method, *args, **kwargs):

@@ -218,9 +180,15 @@ class JSONRPCProxy(object):

 		:param names: a dictionary { method: (args, kwargs) }

 		:returns: a list of pairs (result, error) where only one is not None

 		'''

+		result = None

 		if hasattr(methods, 'items'): methods = methods.items()

 		data = [ getattr(self, k)._get_postdata(*v) for k, v in methods ]

 		postdata = '[%s]' % ','.join(data)

 		respdata = urllib.urlopen(self.serviceURL, postdata).read()

-		resp = jsonrpc.jsonutil.decode(respdata)

-		return [(res.get('result'), res.get('error')) for res in resp]

+		resp = Response.from_json(respdata)

+		try:

+			result = resp.get_result()

+		except AttributeError:

+			result = [res.get_output() for res in resp]

+

+		return result

@@ -1,5 +1,3 @@

-# $Id: server.py,v 1.8 2011/05/26 19:34:19 edwlan Exp $

-

 #

 #  Copyright (c) 2011 Edward Langley

 #  All rights reserved.

@@ -34,6 +32,7 @@

 #

 import jsonrpc.jsonutil

 from jsonrpc.utilities import public

+import jsonrpc.common

 # Twisted imports

 from twisted.web import server

@@ -56,7 +55,7 @@ class ServerEvents(object):

 	def callmethod(self, txrequest, rpcrequest, **extra):

 		'''Finds the method and calls it with the specified args'''

 		method = self.findmethod(rpcrequest.method)

-		if method is None: raise MethodNotFound

+		if method is None: raise jsonrpc.common.MethodNotFound

 		extra.update(rpcrequest.kwargs)

 		return method(*rpcrequest.args, **extra)

@@ -78,88 +77,6 @@ class ServerEvents(object):

 		return content

-@public

-class ServerError(Exception):

-	'''Base Exception for JSON-RPC Errors, if this or a subclass of this is raised by a JSON-RPC method,

-	The server will convert it into an appropriate error object

-	'''

-

-	#: Error code

-	code = 0

-	#: Error message

-	msg = ""

-

-	def json_equivalent(self):

-		'''return a dictionary which matches an JSON-RPC Response'''

-		return dict(code=self.code, message=self.msg)

-

-	def __str__(self):

-		return jsonrpc.jsonutil.encode(self)

-

-@public

-class InvalidRequest(ServerError):

-	'''Raise this when the Request object does not match the schema'''

-	code = -32600

-	msg = "Invalid Request."

-

-@public

-class MethodNotFound(ServerError):

-	'''Raise this when the desired method is not found'''

-	code = -32601

-	msg = "Procedure not found."

-

-@public

-class ParseError(ServerError):

-	'''Raise this when the request contains invalid JSON'''

-	code = -32700

-	msg = "Parse error."

-

-class Request(object):

-	def __init__(self, content):

-		self.version = content.pop('jsonrpc', None)

-		self.id = content.pop('id', None)

-

-		self.method = content.pop('method', None)

-

-		kwargs = content.pop('params', {})

-		args = ()

-		if not isinstance(kwargs, dict):

-			args = tuple(kwargs)

-			kwargs = {}

-		else:

-			args = kwargs.pop('__args', args)

-

-		self.args = args

-		self.kwargs = dict( (str(k), v) for k,v in kwargs.items() )

-		self.extra = content

-

-	def check(self):

-		if self.version != '2.0': raise InvalidRequest

-		if not isinstance(self.method, (str, unicode)): raise InvalidRequest

-

-	@classmethod

-	def from_list(cls, content):

-		result = []

-		for req in content:

-			result.append(cls(req))

-		return result

-

-

-class Response(object):

-	def __init__(self, id=None, result=None, error=None):

-		self.version = '2.0'

-		self.id = id

-		self.result = result

-		self.error = error

-

-	def json_equivalent(self):

-		res = dict(jsonrpc=self.version, id=self.id)

-		if self.error is None:

-			res['result'] = self.result

-		else:

-			res['error'] = self.error

-		return res

-

 ## Base class providing a JSON-RPC 2.0 implementation with 2 customizable hooks

 @public

@@ -186,14 +103,14 @@ class JSON_RPC(Resource):

 		try:

 			try:

 				content = jsonrpc.jsonutil.decode(request.content.read())

-			except ValueError: raise ParseError

+			except ValueError: raise jsonrpc.common.ParseError

 			content = self.eventhandler.processcontent(content, request)

 			if isinstance(content, list):

-				content = Request.from_list(content)

+				content = jsonrpc.common.Request.from_list(content)

 			else:

-				content = Request(content)

+				content = jsonrpc.common.Request.from_dict(content)

 			try:

 				if hasattr(content, 'check'):

@@ -201,7 +118,7 @@ class JSON_RPC(Resource):

 				else:

 					for item in content: item.check()

-			except ServerError, e:

+			except jsonrpc.common.RPCError, e:

 				self._ebRender(e, request, content.id if hasattr(content, 'id') else None)

 			d = threads.deferToThread(self._action, request, content)

@@ -218,7 +135,7 @@ class JSON_RPC(Resource):

 		islist = (True if isinstance(contents, list) else False)

 		if not islist: contents = [contents]

-		if contents == []: raise InvalidRequest

+		if contents == []: raise jsonrpc.common.InvalidRequest

 		for rpcrequest in contents:

 			res = None

@@ -226,7 +143,7 @@ class JSON_RPC(Resource):

 			try:

 				add = copy.deepcopy(rpcrequest.extra)

 				add.update(kw)

-				res = Response(id=rpcrequest.id, result=self.eventhandler.callmethod(request, rpcrequest, **add))

+				res = jsonrpc.common.Response(id=rpcrequest.id, result=self.eventhandler.callmethod(request, rpcrequest, **add))

 				res = self.eventhandler.processrequest(res, request.args, **kw)

 			except Exception, e:

 				res = self.render_error(e, rpcrequest.id)

@@ -274,10 +191,10 @@ class JSON_RPC(Resource):

 	def render_error(self, e, id):

-		if isinstance(e, ServerError):

-			err = Response(id=id, error=e)

+		if isinstance(e, jsonrpc.common.RPCError):

+			err = jsonrpc.common.Response(id=id, error=e)

 		else:

-			err = Response(id=id, error=dict(code=0, message=str(e), data=e.args))

+			err = jsonrpc.common.Response(id=id, error=dict(code=0, message=str(e), data=e.args))

 		return err