Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Type annotation of methods which are returning {api_endpoint}.call_with_http_info for asynchronous api is incorrect

Ouverte
  • Quelque chose ne va pas ?
#2,629 3 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
api

Piste de recherche

Commencez dans src/datadog_api_client/v2/api/spans_metrics_api.py autour des lignes 134-150 et examinez comment le client API asynchrone appelle call_with_http_info. Vérifiez les annotations des méthodes concernées par rapport au comportement de la coroutine, puis vérifiez que les vérificateurs de types acceptent les types de retour corrigés ; le travail est terminé lorsque les méthodes asynchrones décrivent correctement leurs valeurs de retour possibles.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

kind/bug stale

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

[1] https://github.com/DataDog/datadog-api-client-python/blob/master/src/datadog_api_client/v2/api/spans_metrics_api.py#L134-L150

Langage dominant
Python
Étoiles
167
Forks
55
Merge moyen
3 j 17 h
PR mergées (30 j)
80

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de DataDog/datadog-api-client-python

Toutes les issues de DataDog/datadog-api-client-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.