Type annotation of methods which are returning {api_endpoint}.call_with_http_info for asynchronous api is incorrect
还没有人认领这个 Issue。
评估
调研方向
从 src/datadog_api_client/v2/api/spans_metrics_api.py 的第 134-150 行附近开始,检查异步 API 客户端如何调用 call_with_http_info。根据 coroutine 的行为检查受影响方法的注解,然后验证类型检查器是否接受修正后的返回类型;当异步方法准确描述其可能的返回值时,即表示完成。
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- Python
- 星标
- 166
- 派生
- 55
- 平均合并
- 2 天 17 小时
- 30 天内合并 PR
- 73
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
DataDog/datadog-api-client-python 的其他 Issue
-
stale
难度 1/5 1-3 小时 新手友好度 72/100
DataDog/datadog-api-client-python#3535 · 1 条评论 ·
-
kind/bug stale
难度 3/5 1-2 天 新手友好度 66/100
DataDog/datadog-api-client-python#3717 · 3 条评论 ·
-
kind/bug stale
难度 3/5 1-2 天 新手友好度 75/100
DataDog/datadog-api-client-python#3656 · 1 条评论 ·
-
kind/bug stale
难度 3/5 1-2 天 新手友好度 38/100
DataDog/datadog-api-client-python#3120 · 1 条评论 ·
-
stale
难度 3/5 1-2 天 新手友好度 45/100
DataDog/datadog-api-client-python#2986 · 1 条评论 ·
查看 DataDog/datadog-api-client-python 的全部 Issue
相似的 Issue
-
essnmx good first issue
难度 1/5 1 小时以内 新手友好度 95/100
-
难度 2/5 1-3 小时 新手友好度 65/100
syfoud/Simulated_Scepter#174 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
Giskard-AI/giskard-oss#2840 · 1 条评论 ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success 未关闭area: repo bug perceived difficulty: 2
难度 2/5 1-3 小时 新手友好度 70/100
-
难度 2/5 1-3 小时 新手友好度 75/100
yeti-platform/yeti#1380 ·