Improve `Dataset.map` `keep_attrs`

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

Hướng nghiên cứu

This is an open API design question, not a ready task: the issue asks maintainers to choose between three options for Dataset.map's keep_attrs. Start by reading the linked #11020, #11019 and #10726 threads to see what was already decided. Done means a maintainer-agreed design, so a newcomer should comment on the issue and wait for direction before writing code.

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

Mô tả

design question enhancement needs discussion
What is your issue?

Follow-up to #11020 / #11019.

Since #10726 (v2025.11.0) Dataset.map has no way to keep attributes set by the mapped function: keep_attrs=True overwrites them with the original attrs, keep_attrs=False drops them. #11020 fixes this regression by leaving the function's attrs alone for keep_attrs=False and merging with drop_conflicts for keep_attrs=True. The discussion there showed that the boolean keep_attrs is the wrong interface for map:

  • The function receives xarray objects, so it can handle attrs itself. keep_attrs mainly gets in the way of that (@dcherian, @max-sixty).
  • Coordinates can still be modified inside the function, so the coordinate attrs of the results need to be combined somehow. That is what the argument should control instead, e.g. as combine_attrs (@jsignell, @dcherian).
  • A boolean keep_attrs is ambiguous: does False mean "drop the input attrs" or "drop all attrs on the output"? (@keewis, @jsignell; see also #10997)
  • map is basically a loop over .data_vars, and users who need full control can do that loop themselves, e.g. ds.assign({name: func(var) for name, var in ds.data_vars.items()}) or xr.merge(..., combine_attrs=...) (@keewis, @jsignell).
  • Before deprecating keep_attrs, users need a way to opt into the new behavior (@keewis, @jsignell).

Options discussed for that:

  1. Add combine_attrs to map, accepting the usual strategy names / a callable, and deprecate keep_attrs. This is the option @keewis and @jsignell leaned towards.
  2. Let keep_attrs accept strategy names / a callable, like apply_ufunc, mapping True to "override" and False to "drop". This avoids a new argument, but a single value can't then control data variable and coordinate attrs separately.
  3. Remove keep_attrs from map without replacement and keep whatever attrs the function returns.
Ngôn ngữ chính
Python
Star
4.2k
Fork
1.5k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
74

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.