Qooxdoo-specific CherryPy-based JSON RPC-server
Project description
Overview
Python RPC-server for a Qooxdoo application. Implemented on top of CherryPy. Supports file upload and download. Controller code example:
import cherrypy
import qxcpjsonrpc as rpc
class Service:
_server = rpc.Server()
'''Server instance can be shared between threads'''
@cherrypy.expose
def index(self, *args, **kwargs):
return self._server.run()
Alternatively rpc.ServerTool can used in CherryPy configuration as follows (or any of other ways to activate a CherryPy tool because of its great flexibility):
import cherrypy
import qxcpjsonrpc as rpc
config = {
'/service' : {
'tools.jsonrpc.on' : True
}
}
cherrypy.tools.jsonrpc = rpc.ServerTool()
cherrypy.tree.mount(None, config = config)
Service code example:
import qxcpjsonrpc as rpc
class Test(rpc.Service):
@rpc.public
def add(self, x, y):
return x + y
Qooxdoo code example:
var rpc = new qx.io.remote.Rpc();
rpc.setServiceName('modulename.Test');
rpc.setUrl('http://127.0.0.1:8080/service');
rpc.addListener("completed", function(event)
{
console.log(event.getData());
});
rpc.callAsyncListeners(this, 'add', 5, 7);
Serialization
Serialization is provided by json package. However it doesn’t work out-of-the-box for some practically important types.
No special deserialization but json.loads is performed. Additional parsing is intended to be in user code.
Date
Dates are serialized to UTC ISO 8601 strings, close to what Javascript JSON.stringify(new Date()) produces. datetime.datetime objects look like 2012-03-17T19:09:12.217000Z, datetime.date like 2012-03-17T00:00:00Z.
As far as I know, there’s no reliable and cross-browser way to parse ISO 8601 strings using Javascript Date object. The following code can help (usually I put it to Date.fromISOString, as a counterpart to Date.prototype.toISOString), which converts ISO 8601 to cross-browser representation 2011/10/09 07:06:05 +0000 and passes it to Date constructor.
function fromISOString(value)
{
if(!value)
{
return null;
}
return new Date(value
.split(".")[0]
.split("Z")[0]
.split("-").join("/")
.replace("T", " ")
+ " +0000"
);
}
For dealing with ISO 8601 strings in service user code there’s a helper, which can be used as follows. Note that datetime.datetime objects it produces are timezone-aware. Timezone is UTC.
import qxcpjsonrpc as rpc
rpc.fromJsonDate('2012-03-17T19:09:12.217Z')
Decimal
Serialized as strings.
Access control
By default all methods are protected and need to be strictly marked with rpc.access decorator to be accessible. The decorator expects a callable that return a bool. It is possible to use the decorator multiple times.
The package doesn’t use manual service bookkeeping, rather than doing imports programmatically through importlib for you. In case you have modules that have import side-effects which are in general a good idea to eliminate, you can subclass rpc.ServiceLocator and pass it (class) to initializer of rpc.Server or rpc.ServerTool. This way arbitrary method lookup can be implemented.
import qxcpjsonrpc as rpc
def isAdmin(method, request):
'''Access granted only for administrators'''
return cherrypy.request.login == 'admin'
class Restricted(rpc.Service):
@rpc.access(isAdmin)
def entertainme(self):
return '1/0 === Infinity'
Protocol
Below are some examples of typical payloads.
GET
It’s usually a case of source mode Qooxdoo application under development. Especially when the application is loaded from file:// and requires JSONP communication to circumvent Same Origin Policy.
Request’s query parameters, like in http://localhost/service?_ScriptTransport_id=...&nocache=...&_ScriptTransport_data=...:
// _ScriptTransport_data
{
"id" : 5,
"service" : "modulename.Test",
"method" : "anotherMethod",
"params" : ["JavaScript", {"is": ["doable with Qooxdoo"]}],
"server_data" : {"token": "a58666196537fdf3e5bf63cd740928gf"}
}
// _ScriptTransport_id
5
// nocache
1297107012377
Response:
qx.io.remote.transport.Script._requestFinished(
5, // id
{
"id" : 5,
"error" : {
"origin" : 2,
"message" : "[ApplicationError] Wild statement!",
"code" : 0
},
"result" : null
}
);
POST
It’s usually a case of built and deployed Qooxdoo application.
Request to http://localhost/service?nocache=1234500999666:
{
"id" : 12,
"service" : "modulename.Test",
"method" : "anotherMethod",
"params" : ["Python", true, {"ly": ["rocks"]}],
"server_data" : {"token": "a58666196537fdf3e5bf63cd740928gf"}
}
Response:
{
"id" : 12,
"error" : null,
"result" : {"arbitrary": {"here": ["a", 5, " well"]}}
}
Examples
For examples look in test suite. More examples could be found in this project.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for QooxdooCherrypyJsonRpc-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfde9fdf115a100e2eac9be5795ac832e3211aedb62b63d9b933d3d0cbf759ef |
|
MD5 | 6f1748416bdf2ef2c973d194f7367c59 |
|
BLAKE2b-256 | a944671071971711626e7c01217698118713e9aede874d08bb7cf6c03d3831c7 |