Improve `Dataset.map` `keep_attrs`
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 8/100
Research direction
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.
Written by the indexing model from the issue text.
Description
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_attrsmainly 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_attrsis ambiguous: doesFalsemean "drop the input attrs" or "drop all attrs on the output"? (@keewis, @jsignell; see also #10997) mapis 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()})orxr.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:
- Add
combine_attrstomap, accepting the usual strategy names / a callable, and deprecatekeep_attrs. This is the option @keewis and @jsignell leaned towards. - Let
keep_attrsaccept strategy names / a callable, likeapply_ufunc, mappingTrueto"override"andFalseto"drop". This avoids a new argument, but a single value can't then control data variable and coordinate attrs separately. - Remove
keep_attrsfrommapwithout replacement and keep whatever attrs the function returns.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.5k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 74
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pydata/xarray
-
bug needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
`DataTree.map_over_datasets` behavior can be obscure sometimesPossibly taken @mohansree14 claimed this 23 days ago. Openneeds triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pydata/xarray#11813 · 1 comment ·
Maintainers usually reply within 1 day
-
Comparing attrs that contain a dict of NumPy arrays raises ValueError in identical / assert_identicalPossibly taken @SohamXYZDev claimed this 29 days ago. Openbug needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
pydata/xarray#11777 · 1 comment ·
Maintainers usually reply within 1 day
-
RangeIndex` with datetime64 bounds cannot be printed (`Unknown format code 'g'`)Possibly taken @d-chambers claimed this 60 days ago. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
pydata/xarray#11598 · 3 comments ·
Maintainers usually reply within 1 day
-
DataTree constructor error message says dict even though dict is not acceptedPossibly taken @aryansk claimed this 100 days ago. Openbug contrib-good-first-issue topic-DataTree topic-error reporting
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
pydata/xarray#11514 · 2 comments ·
Maintainers usually reply within 1 day
Similar issues
-
tests
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
[Plugin] 群聊记忆 · 人格养成Open
Difficulty 1/5 1-3 hours Newbie friendliness 74/100
-
bug maintainer-managed
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
awslabs/visual-asset-management-system#1759 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 66/100