OpenFreeEnergy/alchemiscale

Add `limit` and `skip` to all `AlchemiscaleClient.query_*` methods

Ouverte

#149 ouverte le 20 juin 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Python (10 forks)auto 404
component-statestorecomponent-user-apicomponent-user-clientgood first issue

Métriques du dépôt

Stars
 (35 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

We currently do not implement limit and skip kwargs on AlchemiscaleClient.query_* methods. These will be needed for users querying a large database, as we do not want an arbitrarily-large number of returned results.

The default for limit should be set to e.g. ~1000 as a client-side parameter, with some configurable upper bound set on query API endpoints. The default for skip should be 0.

Guide contributeur

Direction de recherche
Examinez les méthodes de requête existantes dans la classe AlchemiscaleClient et ajoutez les arguments de mot clé `limit` et `skip` avec des valeurs par défaut (par exemple, limit=1000, skip=0). Modifiez les points de terminaison d'API côté serveur correspondants pour accepter ces paramètres et imposer une limite maximale configurable. Mettez à jour les tests et la documentation pour refléter les modifications.
Stack technique
python
Domaine
backendapi
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60