Skip to content

Complete deprecation cycle for Dataset.update return value #10717

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 8, 2025
Merged

Complete deprecation cycle for Dataset.update return value #10717

merged 2 commits into from
Sep 8, 2025

Conversation

@max-sixty
Copy link
Collaborator

@max-sixty max-sixty commented Sep 7, 2025

Summary

  • Completes the deprecation cycle for Dataset.update() return value that was started in v0.17
  • The method now returns None instead of self, aligning with Python's standard dict.update() behavior

Changes

  • Modified Dataset.update() to return None instead of self
  • Updated docstring to remove return value documentation
  • Added breaking change entry to changelog

Closes #10167

Test plan

  • All existing tests pass without modification (they weren't using the return value)
  • Verified the method still updates the dataset in-place
  • Pre-commit checks pass
  • Type checking passes

🤖 Generated with Claude Code

@max-sixty
Complete deprecation cycle for Dataset.update return value
fb20e51 
- Dataset.update() now returns None instead of self
- Removes deprecation that was started in v0.17 and scheduled for removal in v0.21
- Updates documentation to remove return value information
- Aligns behavior with standard dict.update() which returns None

Closes pydata#10167
shoyer
shoyer approved these changes Sep 8, 2025
View reviewed changes
@max-sixty @shoyer
Update doc/whats-new.rst
e9c5d01 
Co-authored-by: Stephan Hoyer <shoyer@google.com>
@max-sixty max-sixty enabled auto-merge (squash) September 8, 2025 01:48
@max-sixty max-sixty merged commit 6336ffb into pydata:main Sep 8, 2025
36 checks passed
@max-sixty max-sixty deleted the 10167 branch September 8, 2025 02:05
brianhenn pushed a commit to ai2cm/ace that referenced this pull request Oct 15, 2025
@spencerkclark
Account for deprecation of xarray.Dataset.update return value (#2189)
5252fc0 
Update `ZonalPowerSpectrumComparison.get_dataset` to account for the
fact that `xarray.Dataset.update` now solely operates in place, rather
than operating in place and returning the updated `Dataset`
(pydata/xarray#10717).

Partially addresses #2188
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shoyer shoyer shoyer approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Deprecation of Dataset.update() returning a dataset object

2 participants

@max-sixty @shoyer