Skip to content

Deprecation of Dataset.update() returning a dataset object #10167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VeckoTheGecko opened this issue Mar 24, 2025 · 3 comments
Open

Deprecation of Dataset.update() returning a dataset object #10167

VeckoTheGecko opened this issue Mar 24, 2025 · 3 comments
Labels
needs triage Issue that has not been reviewed by xarray team member

Comments

@VeckoTheGecko
Copy link
Contributor

VeckoTheGecko commented Mar 24, 2025

What is your issue?

Version: latest

#4932 mentions that the return value of Dataset.update() will be removed in v0.21 (released Jan 28, 2022).

xarray/xarray/core/dataset.py

Lines 5547 to 5553 in fd7c765

Returns
-------
updated : Dataset
Updated dataset. Note that since the update is in-place this is the input
dataset.
It is deprecated since version 0.17 and scheduled to be removed in 0.21.

This functionality wasn't removed yet due to #5630 (comment).

I don't think there was a tracking issue for that PR comment before.

@VeckoTheGecko VeckoTheGecko added the needs triage Issue that has not been reviewed by xarray team member label Mar 24, 2025
Copy link

welcome bot commented Mar 24, 2025

Thanks for opening your first issue here at xarray! Be sure to follow the issue template!
If you have an idea for a solution, we would really welcome a Pull Request with proposed changes.
See the Contributing Guide for more.
It may take us a while to respond here, but we really value your contribution. Contributors like you help make xarray better.
Thank you!

@VeckoTheGecko
Copy link
Contributor Author

VeckoTheGecko commented Mar 24, 2025

Seems like this has already been given considerable thought, so not sure how useful making this issue is. I feel like I'm dusting off old bones in the codebase 😅 . Maintainers, what would be the best way forward?

  • make the dataset subclass (which as shoyer said, might be difficult to get right)
  • remove " and scheduled to be removed in 0.21."
  • leave as is? something else?

@keewis
Copy link
Collaborator

keewis commented Mar 24, 2025

I'd personally vote for completing the deprecation cycle (which was started about three years ago), but not sure how disruptive this would be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage Issue that has not been reviewed by xarray team member
Projects
None yet
Development

No branches or pull requests

2 participants