Improve `Dataset.map` `keep_attrs`

Abierto
#11,719 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
8/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Activo
Stack tecnológico
python
Área
data

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Python
Estrellas
4.2k
Forks
1.5k
Merge medio
2 d 21 h
PR fusionados (30 d)
74

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pydata/xarray

Todos los issues de pydata/xarray

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.