Improve `Dataset.map` `keep_attrs`

Open
#11,719 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
8/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
python
Domain
data

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

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.
Dominant language
Python
Stars
4.2k
Forks
1.5k
Avg merge
2d 21h
Merged PRs (30d)
74

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pydata/xarray

All issues in pydata/xarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.