What a UI needs from the client: records that fit a type, and short record labels

Abierto
  • ¿Algo no está bien?
#95 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python
Área
backend-api-design

Línea de trabajo

Read the form spike in issue #89 and the client and backend APIs, including the cited backend.py locations (1177, 1286, 1448, and 1915). Compare each workaround with the five suggested client API gaps, including the related issue #88. Done means deciding which API changes to make and how to cover record filtering, spec lookup, readability, labels, and typed failure reasons; the issue does not identify tests.

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

Descripción

The form spike (#89) builds a Panel app on local(), with a record picker at each place that takes a reference. It found five gaps in the client API; gaps 1 and 4 are still open. Until they are decided, ess.apps.panel.Listing stands in for both, using only public API.

Gap 1: no query for records whose outputs fit a type. Listing.fitting(tp) lists client.records(), asks client.readable which outputs each may reference, and checks each output's type against tp with fits, on the client side. On the service that lists every record of the proposal at each refresh. Suggestion: client.records(fits=tp), or a record that carries its output types.

Gap 4: no short label for a record. The id is a 32-hex UUID, and label/member are names the user gives to a sequence. Listing builds id[:6] and the spec title, followed by the files and records that the request names directly (iter_refs), e.g. 649172 I(Q), from ae7a03, run 102, 5b025e, run 110. Suggestion: a short record number per proposal, or a display name that the backend assigns.

#89 closed gaps 2, 3 and 5: client.spec, client.specs, client.readable (the names of the outputs a submission may reference now, per record), and failures that name the error type.

Lenguaje dominante
Python
Estrellas
0
Forks
0
Merge medio
15 h 25 min
PR fusionados (30 d)
60

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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.

Más de scipp/essapps

Todos los issues de scipp/essapps

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.