Merge branch 'use-returns' into prepare-v6

Author: bcb

.github/workflows/code-quality.yml

@@ -10,7 +10,7 @@ jobs:
       with:
         python-version: 3.x
     - run: pip install --upgrade pip
-    - run: pip install black==21.6b0 pylint==v3.0.0a3 mypy==v0.902 types-setuptools
+    - run: pip install "black<23" pylint==v3.0.0a3 mypy==v0.950 types-setuptools "returns<1"
     - run: black --diff --check $(git ls-files -- '*.py' ':!:tests/*' ':!:docs/*' ':!:examples/*')
     - run: pylint --disable=all --enable=unused-import $(git ls-files -- '*.py' ':!:tests/*' ':!:docs/*' ':!:examples/*')
     - run: mypy --strict $(git ls-files -- '*.py' ':!:tests/*' ':!:docs/*' ':!:examples/*')

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 fail_fast: true
 repos:
   - repo: https://github.com/ambv/black
-    rev: 21.7b0
+    rev: 22.3.0
     hooks:
       - id: black
         args: [--diff, --check]
@@ -13,9 +13,9 @@ repos:
         args: [--disable=all, --enable=unused-import]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.910
+    rev: v0.950
     hooks:
       - id: mypy
         exclude: (^tests|^examples|^docs)
         args: [--strict]
-        additional_dependencies: ['types-setuptools']
+        additional_dependencies: ['types-setuptools', 'returns']

README.md

@@ -12,11 +12,11 @@
 Process incoming JSON-RPC requests in Python.
 
 ```python
-from jsonrpcserver import method, serve, Success
+from jsonrpcserver import method, serve, Ok, Result
 
 @method
-def ping():
-    return Success("pong")
+def ping() -> Result:
+    return Ok("pong")
 
 if __name__ == "__main__":
     serve()

docs/async.md

@@ -3,11 +3,11 @@
 Async dispatch is supported.
 
 ```python
-from jsonrpcserver import method, Success, async_dispatch
+from jsonrpcserver import async_dispatch, async_method, Ok, Result
 
-@method
+@async_method
 async def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 await async_dispatch('{"jsonrpc": "2.0", "method": "ping", "id": 1}')
 ```

docs/dispatch.md

@@ -14,13 +14,13 @@ and gives a JSON-RPC response.
 
 ### methods
 
-This lets you specify a group of methods to dispatch to. It's an alternative to
-using the `@method` decorator. The value should be a dict mapping function
-names to functions.
+This lets you specify the methods to dispatch to. It's an alternative to using
+the `@method` decorator. The value should be a dict mapping function names to
+functions.
 
 ```python
 def ping():
-    return Success("pong")
+    return Ok("pong")
 
 dispatch(request, methods={"ping": ping})
 ```
@@ -35,7 +35,7 @@ If specified, this will be the first argument to all methods.
 ```python
 @method
 def greet(context, name):
-    return Success(context + " " + name)
+    return Ok(context + " " + name)
 
 >>> dispatch('{"jsonrpc": "2.0", "method": "greet", "params": ["Beau"], "id": 1}', context="Hello")
 '{"jsonrpc": "2.0", "result": "Hello Beau", "id": 1}'

docs/installation.md

@@ -3,11 +3,11 @@
 Create a `server.py`:
 
 ```python
-from jsonrpcserver import Success, method, serve
+from jsonrpcserver import method, serve, Ok
 
 @method
 def ping():
-    return Success("pong")
+    return Ok("pong")
 
 if __name__ == "__main__":
     serve()
@@ -27,3 +27,6 @@ Test the server:
 $ curl -X POST http://localhost:5000 -d '{"jsonrpc": "2.0", "method": "ping", "id": 1}'
 {"jsonrpc": "2.0", "result": "pong", "id": 1}
 ```
+
+`serve` is good for serving methods in development, but for production use
+`dispatch` instead.

docs/methods.md

@@ -4,20 +4,21 @@ Methods are functions that can be called by a JSON-RPC request. To write one,
 decorate a function with `@method`:
 
 ```python
-from jsonrpcserver import method, Result, Success, Error
+from jsonrpcserver import method, Error, Ok, Result
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 ```
 
-If you don't need to respond with any value simply `return Success()`.
+If you don't need to respond with any value simply `return Ok()`.
 
 ## Responses
 
-Methods return either `Success` or `Error`. These are the [JSON-RPC response
+Methods return either `Ok` or `Error`. These are the [JSON-RPC response
 objects](https://www.jsonrpc.org/specification#response_object) (excluding the
-`jsonrpc` and `id` parts). `Error` takes a code, message, and optionally 'data'.
+`jsonrpc` and `id` parts). `Error` takes a code, message, and optionally
+'data'.
 
 ```python
 @method
@@ -36,7 +37,7 @@ Methods can accept arguments.
 ```python
 @method
 def hello(name: str) -> Result:
-    return Success("Hello " + name)
+    return Ok("Hello " + name)
 ```
 
 Testing it:
@@ -53,13 +54,13 @@ The JSON-RPC error code for this is **-32602**. A shortcut, *InvalidParams*, is
 included so you don't need to remember that.
 
 ```python
-from jsonrpcserver import method, Result, InvalidParams, Success, dispatch
+from jsonrpcserver import dispatch, method, InvalidParams, Ok, Result
 
 @method
 def within_range(num: int) -> Result:
     if num not in range(1, 5):
         return InvalidParams("Value must be 1-5")
-    return Success()
+    return Ok()
 ```
 
 This is the same as saying

examples/aiohttp_server.py

@@ -1,10 +1,10 @@
 from aiohttp import web
-from jsonrpcserver import method, Result, Success, async_dispatch
+from jsonrpcserver import async_dispatch, async_method, Ok, Result
 
 
-@method
+@async_method
 async def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 async def handle(request):

examples/aiozmq_server.py

@@ -1,12 +1,12 @@
-from jsonrpcserver import method, Result, Success, async_dispatch
+from jsonrpcserver import async_dispatch, async_method, Ok, Result
 import aiozmq
 import asyncio
 import zmq
 
 
-@method
+@async_method
 async def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 async def main():

examples/asyncio_server.py

@@ -2,13 +2,13 @@
 import asyncio
 import json
 
-from jsonrpcserver import method, Result, Success, async_dispatch
+from jsonrpcserver import async_dispatch, async_method, Ok, Result
 
 
-@method
+@async_method
 async def sleep_() -> Result:
     await asyncio.sleep(1)
-    return Success()
+    return Ok()
 
 
 async def handle(request: str) -> None:

examples/django_server.py

@@ -1,11 +1,11 @@
 from django.http import HttpResponse
 from django.views.decorators.csrf import csrf_exempt
-from jsonrpcserver import method, Result, Success, dispatch
+from jsonrpcserver import dispatch, method, Ok, Result
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 @csrf_exempt

examples/fastapi_server.py

@@ -1,13 +1,13 @@
 from fastapi import FastAPI, Request, Response
-from jsonrpcserver import Result, Success, dispatch, method
+from jsonrpcserver import dispatch, method, Ok, Result
 import uvicorn
 
 app = FastAPI()
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 @app.post("/")

examples/flask_server.py

@@ -1,12 +1,12 @@
 from flask import Flask, Response, request
-from jsonrpcserver import method, Result, Success, dispatch
+from jsonrpcserver import dispatch, method, Ok, Result
 
 app = Flask(__name__)
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 @app.route("/", methods=["POST"])

examples/http_server.py

@@ -1,11 +1,11 @@
 from http.server import BaseHTTPRequestHandler, HTTPServer
 
-from jsonrpcserver import method, Result, Success, dispatch
+from jsonrpcserver import dispatch, method, Ok, Result
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 class TestHttpServer(BaseHTTPRequestHandler):

examples/jsonrpcserver_server.py

@@ -1,9 +1,9 @@
-from jsonrpcserver import method, Result, Success, serve
+from jsonrpcserver import method, serve, Ok, Result
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 if __name__ == "__main__":

examples/sanic_server.py

@@ -1,14 +1,14 @@
 from sanic import Sanic
 from sanic.request import Request
 from sanic.response import json
-from jsonrpcserver import Result, Success, dispatch_to_serializable, method
+from jsonrpcserver import dispatch_to_serializable, method, Ok, Result
 
 app = Sanic("JSON-RPC app")
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 @app.route("/", methods=["POST"])

examples/socketio_server.py

@@ -1,14 +1,14 @@
 from flask import Flask
 from flask_socketio import SocketIO, send
-from jsonrpcserver import method, Result, Success, dispatch
+from jsonrpcserver import dispatch, method, Ok, Result
 
 app = Flask(__name__)
 socketio = SocketIO(app)
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 @socketio.on("message")

examples/tornado_server.py

@@ -1,10 +1,10 @@
-from jsonrpcserver import method, Result, Success, async_dispatch
+from jsonrpcserver import async_dispatch, async_method, Ok, Result
 from tornado import ioloop, web
 
 
-@method
+@async_method
 async def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 class MainHandler(web.RequestHandler):

examples/websockets_server.py

@@ -1,12 +1,12 @@
 import asyncio
 
-from jsonrpcserver import method, Success, Result, async_dispatch
+from jsonrpcserver import async_dispatch, async_method, Ok, Result
 import websockets
 
 
-@method
+@async_method
 async def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 async def main(websocket, path):

examples/werkzeug_server.py

@@ -1,16 +1,18 @@
-from jsonrpcserver import method, Result, Success, dispatch
+from jsonrpcserver import method, Result, Ok, dispatch
 from werkzeug.serving import run_simple
 from werkzeug.wrappers import Request, Response
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 @Request.application
 def application(request):
-    return Response(dispatch(request.data.decode()), 200, mimetype="application/json")
+    return Response(
+        dispatch(request.get_data().decode()), 200, mimetype="application/json"
+    )
 
 
 if __name__ == "__main__":

examples/zeromq_server.py

@@ -1,12 +1,12 @@
-from jsonrpcserver import method, Result, Success, dispatch
+from jsonrpcserver import dispatch, method, Ok, Result
 import zmq
 
 socket = zmq.Context().socket(zmq.REP)
 
 
 @method
 def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 
 if __name__ == "__main__":