Feature Request: First-class representation of nested attributes

Đang mở
#11,240 0 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
30/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
developer-experience

Hướng nghiên cứu

Bắt đầu bằng cách truy vết các đường dẫn repr() và HTML repr của xarray trong Jupyter, sau đó kiểm tra cách ds.attrs và các thuộc tính của group hiện đang được hiển thị. Xác định phạm vi của biểu diễn trước khi triển khai; khi hoàn tất, phần triển khai phải hiển thị các object và array lồng nhau sâu theo cấu trúc rõ ràng, đồng thời mọi hành vi có thể mở rộng được yêu cầu phải được bao phủ bằng các bài kiểm thử biểu diễn.

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

Mô tả

enhancement topic-html-repr
Is your feature request related to a problem?

Formats such as Zarr store group attributes in JSON (e.g. .zattrs), so attributes can be deeply nested (objects and arrays). The current xarray APIs and built-in representations (e.g. repr(), HTML repr in Jupyter) typically expose attributes in a flat or single-level way. That makes it hard to inspect or document complex metadata in the IDE or in notebooks. Users either see a flattened view, truncated output, or have to manually traverse raw attribute dicts instead of seeing the structure xarray actually has at hand.

Xarray current HTML representation (only top-level attributes are shown, with full content):

Image
Describe the solution you'd like

First-class support for nested attributes in xarray’s APIs and/or representations, for example:

  • Repr / HTML repr: Optionally render nested attributes as an expandable/collapsible tree (or at least with clear indentation/structure) instead of a single-level or flattened dump, so users can see the full hierarchy in Jupyter and other environments that rely on xarray’s built-in repr.

The goal is that opening a dataset with rich nested metadata (e.g. from Zarr) feels natural in xarray: the repr and APIs should reflect that nesting rather than flattening or hiding it.

Describe alternatives you've considered
  • Manual traversal: Users can already walk ds.attrs (or group attrs) and pretty-print themselves. This doesn’t improve the default experience in Jupyter or the consistency of tooling.
  • Downstream-only handling: Some tools (e.g. Scientific Data Viewer) can render nested attributes in a tree view on the viewer side. That helps when using those tools but doesn’t improve the experience for users who only use xarray’s built-in repr or other consumers that follow xarray’s representation.
  • Leaving attributes as “opaque” dicts: Keeps implementation simple but under-serves users and formats (like Zarr) where nested metadata is the norm.

Example: Scientific Data Viewer nested representation of nested attributes with collapsible sections:

Image
Additional context
  • This would benefit anyone opening Zarr (or similar) datasets with rich .zattrs-style metadata in Jupyter or scripts.
  • Downstream projects (e.g. Scientific Data Viewer) could align their UIs with xarray’s representation for consistency when the same dataset is opened in xarray and in other tools.
  • Reference: Scientific Data Viewer – xarray and nested attributes (doc that motivated this request).
Ngôn ngữ chính
Python
Star
4.2k
Fork
1.5k
Merge trung bình
2 ngày 20 giờ
Pull request đã merge (30 ngày)
70

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 pydata/xarray

Tất cả issue của pydata/xarray

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.