Merge pull request #108 from dapper91/dev

- openapi 3.x support added.
- batch size validation support added.
- custom http server response status added.
- raise_for_status flag added for http clients.
- python 3.12, 3.13 support added.

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ default_stages:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: check-toml
@@ -39,11 +39,11 @@ repos:
         args:
           - --diff
   - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
+    rev: 7.1.1
     hooks:
       - id: flake8
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         name: fix import order
@@ -63,7 +63,7 @@ repos:
           - --multi-line=9
           - --project=pjrpc
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.1
+    rev: v1.13.0
     hooks:
       - id: mypy
         stages:
@@ -75,4 +75,12 @@ repos:
           - aiohttp>=3.7
           - httpx>=0.23.0
           - pydantic>=2.0
+          - types-jsonschema>=3.0,<4.0
           - types-requests>=2.0
+          - aio-pika>=8.0
+          - docstring_parser>=0.8
+          - werkzeug>=2.0
+          - pytest>=7.4.0
+          - starlette>=0.25.0
+          - flask>=2.0.0
+          - openapi-ui-bundles>=0.3.0

CHANGELOG.rst

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+1.10.0 (2024-11-12)
+------------------
+
+- openapi 3.x support added.
+- batch size validation support added.
+- custom http server response status added.
+- raise_for_status flag added for http clients.
+- python 3.12, 3.13 support added.
+
+
 1.9.0 (2024-04-22)
 ------------------
 

README.rst

@@ -454,19 +454,19 @@ and Swagger UI web tool with basic auth:
 .. code-block:: python
 
     import uuid
-    from typing import Any, Optional
+    from typing import Annotated, Any, Optional
 
     import flask
-    import flask_httpauth
-    import pydantic
     import flask_cors
+    import flask_httpauth
+    import pydantic as pd
     from werkzeug import security
 
     import pjrpc.server.specs.extractors.pydantic
     from pjrpc.server.integration import flask as integration
+    from pjrpc.server.specs import extractors
+    from pjrpc.server.specs import openapi as specs
     from pjrpc.server.validators import pydantic as validators
-    from pjrpc.server.specs import extractors, openapi as specs
-
 
     app = flask.Flask('myapp')
     flask_cors.CORS(app, resources={"/myapp/api/v1/*": {"origins": "*"}})
@@ -492,30 +492,51 @@ and Swagger UI web tool with basic auth:
 
     class JSONEncoder(pjrpc.JSONEncoder):
         def default(self, o: Any) -> Any:
-            if isinstance(o, pydantic.BaseModel):
-                return o.dict()
+            if isinstance(o, pd.BaseModel):
+                return o.model_dump()
             if isinstance(o, uuid.UUID):
                 return str(o)
 
             return super().default(o)
 
 
-    class UserIn(pydantic.BaseModel):
+    UserName = Annotated[
+        str,
+        pd.Field(description="User name", examples=["John"]),
+    ]
+
+    UserSurname = Annotated[
+        str,
+        pd.Field(description="User surname", examples=['Doe']),
+    ]
+
+    UserAge = Annotated[
+        int,
+        pd.Field(description="User age", examples=[25]),
+    ]
+
+    UserId = Annotated[
+        uuid.UUID,
+        pd.Field(description="User identifier", examples=["c47726c6-a232-45f1-944f-60b98966ff1b"]),
+    ]
+
+
+    class UserIn(pd.BaseModel):
         """
         User registration data.
         """
 
-        name: str
-        surname: str
-        age: int
+        name: UserName
+        surname: UserSurname
+        age: UserAge
 
 
     class UserOut(UserIn):
         """
         Registered user data.
         """
 
-        id: uuid.UUID
+        id: UserId
 
 
     class AlreadyExistsError(pjrpc.exc.JsonRpcError):
@@ -537,26 +558,9 @@ and Swagger UI web tool with basic auth:
 
 
     @specs.annotate(
+        summary='Creates a user',
         tags=['users'],
         errors=[AlreadyExistsError],
-        examples=[
-            specs.MethodExample(
-                summary="Simple example",
-                params=dict(
-                    user={
-                        'name': 'John',
-                        'surname': 'Doe',
-                        'age': 25,
-                    },
-                ),
-                result={
-                    'id': 'c47726c6-a232-45f1-944f-60b98966ff1b',
-                    'name': 'John',
-                    'surname': 'Doe',
-                    'age': 25,
-                },
-            ),
-        ],
     )
     @methods.add
     @validator.validate
@@ -576,30 +580,17 @@ and Swagger UI web tool with basic auth:
         user_id = uuid.uuid4().hex
         flask.current_app.users_db[user_id] = user
 
-        return UserOut(id=user_id, **user.dict())
+        return UserOut(id=user_id, **user.model_dump())
 
 
     @specs.annotate(
+        summary='Returns a user',
         tags=['users'],
         errors=[NotFoundError],
-        examples=[
-            specs.MethodExample(
-                summary='Simple example',
-                params=dict(
-                    user_id='c47726c6-a232-45f1-944f-60b98966ff1b',
-                ),
-                result={
-                    'id': 'c47726c6-a232-45f1-944f-60b98966ff1b',
-                    'name': 'John',
-                    'surname': 'Doe',
-                    'age': 25,
-                },
-            ),
-        ],
     )
     @methods.add
     @validator.validate
-    def get_user(user_id: uuid.UUID) -> UserOut:
+    def get_user(user_id: UserId) -> UserOut:
         """
         Returns a user.
 
@@ -612,25 +603,17 @@ and Swagger UI web tool with basic auth:
         if not user:
             raise NotFoundError()
 
-        return UserOut(id=user_id, **user.dict())
+        return UserOut(id=user_id, **user.model_dump())
 
 
     @specs.annotate(
+        summary='Deletes a user',
         tags=['users'],
         errors=[NotFoundError],
-        examples=[
-            specs.MethodExample(
-                summary='Simple example',
-                params=dict(
-                    user_id='c47726c6-a232-45f1-944f-60b98966ff1b',
-                ),
-                result=None,
-            ),
-        ],
     )
     @methods.add
     @validator.validate
-    def delete_user(user_id: uuid.UUID) -> None:
+    def delete_user(user_id: UserId) -> None:
         """
         Deletes a user.
 
@@ -664,8 +647,6 @@ and Swagger UI web tool with basic auth:
             ],
             schema_extractor=extractors.pydantic.PydanticSchemaExtractor(),
             ui=specs.SwaggerUI(),
-            # ui=specs.RapiDoc(),
-            # ui=specs.ReDoc(),
         ),
     )
     json_rpc.dispatcher.add_methods(methods)

docs/source/pjrpc/extending.rst

@@ -30,11 +30,12 @@ an JSON-RPC server implementation based on :py:mod:`http.server` standard python
                 self.send_error(http.HTTPStatus.BAD_REQUEST)
                 return
 
-            response_text = self.server.dispatcher.dispatch(request_text, context=self)
-            if response_text is None:
+            response = self.server.dispatcher.dispatch(request_text, context=self)
+            if response is None:
                 self.send_response_only(http.HTTPStatus.OK)
                 self.end_headers()
             else:
+                response_text, error_codes = response
                 self.send_response(http.HTTPStatus.OK)
                 self.send_header("Content-type", pjrpc.common.DEFAULT_CONTENT_TYPE)
                 self.end_headers()