simvue-io / simvue-io/python-api

Support sending gzipped request bodies

Ouverte
#923 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
4
Forks
1
Merge moyen
5 j 8 h
PR mergées (30 j)
4

Description

Whenever there is a large amount of content the Python API should gzip the body and include the following header:

"Content-Encoding": "gzip"

This should be done for:

  • Sending large numbers of runs, i.e. "loadSim"
  • Sending scalar or non-scalar metrics
  • Sending events

In the requests post you can just do:

data=gzip.compress(msgpack.packb(data, use_bin_type=True))

or

data=gzip.compress(json.dumps(data).encode("utf-8"))

as appropriate. Obviously don't use json=... any more in requests.post(...), use data=... instead.

Guide de contribution

Ouvrir le guide de contribution

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.

Piste de recherche

Commencez par les chemins de requête de l’API Python pour loadSim, les métriques scalaires et non scalaires, ainsi que les événements, en vous concentrant sur leurs appels à requests.post et leurs charges utiles actuelles en JSON ou msgpack. La tâche est terminée lorsque les corps de requête volumineux concernés utilisent data= avec une compression gzip et envoient l’en-tête Content-Encoding: gzip pour les trois opérations.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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