[PR #12113/4d15c331 backport][3.14] fix: widen trace_request_ctx type to accept any object (#12118)

**This is a backport of PR #12113 as merged into master
(4d15c33).**

---------

Co-authored-by: nightcityblade <[email protected]>
Co-authored-by: Sam Bull <[email protected]>

Author: 3 people

CHANGES/10753.bugfix.rst

@@ -0,0 +1 @@
+Widened ``trace_request_ctx`` parameter type from ``Mapping[str, Any] | None`` to ``object`` to allow passing instances of user-defined classes as trace context -- by :user:`nightcityblade`.

aiohttp/client.py

@@ -14,7 +14,6 @@
     Coroutine,
     Generator,
     Iterable,
-    Mapping,
     Sequence,
 )
 from contextlib import suppress
@@ -194,7 +193,7 @@ class _RequestOptions(TypedDict, total=False):
     ssl: SSLContext | bool | Fingerprint
     server_hostname: str | None
     proxy_headers: LooseHeaders | None
-    trace_request_ctx: Mapping[str, Any] | None
+    trace_request_ctx: object
     read_bufsize: int | None
     auto_decompress: bool | None
     max_line_size: int | None
@@ -548,7 +547,7 @@ async def _request(
         ssl: SSLContext | bool | Fingerprint = True,
         server_hostname: str | None = None,
         proxy_headers: LooseHeaders | None = None,
-        trace_request_ctx: Mapping[str, Any] | None = None,
+        trace_request_ctx: object = None,
         read_bufsize: int | None = None,
         auto_decompress: bool | None = None,
         max_line_size: int | None = None,

aiohttp/tracing.py

@@ -1,6 +1,5 @@
-from collections.abc import Mapping
 from types import SimpleNamespace
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING, Any, TypeVar
 
 import attr
 from aiosignal import Signal
@@ -86,9 +85,7 @@ def __init__(
 
         self._trace_config_ctx_factory = trace_config_ctx_factory
 
-    def trace_config_ctx(
-        self, trace_request_ctx: Mapping[str, str] | None = None
-    ) -> SimpleNamespace:
+    def trace_config_ctx(self, trace_request_ctx: Any = None) -> SimpleNamespace:
         """Return a new trace_config_ctx instance"""
         return self._trace_config_ctx_factory(trace_request_ctx=trace_request_ctx)
 

tests/test_tracing.py

@@ -42,6 +42,19 @@ def test_trace_config_ctx_request_ctx(self) -> None:
         )
         assert trace_config_ctx.trace_request_ctx is trace_request_ctx
 
+    def test_trace_config_ctx_custom_class(self) -> None:
+        """Custom class instances should be accepted as trace_request_ctx (#10753)."""
+
+        class MyContext:
+            def __init__(self, request_id: int) -> None:
+                self.request_id = request_id
+
+        ctx = MyContext(request_id=42)
+        trace_config = TraceConfig()
+        trace_config_ctx = trace_config.trace_config_ctx(trace_request_ctx=ctx)
+        assert trace_config_ctx.trace_request_ctx is ctx
+        assert trace_config_ctx.trace_request_ctx.request_id == 42
+
     def test_freeze(self) -> None:
         trace_config = TraceConfig()
         trace_config.freeze()