Repository navigation
Type annotation of methods which are returning {api_endpoint}.call_with_http_info for asynchronous api is incorrect #2629
Description
Describe the bug
For example in [1]:
def create_spans_metric(
self,
body: SpansMetricCreateRequest,
) -> SpansMetricResponse:
"""Create a span-based metric.
Create a metric based on your ingested spans in your organization.
Returns the span-based metric object from the request body when the request is successful.
:param body: The definition of the new span-based metric.
:type body: SpansMetricCreateRequest
:rtype: SpansMetricResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body
return self._create_spans_metric_endpoint.call_with_http_info(**kwargs)when the api client is async, the function returns coroutine. So the return type should be updated to
- ) -> SpansMetricCreateRequest:
+ ) -> SpansMetricCreateRequest | Awaitable[SpansMetricCreateRequest]:Type checkers are not happy about the current state
Activity
github-actions commentedon Jul 17, 2025
Thanks for your contribution!
This issue has been automatically marked as stale because it has not had activity in the last 30 days. Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity. Thank you for participating in the Datadog open source community.
If you would like this issue to remain open:
Verify that you can still reproduce the issue in the latest version of this project.
Comment that the issue is still reproducible and include updated details requested in the issue template.
zhukovgreen commentedon Aug 4, 2025
Yes, it is reproducible
github-actions commentedon Sep 27, 2025
Thanks for your contribution!
This issue has been automatically marked as stale because it has not had activity in the last 30 days. Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity. Thank you for participating in the Datadog open source community.
If you would like this issue to remain open:
Verify that you can still reproduce the issue in the latest version of this project.
Comment that the issue is still reproducible and include updated details requested in the issue template.