Errors

Any error parsing a JSON-RPC request or any error that occurs executing a function will be wrapped in a JSON-RPC Error Object.

By default, the error returned will be a generic server error. The following:

from openrpc import RPCServer

rpc = RPCServer(title="RPCServer", version="0.1.0")


@rpc.method()
def divide(a: int, b: int) -> float:
    return a / b


req = '{"id": 1, "method": "divide", "params": {"a": 2, "b": 0}, "jsonrpc": "2.0"}'
print(rpc.process_request(req))

Produces this error response:

{
  "id": 1,
  "error": {
    "code": -32000,
    "message": "Server error"
  },
  "jsonrpc": "2.0"
}

Debug

In order to include error details in the error response set debug=True for the RPCServer.

rpc = RPCServer(title="RPCServer", version="0.1.0", debug=True)

Now the error response will contain error details in the data.

{
  "id": 1,
  "error": {
    "code": -32000,
    "message": "Server error",
    "data": "ZeroDivisionError: division by zero\n  File \"/home/matthew/Projects/openrpc-app/app.py\", line 8, in divide\n    return a / b\nZeroDivisionError: division by zero\n"
  },
  "jsonrpc": "2.0"
}