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

Aperta
  • Qualcosa non va?
#95 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
backend-api-design

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
0
Fork
1
Merge medio
15h 25m
PR unite (30g)
60

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di scipp/essapps

Tutte le issue di scipp/essapps

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.