simvue-io / simvue-io/python-api

Support sending gzipped request bodies

Abierto
#923 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
4
Forks
1
Merge medio
5 d 8 h
PR fusionados (30 d)
4

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza por las rutas de solicitud de la API de Python para loadSim, las métricas escalares y no escalares, y los eventos, centrándote en sus llamadas a requests.post y en las cargas útiles actuales de JSON o msgpack. La tarea estará terminada cuando los cuerpos de solicitud grandes aplicables usen data= con compresión gzip y envíen el encabezado Content-Encoding: gzip para las tres operaciones.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
api
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
38/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.