Merge pull request #122 from dapper91/dev

- pydantic 2.11 compatibility.
- request kwargs passed to a tracer.
- pydantic validator model cached.

Author: dapper91

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+1.14.0 (2025-04-08)
+-------------------
+
+- pydantic 2.11 compatibility.
+- request kwargs passed to a tracer.
+- pydantic validator model cached.
+
+
 1.13.0 (2025-02-15)
 ------------------
 

docs/source/pjrpc/tracing.rst

@@ -28,7 +28,7 @@ The following example illustrate opentracing integration. All you need is just i
             super().__init__()
             self._tracer = opentracing.global_tracer()
 
-        async def on_request_begin(self, trace_context, request):
+        async def on_request_begin(self, trace_context, request, request_kwargs):
             span = self._tracer.start_active_span(f'jsonrpc.{request.method}').span
             span.set_tag(tags.COMPONENT, 'pjrpc.client')
             span.set_tag(tags.SPAN_KIND, tags.SPAN_KIND_RPC_CLIENT)

examples/client_prometheus_metrics.py

@@ -11,7 +11,7 @@
 
 
 class PrometheusTracer(tracer.Tracer):
-    def on_request_begin(self, trace_context, request):
+    def on_request_begin(self, trace_context, request, request_kwargs):
         trace_context.started_at = time.time()
         method_call_total.labels(request.method).inc()
 

examples/client_tracing.py

@@ -1,5 +1,5 @@
 import opentracing
-from opentracing import tags
+from opentracing import propagation, tags
 
 from pjrpc.client import tracer
 from pjrpc.client.backend import requests as pjrpc_client
@@ -11,11 +11,18 @@ def __init__(self):
         super().__init__()
         self._tracer = opentracing.global_tracer()
 
-    def on_request_begin(self, trace_context, request):
+    def on_request_begin(self, trace_context, request, request_kwargs):
         span = self._tracer.start_active_span(f'jsonrpc.{request.method}').span
         span.set_tag(tags.COMPONENT, 'pjrpc.client')
         span.set_tag(tags.SPAN_KIND, tags.SPAN_KIND_RPC_CLIENT)
 
+        http_headers = request_kwargs.setdefault('headers', {})
+        self._tracer.inject(
+            span_context=span,
+            format=propagation.Format.HTTP_HEADERS,
+            carrier=http_headers,
+        )
+
     def on_request_end(self, trace_context, request, response):
         span = self._tracer.active_span
         span.set_tag(tags.ERROR, response.is_error)

pjrpc/__about__.py

@@ -2,7 +2,7 @@
 __description__ = 'Extensible JSON-RPC library'
 __url__ = 'https://github.com/dapper91/pjrpc'
 
-__version__ = '1.13.0'
+__version__ = '1.14.0'
 
 __author__ = 'Dmitry Pershin'
 __email__ = '[email protected]'

pjrpc/client/client.py

@@ -486,6 +486,8 @@ def traced(method: Callable[..., Any]) -> Callable[..., Any]:
         def wrapper(
             self: 'AbstractClient',
             request: AbstractRequest,
+            response_class: Type[AbstractResponse],
+            validator: Callable[..., None],
             _trace_ctx: Optional[SimpleNamespace] = None,
             **kwargs: Any,
         ) -> Optional[AbstractResponse]:
@@ -496,10 +498,12 @@ def wrapper(
             trace_ctx = _trace_ctx or SimpleNamespace()
 
             for tracer in self._tracers:
-                tracer.on_request_begin(trace_ctx, request)
+                tracer.on_request_begin(trace_ctx, request, kwargs)
 
             try:
-                response = method(self, request, _trace_ctx=trace_ctx, **kwargs)
+                response = method(
+                    self, request, response_class=response_class, validator=validator, _trace_ctx=trace_ctx, **kwargs,
+                )
             except BaseException as e:
                 for tracer in self._tracers:
                     tracer.on_error(trace_ctx, request, e)
@@ -620,6 +624,8 @@ def traced(method: Callable[..., Any]) -> Callable[..., Any]:
         async def wrapper(
             self: 'AbstractAsyncClient',
             request: Request,
+            response_class: Type[AbstractResponse],
+            validator: Callable[..., None],
             _trace_ctx: Optional[SimpleNamespace] = None,
             **kwargs: Any,
         ) -> Response:
@@ -630,10 +636,12 @@ async def wrapper(
             trace_ctx = _trace_ctx or SimpleNamespace()
 
             for tracer in self._tracers:
-                tracer.on_request_begin(trace_ctx, request)
+                tracer.on_request_begin(trace_ctx, request, kwargs)
 
             try:
-                response = await method(self, request, _trace_ctx=trace_ctx, **kwargs)
+                response = await method(
+                    self, request, response_class=response_class, validator=validator, _trace_ctx=trace_ctx, **kwargs,
+                )
             except BaseException as e:
                 for tracer in self._tracers:
                     tracer.on_error(trace_ctx, request, e)

pjrpc/client/tracer.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Generic, Optional, TypeVar
+from typing import Any, Generic, Optional, TypeVar
 
 from pjrpc import AbstractRequest, AbstractResponse
 
@@ -13,12 +13,18 @@ class Tracer(Generic[ContextType]):
     JSON-RPC client tracer.
     """
 
-    def on_request_begin(self, trace_context: ContextType, request: AbstractRequest) -> None:
+    def on_request_begin(
+        self,
+        trace_context: ContextType,
+        request: AbstractRequest,
+        request_kwargs: dict[str, Any],
+    ) -> None:
         """
         Handler called before JSON-RPC request begins.
 
         :param trace_context: request trace context
         :param request: JSON-RPC request
+        :param request_kwargs: additional request arguments
         """
 
     def on_request_end(
@@ -53,15 +59,26 @@ def __init__(self, logger: logging.Logger = client_logger, level: int = logging.
         self._logger = logger
         self._level = level
 
-    def on_request_begin(self, trace_context: ContextType, request: AbstractRequest) -> None:
+    def on_request_begin(
+        self,
+        trace_context: ContextType,
+        request: AbstractRequest,
+        request_kwargs: dict[str, Any],
+    ) -> None:
         self._logger.log(self._level, "sending request: %r", request)
 
     def on_request_end(
-        self, trace_context: ContextType, request: AbstractRequest, response: Optional[AbstractResponse],
+        self,
+        trace_context: ContextType,
+        request: AbstractRequest,
+        response: Optional[AbstractResponse],
     ) -> None:
         self._logger.log(self._level, "received response: %r", response)
 
     def on_error(
-        self, trace_context: ContextType, request: AbstractRequest, error: BaseException,
+        self,
+        trace_context: ContextType,
+        request: AbstractRequest,
+        error: BaseException,
     ) -> None:
         self._logger.log(self._level, "request '%s' sending error: %r", request, error)

pjrpc/server/validators/pydantic.py

@@ -1,6 +1,6 @@
 import functools as ft
 import inspect
-from typing import Any, Callable, Dict, Iterable, List, Optional
+from typing import Any, Callable, Dict, Iterable, List, Optional, Type
 
 import pydantic
 
@@ -45,10 +45,7 @@ def validate_method(
         """
 
         signature = self.signature(method, tuple(exclude))
-        schema = self.build_validation_schema(signature)
-
-        params_model = pydantic.create_model(method.__name__, **schema, model_config=self._model_config)
-
+        params_model = self.build_validation_model(method.__name__, signature)
         bound_params = self.bind(signature, params)
         try:
             obj = params_model(**bound_params.arguments)
@@ -58,6 +55,10 @@ def validate_method(
         return {attr: getattr(obj, attr) for attr in obj.model_fields} if self._coerce else bound_params.arguments
 
     @ft.lru_cache(maxsize=None)
+    def build_validation_model(self, method_name: str, signature: inspect.Signature) -> Type[pydantic.BaseModel]:
+        schema = self.build_validation_schema(signature)
+        return pydantic.create_model(method_name, **schema, __config__=self._model_config)
+
     def build_validation_schema(self, signature: inspect.Signature) -> Dict[str, Any]:
         """
         Builds pydantic model based validation schema from method signature.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pjrpc"
-version = "1.13.0"
+version = "1.14.0"
 description = "Extensible JSON-RPC library"
 authors = ["Dmitry Pershin <[email protected]>"]
 license = "Unlicense"

tests/client/test_tracer.py

@@ -54,7 +54,7 @@ class Tracer(client.Tracer):
         else:
             cli.send(req, _trace_ctx=trace_ctx)
 
-        tracer.on_request_begin.assert_called_once_with(trace_ctx, req)
+        tracer.on_request_begin.assert_called_once_with(trace_ctx, req, {})
         tracer.on_request_end.assert_called_once_with(trace_ctx, req, resp)
 
 
@@ -106,5 +106,5 @@ class Tracer(client.Tracer):
         else:
             await cli.send(req, _trace_ctx=trace_ctx)
 
-        tracer.on_request_begin.assert_called_once_with(trace_ctx, req)
+        tracer.on_request_begin.assert_called_once_with(trace_ctx, req, {})
         tracer.on_request_end.assert_called_once_with(trace_ctx, req, resp)