Adjust readme

bcb · bcb · commit 7a9aa1b4f378 · 2025-04-18T12:41:22.000+10:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -30,7 +30,7 @@ repos:
           - websockets<11
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.971
+    rev: v1.14.1
     hooks:
       - id: mypy
         args: [--strict]
diff --git a/README.md b/README.md
@@ -23,19 +23,10 @@ from jsonrpcserver import method, serve, Success
 def ping():
     return Success("pong")
 
-if __name__ == "__main__":
-    serve()
-```
-
-Or use `dispatch` instead of `serve`:
-
-```python
 response = dispatch('{"jsonrpc": "2.0", "method": "ping", "id": 1}')
 # => '{"jsonrpc": "2.0", "result": "pong", "id": 1}'
 ```
 
-[Watch a video on how to use it.](https://www.youtube.com/watch?v=3_BMmgJaFHQ)
-
 Full documentation is at [jsonrpcserver.com](https://www.jsonrpcserver.com/).
 
 See also: [jsonrpcclient](https://github.com/explodinglabs/jsonrpcclient)
diff --git a/examples/aiohttp_server.py b/examples/aiohttp_server.py
@@ -1,6 +1,7 @@
 """AioHTTP server"""
 from aiohttp import web
-from jsonrpcserver import method, Result, Success, async_dispatch
+
+from jsonrpcserver import Result, Success, async_dispatch, method
 
 
 @method
diff --git a/examples/aiozmq_server.py b/examples/aiozmq_server.py
@@ -3,7 +3,8 @@
 
 import aiozmq  # type: ignore
 import zmq
-from jsonrpcserver import method, Result, Success, async_dispatch
+
+from jsonrpcserver import Result, Success, async_dispatch, method
 
 
 @method
diff --git a/examples/asyncio_server.py b/examples/asyncio_server.py
@@ -2,7 +2,7 @@
 import asyncio
 import json
 
-from jsonrpcserver import method, Result, Success, async_dispatch
+from jsonrpcserver import Result, Success, async_dispatch, method
 
 
 @method
diff --git a/examples/django_server.py b/examples/django_server.py
@@ -1,7 +1,8 @@
 """Django server"""
 from django.http import HttpRequest, HttpResponse  # type: ignore
 from django.views.decorators.csrf import csrf_exempt  # type: ignore
-from jsonrpcserver import method, Result, Success, dispatch
+
+from jsonrpcserver import Result, Success, dispatch, method
 
 
 @method
diff --git a/examples/fastapi_server.py b/examples/fastapi_server.py
@@ -1,6 +1,7 @@
 """FastAPI server"""
+import uvicorn
 from fastapi import FastAPI, Request, Response
-import uvicorn  # type: ignore
+
 from jsonrpcserver import Result, Success, dispatch, method
 
 app = FastAPI()
diff --git a/examples/flask_server.py b/examples/flask_server.py
@@ -1,6 +1,7 @@
 """Flask server"""
 from flask import Flask, Response, request
-from jsonrpcserver import method, Result, Success, dispatch
+
+from jsonrpcserver import Result, Success, dispatch, method
 
 app = Flask(__name__)
 
diff --git a/examples/http_server.py b/examples/http_server.py
@@ -4,7 +4,7 @@
 """
 from http.server import BaseHTTPRequestHandler, HTTPServer
 
-from jsonrpcserver import method, Result, Success, dispatch
+from jsonrpcserver import Result, Success, dispatch, method
 
 
 @method
diff --git a/examples/jsonrpcserver_server.py b/examples/jsonrpcserver_server.py
@@ -2,7 +2,7 @@
 
 Uses jsonrpcserver's built-in "serve" function.
 """
-from jsonrpcserver import method, Result, Success, serve
+from jsonrpcserver import Result, Success, method, serve
 
 
 @method
diff --git a/examples/sanic_server.py b/examples/sanic_server.py
@@ -2,6 +2,7 @@
 from sanic import Sanic
 from sanic.request import Request
 from sanic.response import HTTPResponse, json
+
 from jsonrpcserver import Result, Success, dispatch_to_serializable, method
 
 app = Sanic("JSON-RPC app")
diff --git a/examples/socketio_server.py b/examples/socketio_server.py
@@ -1,7 +1,8 @@
 """SocketIO server"""
 from flask import Flask, Request
 from flask_socketio import SocketIO, send  # type: ignore
-from jsonrpcserver import method, Result, Success, dispatch
+
+from jsonrpcserver import Result, Success, dispatch, method
 
 app = Flask(__name__)
 socketio = SocketIO(app)
diff --git a/examples/tornado_server.py b/examples/tornado_server.py
@@ -2,7 +2,8 @@
 from typing import Awaitable, Optional
 
 from tornado import ioloop, web
-from jsonrpcserver import method, Result, Success, async_dispatch
+
+from jsonrpcserver import Result, Success, async_dispatch, method
 
 
 @method
diff --git a/examples/websockets_server.py b/examples/websockets_server.py
@@ -2,7 +2,8 @@
 import asyncio
 
 from websockets.server import WebSocketServerProtocol, serve
-from jsonrpcserver import method, Success, Result, async_dispatch
+
+from jsonrpcserver import Result, Success, async_dispatch, method
 
 
 @method
diff --git a/examples/werkzeug_server.py b/examples/werkzeug_server.py
@@ -1,7 +1,8 @@
 """Werkzeug server"""
 from werkzeug.serving import run_simple
 from werkzeug.wrappers import Request, Response
-from jsonrpcserver import method, Result, Success, dispatch
+
+from jsonrpcserver import Result, Success, dispatch, method
 
 
 @method
diff --git a/examples/zeromq_server.py b/examples/zeromq_server.py
@@ -1,6 +1,7 @@
 """ZeroMQ server"""
 import zmq
-from jsonrpcserver import method, Result, Success, dispatch
+
+from jsonrpcserver import Result, Success, dispatch, method
 
 socket = zmq.Context().socket(zmq.REP)
 
diff --git a/jsonrpcserver/__init__.py b/jsonrpcserver/__init__.py
@@ -18,7 +18,11 @@
 
 from .async_main import (
     dispatch as async_dispatch,
+)
+from .async_main import (
     dispatch_to_response as async_dispatch_to_response,
+)
+from .async_main import (
     dispatch_to_serializable as async_dispatch_to_serializable,
 )
 from .exceptions import JsonRpcError
diff --git a/jsonrpcserver/async_dispatcher.py b/jsonrpcserver/async_dispatcher.py
@@ -1,9 +1,9 @@
 """Async version of dispatcher.py"""
+import asyncio
+import logging
 from functools import partial
 from itertools import starmap
 from typing import Any, Callable, Iterable, Tuple, Union
-import asyncio
-import logging
 
 from oslash.either import Left  # type: ignore
 
@@ -24,8 +24,8 @@
 from .exceptions import JsonRpcError
 from .methods import Method, Methods
 from .request import Request
-from .result import Result, InternalErrorResult, ErrorResult
 from .response import Response, ServerErrorResponse
+from .result import ErrorResult, InternalErrorResult, Result
 from .utils import make_list
 
 logger = logging.getLogger(__name__)
diff --git a/jsonrpcserver/async_main.py b/jsonrpcserver/async_main.py
@@ -4,13 +4,12 @@
 
 from .async_dispatcher import dispatch_to_response_pure
 from .dispatcher import Deserialized
-from .main import default_validator, default_deserializer
+from .main import default_deserializer, default_validator
 from .methods import Methods, global_methods
 from .response import Response, to_serializable
 from .sentinels import NOCONTEXT
 from .utils import identity
 
-
 # pylint: disable=missing-function-docstring,duplicate-code
 
 
diff --git a/jsonrpcserver/dispatcher.py b/jsonrpcserver/dispatcher.py
@@ -1,12 +1,13 @@
 """Dispatcher - does the hard work of this library: parses, validates and dispatches
 requests, providing responses.
 """
+
 # pylint: disable=protected-access
+import logging
 from functools import partial
 from inspect import signature
 from itertools import starmap
 from typing import Any, Callable, Dict, Iterable, List, Tuple, Union
-import logging
 
 from oslash.either import Either, Left, Right  # type: ignore
 
diff --git a/jsonrpcserver/exceptions.py b/jsonrpcserver/exceptions.py
@@ -1,5 +1,6 @@
 """Exceptions"""
 from typing import Any
+
 from .sentinels import NODATA
 
 
diff --git a/jsonrpcserver/main.py b/jsonrpcserver/main.py
@@ -9,19 +9,18 @@
 - dispatch_to_json/dispatch: Returns a JSON-RPC response string (or an empty string for
   notifications).
 """
+import json
 from importlib.resources import read_text
 from typing import Any, Callable, Dict, List, Optional, Union, cast
-import json
 
 from jsonschema.validators import validator_for  # type: ignore
 
-from .dispatcher import dispatch_to_response_pure, Deserialized
+from .dispatcher import Deserialized, dispatch_to_response_pure
 from .methods import Methods, global_methods
 from .response import Response, to_dict
 from .sentinels import NOCONTEXT
 from .utils import identity
 
-
 default_deserializer = json.loads
 
 # Prepare the jsonschema validator. This is global so it loads only once, not every
diff --git a/jsonrpcserver/response.py b/jsonrpcserver/response.py
@@ -2,7 +2,7 @@
 
 https://www.jsonrpc.org/specification#response_object
 """
-from typing import Any, Dict, List, Type, NamedTuple, Union
+from typing import Any, Dict, List, NamedTuple, Type, Union
 
 from oslash.either import Either, Left  # type: ignore
 
diff --git a/jsonrpcserver/result.py b/jsonrpcserver/result.py
@@ -10,7 +10,7 @@
 
 from oslash.either import Either, Left, Right  # type: ignore
 
-from .codes import ERROR_INVALID_PARAMS, ERROR_METHOD_NOT_FOUND, ERROR_INTERNAL_ERROR
+from .codes import ERROR_INTERNAL_ERROR, ERROR_INVALID_PARAMS, ERROR_METHOD_NOT_FOUND
 from .sentinels import NODATA
 
 # pylint: disable=missing-class-docstring,missing-function-docstring,invalid-name
diff --git a/tests/test_async_dispatcher.py b/tests/test_async_dispatcher.py
@@ -1,7 +1,7 @@
 """Test async_dispatcher.py"""
 from unittest.mock import Mock, patch
-import pytest
 
+import pytest
 from oslash.either import Left, Right  # type: ignore
 
 from jsonrpcserver.async_dispatcher import (
@@ -10,9 +10,9 @@
     dispatch_request,
     dispatch_to_response_pure,
 )
-from jsonrpcserver.main import default_deserializer, default_validator
 from jsonrpcserver.codes import ERROR_INTERNAL_ERROR, ERROR_SERVER_ERROR
 from jsonrpcserver.exceptions import JsonRpcError
+from jsonrpcserver.main import default_deserializer, default_validator
 from jsonrpcserver.request import Request
 from jsonrpcserver.response import ErrorResponse, SuccessResponse
 from jsonrpcserver.result import ErrorResult, Result, Success, SuccessResult
diff --git a/tests/test_async_main.py b/tests/test_async_main.py
@@ -1,12 +1,11 @@
 """Test async_main.py"""
 import pytest
-
 from oslash.either import Right  # type: ignore
 
 from jsonrpcserver.async_main import (
+    dispatch_to_json,
     dispatch_to_response,
     dispatch_to_serializable,
-    dispatch_to_json,
 )
 from jsonrpcserver.response import SuccessResponse
 from jsonrpcserver.result import Result, Success
diff --git a/tests/test_dispatcher.py b/tests/test_dispatcher.py
@@ -2,11 +2,11 @@
 
 TODO: Add tests for dispatch_requests (non-pure version)
 """
+import json
 from typing import Any, Callable, Dict
 from unittest.mock import Mock, patch, sentinel
-import json
-import pytest
 
+import pytest
 from oslash.either import Left, Right  # type: ignore
 
 from jsonrpcserver.codes import (
@@ -23,9 +23,9 @@
     dispatch_deserialized,
     dispatch_request,
     dispatch_to_response_pure,
-    extract_list,
     extract_args,
     extract_kwargs,
+    extract_list,
     get_method,
     not_notification,
     to_response,
@@ -36,8 +36,8 @@
 from jsonrpcserver.main import (
     default_deserializer,
     default_validator,
-    dispatch_to_response,
     dispatch,
+    dispatch_to_response,
 )
 from jsonrpcserver.methods import method
 from jsonrpcserver.request import Request
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -2,9 +2,9 @@
 from oslash.either import Right  # type: ignore
 
 from jsonrpcserver.main import (
+    dispatch_to_json,
     dispatch_to_response,
     dispatch_to_serializable,
-    dispatch_to_json,
 )
 from jsonrpcserver.response import SuccessResponse
 from jsonrpcserver.result import Result, Success
