httpx: update type hints to RequestInfo/ResponseInfo (#3105)

open-telemetry · Dec 17, 2024 · d155540 · d155540
1 parent f8b0f72
commit d155540
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Fixed
+
+- `opentelemetry-instrumentation-httpx` Fix `RequestInfo`/`ResponseInfo` type hints
+  ([#3105](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3105))
+
 ## Version 1.29.0/0.50b0 (2024-12-11)
 
 ### Added

diff --git a/docs/nitpick-exceptions.ini b/docs/nitpick-exceptions.ini
@@ -29,6 +29,8 @@ py-class=
     httpx.SyncByteStream
     httpx.AsyncByteStream
     httpx.Response
+    httpx.URL
+    httpx.Headers
     aiohttp.web_request.Request
     yarl.URL
     cimpl.Producer

diff --git a/...n/opentelemetry-instrumentation-httpx/src/opentelemetry/instrumentation/httpx/__init__.py b/...n/opentelemetry-instrumentation-httpx/src/opentelemetry/instrumentation/httpx/__init__.py
@@ -192,6 +192,8 @@ async def async_response_hook(span, request, response):
 ---
 """
 
+from __future__ import annotations
+
 import logging
 import typing
 from asyncio import iscoroutinefunction
@@ -249,8 +251,8 @@ async def async_response_hook(span, request, response):
 
 class RequestInfo(typing.NamedTuple):
     method: bytes
-    url: URL
-    headers: typing.Optional[Headers]
+    url: httpx.URL
+    headers: httpx.Headers | None
     stream: typing.Optional[
         typing.Union[httpx.SyncByteStream, httpx.AsyncByteStream]
     ]
@@ -259,7 +261,7 @@ class RequestInfo(typing.NamedTuple):
 
 class ResponseInfo(typing.NamedTuple):
     status_code: int
-    headers: typing.Optional[Headers]
+    headers: httpx.Headers | None
     stream: typing.Iterable[bytes]
     extensions: typing.Optional[dict]