File: PKG-INFO

package info (click to toggle)
python-jsonrpc2 0.4.1-2
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 200 kB
  • ctags: 73
  • sloc: python: 298; makefile: 3
file content (277 lines) | stat: -rw-r--r-- 9,452 bytes parent folder | download | duplicates (2)
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
Metadata-Version: 1.1
Name: jsonrpc2
Version: 0.4.1
Summary: WSGI Framework for JSON RPC 2.0
Home-page: http://hg.aodag.jp/jsonrpc2/
Author: Atsushi Odagiri
Author-email: aodagx@gmail.com
License: MIT
Description: .. -*- restructuredtext -*-
        
        .. image:: https://drone.io/bitbucket.org/aodag/jsonrpc2/status.png
           :target: https://drone.io/bitbucket.org/aodag/jsonrpc2/latest
        
        jsonrpc2 is WSGI Framework for JSON RPC 2.0.
        
        JSON RPC 2.0 Spec can be seen on http://www.jsonrpc.org/specification .
        
        .. contents::
        
        QuickStart
        ==========================================
        
        install via pip::
        
         $ pip install jsonrpc2
        
        write your procedures in hello.py::
        
         def greeting(name):
             return dict(message="Hello, %s!" % name)
        
        run jsonrpc2 server::
        
         $ runjsonrpc2 hello
        
        
        Integration with Paste Script
        ===============================================
        
        create project with paste script template::
        
         $ paster create -t paster_jsonrpc2 myrpc
         $ cd myrpc
        
        run server
        
         $ paster serve run.ini
        
        access http://localhost:8080/
        
        
        Internal
        ===============================
        
        ::
        
         >>> import json
         >>> from jsonrpc2 import JsonRpcApplication
        
        sample procedure::
        
         >>> def greeting(name="world"):
         ...     return "Hello, %s!" % name
        
        create rpc application::
        
         >>> app = JsonRpcApplication(rpcs=dict(greeting=greeting))
        
        set up for test::
        
         >>> from webtest import TestApp
         >>> testapp = TestApp(app)
        
        call procedure::
        
         >>> call_values = {'jsonrpc':'2.0', 'method':'greeting', 'id':'greeting'}
         >>> res = testapp.post('/', params=json.dumps(call_values), content_type="application/json")
        
        got results::
        
         >>> res.json
         {u'jsonrpc': u'2.0', u'id': u'greeting', u'result': u'Hello, world!'}
        
        
        lazy loading::
        
         >>> app.rpc.methods['sample.add'] = 'tests.sample:add'
         >>> call_values = {'jsonrpc':'2.0', 'method':'sample.add', 'id':'sample.add', 'params':[1, 2]}
         >>> res = testapp.post('/', params=json.dumps(call_values), content_type="application/json")
         >>> res.json
         {u'jsonrpc': u'2.0', u'id': u'sample.add', u'result': 3}
        
        
        extra vars
        ==================
        
        ::
        
         >>> from jsonrpc2 import JsonRpc
         >>> rpc = JsonRpc()
         >>> rpc['add'] = lambda a, b: a + b
         >>> rpc({'jsonrpc': '2.0', 'method': 'add', 'id': 'rpc-1', 'params': {'a': 2}}, b=3)
         {'jsonrpc': '2.0', 'id': 'rpc-1', 'result': 5}
        
        handle errors
        =================
        
        ::
        
         >>> from jsonrpc2 import JsonRpc
         >>> class MyException(Exception):
         ...     pass
         >>> def my_rpc():
         ...     raise MyException()
         >>> rpc = JsonRpc({'call': my_rpc}, {MyException: -32001})
         >>> rpc({'jsonrpc': '2.0', 'method': 'call', 'id': 'rpc-1', 'params': []})
         {'jsonrpc': '2.0', 'id': 'rpc-1', 'error': {'message': '', 'code': -32001, 'data': '[]'}}
        
        
        JSON-RPC2 Example
        =====================================================
        
        use raw rpc processor::
        
         >>> from jsonrpc2 import JsonRpc
         >>> rpc = JsonRpc()
        
        sample procedures::
        
         >>> def subtract(minuend, subtrahend):
         ...     return minuend - subtrahend
         >>> def update(*args):
         ...     pass
         >>> def foobar():
         ...     pass
        
        register procedures with dict interface::
        
         >>> rpc['subtract'] = subtract
         >>> rpc['update'] = update
         >>> rpc['foobar'] = foobar
        
        Procedure Call with positional parameters::
        
         >>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 1})
         {'jsonrpc': '2.0', 'id': 1, 'result': 19}
        
         >>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": [23, 42], "id": 2})
         {'jsonrpc': '2.0', 'id': 2, 'result': -19}
        
        Procedure Call with named parameters::
        
         >>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": {"subtrahend": 23, "minuend": 42}, "id": 3})
         {'jsonrpc': '2.0', 'id': 3, 'result': 19}
        
         >>> rpc({"jsonrpc": "2.0", "method": "subtract", "params": {"minuend": 42, "subtrahend": 23}, "id": 4})
         {'jsonrpc': '2.0', 'id': 4, 'result': 19}
        
        Notification::
        
         >>> rpc({"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]})
         >>> rpc({"jsonrpc": "2.0", "method": "foobar"})
        
        Procedure Call of non-existent procedure::
        
         >>> del rpc['foobar']
         >>> rpc({"jsonrpc": "2.0", "method": "foobar", "id": "1"})
         {'jsonrpc': '2.0', 'id': '1', 'error': {'message': 'Method Not Found', 'code': -32601}}
        
        Procedure Call with invalid JSON-RPC::
        
         >>> rpc([1,2,3])
         {'jsonrpc': '2.0', 'id': None, 'error': {'message': 'Invalid Request', 'code': -32600}}
        
         >>> rpc({"jsonrpc": "2.0", "method": 1, "params": "bar"})
         {'jsonrpc': '2.0', 'id': None, 'error': {'message': 'Invalid Request', 'code': -32600}}
        
        
        Batched Call::
        
         >>> rpc['sum'] = lambda *args: reduce(lambda a, b: a + b, args)
         >>> def get_data():
         ...     return ["hello", 5]
         >>> rpc['get_data'] = get_data
         >>> result = rpc ([ {"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"},
         ...      {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},
         ...      {"jsonrpc": "2.0", "method": "subtract", "params": [42,23], "id": "2"},
         ...      {"foo": "boo"},
         ...      {"jsonrpc": "2.0", "method": "foo.get", "params": {"name": "myself"}, "id": "5"},
         ...      {"jsonrpc": "2.0", "method": "get_data", "id": "9"} ])
         >>> from pprint import pprint
         >>> pprint(result)
         [{'id': '1', 'jsonrpc': '2.0', 'result': 7},
          {'error': {'code': -32601, 'message': 'Method Not Found'},
           'id': None,
           'jsonrpc': '2.0'},
          {'id': '2', 'jsonrpc': '2.0', 'result': 19},
          {'error': {'code': -32600, 'message': 'Invalid Request'},
           'id': None,
           'jsonrpc': '2.0'},
          {'error': {'code': -32601, 'message': 'Method Not Found'},
           'id': '5',
           'jsonrpc': '2.0'},
          {'id': '9', 'jsonrpc': '2.0', 'result': ['hello', 5]}]
        
        
        
        ChangeLog
        ===================================================
        
        0.4.1
        ------------------------------
        
        - 0.4 is brown bag release.
        
        0.4
        -----------------------------------------------
        feature
        
        - added supporting py3
        - added registering application errors
        
        fixed bugs
        
        - Dont raise internal error for server exceptions `#13 <https://bitbucket.org/aodag/jsonrpc2/issue/13/dont-raise-internal-error-for-server>`_
        - incorrect Content-type `#15 https://bitbucket.org/aodag/jsonrpc2/issue/15/incorrect-content-type`_
        - internal logging configuration broken `#16 <https://bitbucket.org/aodag/jsonrpc2/issue/16/internal-logging-configuration-broken>`_
        
        0.3
        -----------------------------------------------
        
        - fix bugs
        - Paste Scripte templates
        - runjsonrpc2 command
        
        0.3.1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        - fix bugs (content-type with charset)
        
        0.3.2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        - enable to pass the extra vars to procedures
        
        0.2
        -----------------------------------------------
        
        - remove dependency to WebOb
        - split procedure call class from web application class
        
        0.2.1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        - lazy loading from method name.
        
        0.2.2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        - add dict interface.
        
        0.2.3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        - fix: read body with CONTENT_LENGTH.
        
Keywords: wsgi request web http json rpc
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4