1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
##############################################################################
# Copyright 2018 Rigetti Computing
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##############################################################################
"""
Class with json_rpc_call decorator for asynchronous JSON RPC calls
"""
import asyncio
import logging
import traceback
from typing import Union
from rpcq._utils import rpc_reply, rpc_error, RPCMethodError, get_input, get_safe_input, \
catch_warnings
from rpcq.messages import RPCRequest, RPCReply, RPCError
_log = logging.getLogger(__name__)
class RPCSpec(object):
"""
Class for keeping track of class methods that are exposed to the JSON RPC interface
"""
def __init__(self, *, provide_tracebacks: bool = True, serialize_exceptions: bool = True):
"""
Create a JsonRpcSpec object.
Usage:
jr = JsonRpcSpec()
class MyClass(object):
def __init__(self):
self.num = 5
@jr.add_method
def add(obj, *args):
return sum(args) + obj.num
obj = MyClass()
request = {
"jsonrpc": "2.0",
"id": "0",
"method": "add",
"params": [1, 2]
}
reply = jr.call(request, obj)
:param provide_tracebacks: If set to True, unhandled exceptions which occur during RPC call
implementations will have their tracebacks forwarded to the calling client as part of
the generated RPCError reply objject. If set to False, the generated RPCError reply will
omit this information (but the traceback will still get written to the logfile).
:param serialize_exceptions: If set to True, unhandled exceptions which occur during RPC
call implementations will be serialized into RPCError messages (which the Server
instance will then probably send to the corresponding Client). If set to False, the
exception is re-raised and left for the local caller to handle further.
"""
self._json_rpc_methods = {}
self.provide_tracebacks = provide_tracebacks
self.serialize_exceptions = serialize_exceptions
def add_handler(self, f):
"""
Adds the function f to a dictionary of JSON RPC methods.
:param callable f: Method to be exposed
:return:
"""
if f.__name__.startswith('rpc_'):
raise ValueError("Server method names cannot start with rpc_.")
self._json_rpc_methods[f.__name__] = f
return f
def get_handler(self, request):
"""
Get callable from JSON RPC request
:param RPCRequest request: JSON RPC request
:return: Method
:rtype: callable
"""
try:
f = self._json_rpc_methods[request.method]
except (AttributeError, KeyError): # pragma no coverage
raise RPCMethodError("Received invalid method '{}'".format(request.method))
return f
async def run_handler(self, request: RPCRequest) -> Union[RPCReply, RPCError]:
"""
Process a JSON RPC request
:param RPCRequest request: JSON RPC request
:return: JSON RPC reply
"""
with catch_warnings(record=True) as warnings:
try:
rpc_handler = self.get_handler(request)
except RPCMethodError as e:
return rpc_error(request.id, repr(e), warnings=warnings)
try:
# Run RPC and get result
args, kwargs = get_safe_input(request.params, rpc_handler)
result = rpc_handler(*args, **kwargs)
if asyncio.iscoroutine(result):
result = await result
except Exception as e:
if self.serialize_exceptions:
_traceback = traceback.format_exc()
_log.error(_traceback)
if self.provide_tracebacks:
return rpc_error(request.id, "{}\n{}".format(repr(e), _traceback),
warnings=warnings)
else:
return rpc_error(request.id, repr(e), warnings=warnings)
else:
raise e
return rpc_reply(request.id, result, warnings=warnings)
|
