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

Đang mở
  • Có gì không ổn?
#95 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
backend-api-design

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
0
Fork
1
Merge trung bình
9 giờ 40 phút
Pull request đã merge (30 ngày)
60

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của scipp/essapps

Tất cả issue của scipp/essapps

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.