Remove debug option

Closes #112

Author: bcb

CHANGELOG.md

@@ -7,6 +7,8 @@
 - dispatch's context param renamed to "extra". This value is included in the
   context object passed to every method.
 - Removed "convert camel case" option.
+- Removed the custom exceptions. From methods, return an ErrorResponse instead
+  of raising an exception.
 
 Refactoring/internal changes:
 

doc/api.md

@@ -116,11 +116,6 @@ below):
 
 Adds log handlers, to log all requests and responses to stderr.
 
-**debug**
-
-If True, more information is included in error responses, such as an exception
-message. *For ApiError, this value is ignored.* Default is *False*.
-
 **trim_log_values**
 
 Show abbreviated requests and responses in logs. Default is *False*.
@@ -133,7 +128,6 @@ placed in the current or home directory:
 ```ini
 [general]
 basic_logging = yes
-debug = yes
 trim_log_values = yes
 ```
 
@@ -157,8 +151,8 @@ The dispatcher will give the appropriate response:
 '{"jsonrpc": "2.0", "error": {"code": -32602, "message": "Invalid parameters"}, "id": 1}'
 ```
 
-To send some other application-defined error response, raise an `ApiError` in
-a similar way.
+To send some other application-defined error response, raise an `ApiError` in a
+similar way.
 
 ```python
 from jsonrpcserver.exceptions import ApiError
@@ -169,9 +163,6 @@ def my_method():
         raise ApiError("Can't fulfill the request")
 ```
 
-To include the message passed when raising the exception, set `debug` to True.
-(See Configuration above.)
-
 ## Async
 
 Asyncio is supported, allowing requests to be dispatched to coroutines.

jsonrpcserver/async_dispatcher.py

@@ -36,9 +36,9 @@ async def call(method: Method, *args: Any, **kwargs: Any) -> Any:
 
 
 async def safe_call(
-    request: Request, methods: Methods, *, debug: bool, extra: Any, serialize: Callable
+    request: Request, methods: Methods, *, extra: Any, serialize: Callable
 ) -> Response:
-    with handle_exceptions(request, debug) as handler:
+    with handle_exceptions(request) as handler:
         if isinstance(request.params, list):
             result = await call(
                 lookup(methods, request.method),
@@ -62,40 +62,34 @@ async def safe_call(
 async def call_requests(
     requests: Union[Request, Iterable[Request]],
     methods: Methods,
-    debug: bool,
     extra: Any,
     serialize: Callable,
 ) -> Response:
     if isinstance(requests, collections.abc.Iterable):
         responses = (
-            safe_call(r, methods, debug=debug, extra=extra, serialize=serialize)
-            for r in requests
+            safe_call(r, methods, extra=extra, serialize=serialize) for r in requests
         )
         return BatchResponse(await asyncio.gather(*responses), serialize_func=serialize)
-    return await safe_call(
-        requests, methods, debug=debug, extra=extra, serialize=serialize
-    )
+    return await safe_call(requests, methods, extra=extra, serialize=serialize)
 
 
 async def dispatch_pure(
     request: str,
     methods: Methods,
     *,
-    debug: bool,
     extra: Any,
     serialize: Callable,
     deserialize: Callable,
 ) -> Response:
     try:
         deserialized = validate(deserialize(request), schema)
     except JSONDecodeError as exc:
-        return InvalidJSONResponse(data=str(exc), debug=debug)
+        return InvalidJSONResponse(data=str(exc))
     except ValidationError as exc:
-        return InvalidJSONRPCResponse(data=None, debug=debug)
+        return InvalidJSONRPCResponse(data=None)
     return await call_requests(
         create_requests(deserialized),
         methods,
-        debug=debug,
         extra=extra,
         serialize=serialize,
     )
@@ -107,7 +101,6 @@ async def dispatch(
     methods: Optional[Methods] = None,
     *,
     basic_logging: bool = False,
-    debug: bool = False,
     extra: Optional[Any] = None,
     trim_log_values: bool = False,
     serialize: Callable = default_serialize,
@@ -123,7 +116,6 @@ async def dispatch(
     response = await dispatch_pure(
         request,
         methods,
-        debug=debug,
         extra=extra,
         serialize=serialize,
         deserialize=deserialize,

jsonrpcserver/dispatcher.py

@@ -135,24 +135,20 @@ def call(method: Method, *args: Any, **kwargs: Any) -> Any:
 
 
 @contextmanager
-def handle_exceptions(request: Request, debug: bool) -> Generator:
+def handle_exceptions(request: Request) -> Generator:
     handler = SimpleNamespace(response=None)
     try:
         yield handler
     except MethodNotFoundError:
-        handler.response = MethodNotFoundResponse(
-            id=request.id, data=request.method, debug=debug
-        )
+        handler.response = MethodNotFoundResponse(id=request.id, data=request.method)
     except (InvalidParamsError, AssertionError) as exc:
         # InvalidParamsError is raised by validate_args. AssertionError is raised inside
         # the methods, however it's better to raise InvalidParamsError inside methods.
         # AssertionError will be removed in the next major release.
-        handler.response = InvalidParamsResponse(
-            id=request.id, data=str(exc), debug=debug
-        )
+        handler.response = InvalidParamsResponse(id=request.id, data=str(exc))
     except ApiError as exc:  # Method signals custom error
         handler.response = ApiErrorResponse(
-            str(exc), code=exc.code, data=exc.data, id=request.id, debug=debug
+            str(exc), code=exc.code, data=exc.data, id=request.id
         )
     except asyncio.CancelledError:
         # Allow CancelledError from asyncio task cancellation to bubble up. Without
@@ -163,28 +159,27 @@ def handle_exceptions(request: Request, debug: bool) -> Generator:
         raise
     except Exception as exc:  # Other error inside method - server error
         logging.exception(exc)
-        handler.response = ExceptionResponse(exc, id=request.id, debug=debug)
+        handler.response = ExceptionResponse(exc, id=request.id)
     finally:
         if is_notification(request):
             handler.response = NotificationResponse()
 
 
 def safe_call(
-    request: Request, methods: Methods, *, debug: bool, extra: Any, serialize: Callable
+    request: Request, methods: Methods, *, extra: Any, serialize: Callable
 ) -> Response:
     """
     Call a Request, catching exceptions to ensure we always return a Response.
 
     Args:
         request: The Request object.
         methods: The list of methods that can be called.
-        debug: Include more information in error responses.
         serialize: Function that is used to serialize data.
 
     Returns:
         A Response object.
     """
-    with handle_exceptions(request, debug) as handler:
+    with handle_exceptions(request) as handler:
         if isinstance(request.params, list):
             result = call(
                 lookup(methods, request.method),
@@ -210,7 +205,6 @@ def call_requests(
     methods: Methods,
     *,
     extra: Any,
-    debug: bool,
     serialize: Callable,
 ) -> Response:
     """
@@ -219,15 +213,12 @@ def call_requests(
     Args:
         requests: Request object, or a collection of them.
         methods: The list of methods that can be called.
-        debug: Include more information in error responses.
         serialize: Function that is used to serialize data.
     """
     return (
         BatchResponse(
             [
-                safe_call(
-                    r, methods=methods, debug=debug, extra=extra, serialize=serialize
-                )
+                safe_call(r, methods=methods, extra=extra, serialize=serialize)
                 for r in requests
             ],
             serialize_func=serialize,
@@ -236,7 +227,6 @@ def call_requests(
         else safe_call(
             cast(Request, requests),
             methods,
-            debug=debug,
             extra=extra,
             serialize=serialize,
         )
@@ -277,7 +267,6 @@ def dispatch_pure(
     request: str,
     methods: Methods,
     *,
-    debug: bool,
     extra: Any,
     serialize: Callable,
     deserialize: Callable,
@@ -292,7 +281,6 @@ def dispatch_pure(
     Args:
         request: The incoming request string.
         methods: Collection of methods that can be called.
-        debug: Include more information in error responses.
         extra: Will be included in the context dictionary passed to methods.
         serialize: Function that is used to serialize data.
         deserialize: Function that is used to deserialize data.
@@ -302,14 +290,13 @@ def dispatch_pure(
     try:
         deserialized = validate(deserialize(request), schema)
     except JSONDecodeError as exc:
-        return InvalidJSONResponse(data=str(exc), debug=debug)
+        return InvalidJSONResponse(data=str(exc))
     except ValidationError as exc:
-        return InvalidJSONRPCResponse(data=None, debug=debug)
+        return InvalidJSONRPCResponse(data=None)
     return call_requests(
         create_requests(deserialized),
         methods=methods,
         extra=extra,
-        debug=debug,
         serialize=serialize,
     )
 
@@ -321,7 +308,6 @@ def dispatch(
     *,
     basic_logging: bool = False,
     extra: Optional[Any] = None,
-    debug: bool = False,
     trim_log_values: bool = False,
     serialize: Callable = default_serialize,
     deserialize: Callable = default_deserialize,
@@ -338,7 +324,6 @@ def dispatch(
         methods: Collection of methods that can be called. If not passed, uses the
             internal methods object.
         extra: Extra data available inside methods (as context.extra).
-        debug: Include more information in error responses.
         trim_log_values: Show abbreviated requests and responses in log.
         serialize: Function that is used to serialize data.
         deserialize: Function that is used to deserialize data.
@@ -358,7 +343,6 @@ def dispatch(
     response = dispatch_pure(
         request,
         methods,
-        debug=debug,
         extra=extra,
         serialize=serialize,
         deserialize=deserialize,

jsonrpcserver/response.py

@@ -177,7 +177,6 @@ def __init__(
         *args: Any,
         code: int,
         data: Any = UNSPECIFIED,
-        debug: bool,  # required, named
         **kwargs: Any,
     ) -> None:
         """
@@ -188,22 +187,19 @@ def __init__(
                 integer.
             data: A Primitive or Structured value that contains additional information
                 about the error. This may be omitted.
-            debug: Include the data attribute which may include more (possibly
-                sensitive) information in the response.
         """
         super().__init__(*args, **kwargs)
         self.code = code
         self.message = message
         self.data = data
-        self.debug = debug
 
     def deserialized(self) -> dict:
         dct = {
             "jsonrpc": "2.0",
             "error": {"code": self.code, "message": self.message},
             "id": self.id,
         }  # type: Dict[str, Any]
-        if self.data is not UNSPECIFIED and self.debug:
+        if self.data is not UNSPECIFIED:
             dct["error"]["data"] = self.data
         return dct