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

未关闭
#95 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
python

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
0
派生
1
平均合并
15 小时 25 分钟
30 天内合并 PR
60

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

scipp/essapps 的其他 Issue

查看 scipp/essapps 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。