Skip to content

httpx: update type hints to RequestInfo/ResponseInfo #3105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 17, 2024
Merged

httpx: update type hints to RequestInfo/ResponseInfo #3105

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d642c14
Use the right type hints on httpx `RequestInfo`/`ResponseInfo`
Kludex Dec 13, 2024
b77e170
add changelog entry
Kludex Dec 13, 2024
65f5e23
add nitpick
Kludex Dec 16, 2024
ff4086f
Update docs/nitpick-exceptions.ini
emdneto Dec 16, 2024
436a613
Merge branch 'main' into update-httpx-type-hints
emdneto Dec 16, 2024
bbd7aea
Update CHANGELOG.md
Kludex Dec 17, 2024
457d2d3
Merge branch 'main' into update-httpx-type-hints
emdneto Dec 17, 2024
32c9ba7
Merge branch 'main' into update-httpx-type-hints
lzchen Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

- `opentelemetry-instrumentation-httpx` Update `RequestInfo`/`ResponseInfo` type hints
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `opentelemetry-instrumentation-httpx` Update `RequestInfo`/`ResponseInfo` type hints
### 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
Expand Down
2 changes: 2 additions & 0 deletions docs/nitpick-exceptions.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ py-class=
httpx.SyncByteStream
httpx.AsyncByteStream
httpx.Response
httpx.URL
httpx.Headers
aiohttp.web_request.Request
yarl.URL
cimpl.Producer
Expand Down
8 changes: 5 additions & 3 deletions ...n/opentelemetry-instrumentation-httpx/src/opentelemetry/instrumentation/httpx/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,8 @@ async def async_response_hook(span, request, response):
---
"""

from __future__ import annotations

import logging
import typing
from asyncio import iscoroutinefunction
Expand Down Expand Up @@ -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]
]
Expand All @@ -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]

Expand Down
Loading