Merge pull request #131 from dapper91/dev

- fix: client and server exceptions separated.

Author: dapper91

CHANGELOG.rst

@@ -2,6 +2,12 @@ Changelog
 =========
 
 
+2.1.0 (2025-10-31)
+-------------------
+
+- fix: client and server exceptions separated.
+
+
 2.0.1 (2025-10-28)
 -------------------
 

README.rst

@@ -359,15 +359,15 @@ which can be found in ``pjrpc.common.exceptions`` module so that error handling
 
 
 Default error list can be easily extended. All you need to create an error class inherited from
-``pjrpc.exc.TypedError`` and define an error code and a description message. ``pjrpc`` will be automatically
+``pjrpc.client.exceptions.TypedError`` and define an error code and a description message. ``pjrpc`` will be automatically
 deserializing custom errors for you:
 
 .. code-block:: python
 
     import pjrpc
     from pjrpc.client.backend import requests as pjrpc_client
 
-    class UserNotFound(pjrpc.exc.TypedError):
+    class UserNotFound(pjrpc.client.exceptions.TypedError):
         CODE = 1
         MESSAGE = 'user not found'
 
@@ -395,7 +395,7 @@ On the server side everything is also pretty straightforward:
     methods = pjrpc.server.MethodRegistry()
 
 
-    class UserNotFound(pjrpc.exc.TypedError):
+    class UserNotFound(pjrpc.server.exceptions.TypedError):
         CODE = 1
         MESSAGE = 'user not found'
 
@@ -513,7 +513,7 @@ and Swagger UI web tool with basic auth:
         id: UserId
 
 
-    class AlreadyExistsError(pjrpc.exc.TypedError):
+    class AlreadyExistsError(pjrpc.server.exceptions.TypedError):
         """
         User already registered error.
         """
@@ -522,7 +522,7 @@ and Swagger UI web tool with basic auth:
         MESSAGE = "user already exists"
 
 
-    class NotFoundError(pjrpc.exc.TypedError):
+    class NotFoundError(pjrpc.server.exceptions.TypedError):
         """
         User not found error.
         """

docs/source/pjrpc/errors.rst

@@ -22,7 +22,7 @@ Errors handling
     -32000 to -32099 , Server error , Reserved for implementation-defined server-errors.
 
 
-Errors can be found in :py:mod:`pjrpc.common.exceptions` module. Having said that error handling
+Errors can be found in :py:mod:`pjrpc.client.exceptions` module. Having said that error handling
 is very simple and "pythonic-way":
 
 .. code-block:: python
@@ -34,23 +34,23 @@ is very simple and "pythonic-way":
 
     try:
         result = client.proxy.sum(1, 2)
-    except pjrpc.MethodNotFound as e:
+    except pjrpc.client.exceptions.MethodNotFound as e:
         print(e)
 
 
 Custom errors
 -------------
 
 Default error list can be easily extended. All you need to create an error class inherited from
-:py:class:`pjrpc.common.exceptions.TypedError` and define an error code and a description message. ``pjrpc``
+:py:class:`pjrpc.client.exceptions.TypedError` and define an error code and a description message. ``pjrpc``
 will be automatically deserializing custom errors for you:
 
 .. code-block:: python
 
     import pjrpc
     from pjrpc.client.backend import requests as pjrpc_client
 
-    class UserNotFound(pjrpc.exc.TypedError):
+    class UserNotFound(pjrpc.client.exceptions.TypedError):
         CODE = 1
         MESSAGE = 'user not found'
 
@@ -81,7 +81,7 @@ On the server side everything is also pretty straightforward:
     methods = pjrpc.server.MethodRegistry()
 
 
-    class UserNotFound(pjrpc.exc.TypedError):
+    class UserNotFound(pjrpc.server.exceptions.TypedError):
         CODE = 1
         MESSAGE = 'user not found'
 
@@ -123,7 +123,7 @@ to set a base error class for a particular client:
     from pjrpc.client.backend import requests as jrpc_client
 
 
-    class ErrorV1(pjrpc.exc.TypeError, base=True):
+    class ErrorV1(pjrpc.client.exceptions.TypeError, base=True):
         pass
 
 
@@ -132,7 +132,7 @@ to set a base error class for a particular client:
         MESSAGE = 'permission denied'
 
 
-    class ErrorV2(pjrpc.exc.TypeError, base=True):
+    class ErrorV2(pjrpc.client.exceptions.TypeError, base=True):
         pass
 
 

docs/source/pjrpc/quickstart.rst

@@ -278,7 +278,7 @@ Error handling
 ______________
 
 ``pjrpc`` implements all the errors listed in `protocol specification <https://www.jsonrpc.org/specification#error_object>`_
-which can be found in :py:mod:`pjrpc.common.exceptions` module so that error handling is very simple and "pythonic-way":
+which can be found in :py:mod:`pjrpc.client.exceptions` module so that error handling is very simple and "pythonic-way":
 
 .. code-block:: python
 
@@ -294,15 +294,15 @@ which can be found in :py:mod:`pjrpc.common.exceptions` module so that error han
 
 
 Default error list can be easily extended. All you need to create an error class inherited from
-:py:class:`pjrpc.common.exceptions.JsonRpcError` and define an error code and a description message. ``pjrpc``
+:py:class:`pjrpc.client.exceptions.TypedError` and define an error code and a description message. ``pjrpc``
 will be automatically deserializing custom errors for you:
 
 .. code-block:: python
 
     import pjrpc
     from pjrpc.client.backend import requests as pjrpc_client
 
-    class UserNotFound(pjrpc.exc.TypedError):
+    class UserNotFound(pjrpc.client.exceptions.TypedError):
         CODE = 1
         MESSAGE = 'user not found'
 
@@ -330,7 +330,7 @@ On the server side everything is also pretty straightforward:
     methods = pjrpc.server.MethodRegistry()
 
 
-    class UserNotFound(pjrpc.exc.TypedError):
+    class UserNotFound(pjrpc.server.exceptions.TypedError):
         CODE = 1
         MESSAGE = 'user not found'
 
@@ -448,7 +448,7 @@ and Swagger UI web tool with basic auth:
         id: UserId
 
 
-    class AlreadyExistsError(pjrpc.exc.TypedError):
+    class AlreadyExistsError(pjrpc.server.exceptions.TypedError):
         """
         User already registered error.
         """
@@ -457,7 +457,7 @@ and Swagger UI web tool with basic auth:
         MESSAGE = "user already exists"
 
 
-    class NotFoundError(pjrpc.exc.TypedError):
+    class NotFoundError(pjrpc.server.exceptions.TypedError):
         """
         User not found error.
         """

docs/source/pjrpc/testing.rst

@@ -44,12 +44,12 @@ Look at the following test example:
         assert result == 2
 
         pjrpc_aiohttp_mocker.replace(
-            'http://localhost/api/v1', 'sum', error=pjrpc.exc.JsonRpcError(code=1, message='error', data='oops'),
+            'http://localhost/api/v1', 'sum', error=pjrpc.client.exceptions.JsonRpcError(code=1, message='error', data='oops'),
         )
-        with pytest.raises(pjrpc.exc.JsonRpcError) as exc_info:
+        with pytest.raises(pjrpc.client.exceptions.JsonRpcError) as exc_info:
             await client.proxy.sum(a=1, b=1)
 
-        assert exc_info.type is pjrpc.exc.JsonRpcError
+        assert exc_info.type is pjrpc.client.exceptions.JsonRpcError
         assert exc_info.value.code == 1
         assert exc_info.value.message == 'error'
         assert exc_info.value.data == 'oops'

docs/source/pjrpc/webui.rst

@@ -86,7 +86,7 @@ using flask web framework:
         id: UserId
 
 
-    class AlreadyExistsError(pjrpc.exc.TypedError):
+    class AlreadyExistsError(pjrpc.server.exceptions.TypedError):
         """
         User already registered error.
         """
@@ -95,7 +95,7 @@ using flask web framework:
         MESSAGE = "user already exists"
 
 
-    class NotFoundError(pjrpc.exc.TypedError):
+    class NotFoundError(pjrpc.server.exceptions.TypedError):
         """
         User not found error.
         """

examples/aiohttp_pytest.py

@@ -15,12 +15,14 @@ async def test_using_fixture(pjrpc_aiohttp_mocker):
     assert result == 2
 
     pjrpc_aiohttp_mocker.replace(
-        'http://localhost/api/v1', 'sum', error=pjrpc.exc.JsonRpcError(code=1, message='error', data='oops'),
+        'http://localhost/api/v1',
+        'sum',
+        error=pjrpc.client.exceptions.JsonRpcError(code=1, message='error', data='oops'),
     )
-    with pytest.raises(pjrpc.exc.JsonRpcError) as exc_info:
+    with pytest.raises(pjrpc.client.exceptions.JsonRpcError) as exc_info:
         await client.proxy.sum(a=1, b=1)
 
-    assert exc_info.type is pjrpc.exc.JsonRpcError
+    assert exc_info.type is pjrpc.client.exceptions.JsonRpcError
     assert exc_info.value.code == 1
     assert exc_info.value.message == 'error'
     assert exc_info.value.data == 'oops'

examples/multiple_clients.py

@@ -4,7 +4,7 @@
 from pjrpc.client.backend import requests as jrpc_client
 
 
-class ErrorV1(pjrpc.exc.TypedError, base=True):
+class ErrorV1(pjrpc.client.exceptions.TypedError, base=True):
     pass
 
 
@@ -13,7 +13,7 @@ class PermissionDenied(ErrorV1):
     MESSAGE: ClassVar[str] = 'permission denied'
 
 
-class ErrorV2(pjrpc.exc.TypedError, base=True):
+class ErrorV2(pjrpc.client.exceptions.TypedError, base=True):
     pass
 
 

examples/openapi_aiohttp.py

@@ -67,7 +67,7 @@ class UserOut(UserIn):
     id: UserId
 
 
-class AlreadyExistsError(pjrpc.exc.TypedError):
+class AlreadyExistsError(pjrpc.server.exceptions.TypedError):
     """
     User already registered error.
     """
@@ -76,7 +76,7 @@ class AlreadyExistsError(pjrpc.exc.TypedError):
     MESSAGE = "user already exists"
 
 
-class NotFoundError(pjrpc.exc.TypedError):
+class NotFoundError(pjrpc.server.exceptions.TypedError):
     """
     User not found error.
     """

examples/openapi_aiohttp_subendpoints.py

@@ -7,13 +7,13 @@
 
 import pjrpc.server.specs.extractors.pydantic
 import pjrpc.server.specs.openapi.ui
-from pjrpc.common.exceptions import MethodNotFoundError
+from pjrpc.server.exceptions import MethodNotFoundError
 from pjrpc.server.integration import aiohttp as integration
 from pjrpc.server.specs import extractors, openapi, openrpc
 from pjrpc.server.validators import pydantic as validators
 
 
-class AlreadyExistsError(pjrpc.exc.TypedError):
+class AlreadyExistsError(pjrpc.server.exceptions.TypedError):
     """
     User already registered error.
     """