Skip to content
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

Fix wrong unpickling with dask 2024.11 #1993

Merged
merged 4 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ Changelog

v0.54.0 (unreleased)
--------------------
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`),
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Pascal Bourgault (:user:`aulemahal`).

Breaking changes
----------------
* The minimum required version of `dask` has been increased to `2024.8.1`. `dask` versions at or above `2024.11` are not yet supported. (:issue:`1992`, :pull:`1991`).
aulemahal marked this conversation as resolved.
Show resolved Hide resolved

Bug fixes
^^^^^^^^^
* Fixes ``xclim.sdba.Grouper`` and other classes for usage with dask 2024.11 (:issue:`1992`, :pull:`1993`).
aulemahal marked this conversation as resolved.
Show resolved Hide resolved

v0.53.2 (2024-10-31)
--------------------
Contributors to this version: Éric Dupuis (:user:`coxipi`), Pascal Bourgault (:user:`aulemahal`), Trevor James Smith (:user:`Zeitsperre`).
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dependencies:
- cf_xarray >=0.9.3
- cftime >=1.4.1
- click >=8.1
- dask >=2024.8.1,<2024.11.0
- dask >=2024.8.1
- filelock >=3.14.0
- jsonpickle >=3.1.0
- numba >=0.54.1
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ dependencies = [
"cf-xarray >=0.9.3", # cf-xarray is differently named on conda-forge
"cftime >=1.4.1",
"click >=8.1",
"dask[array] >=2024.8.1,<2024.11.0",
"dask[array] >=2024.8.1",
"filelock >=3.14.0",
"jsonpickle >=3.1.0",
"numba >=0.54.1",
Expand Down
18 changes: 9 additions & 9 deletions xclim/sdba/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

from __future__ import annotations

from collections import UserDict
from collections.abc import Callable, Sequence
from inspect import _empty, signature # noqa

Expand All @@ -20,7 +21,7 @@


# ## Base class for the sdba module
class Parametrizable(dict):
class Parametrizable(UserDict):
"""Helper base class resembling a dictionary.

This object is _completely_ defined by the content of its internal dictionary, accessible through item access
Expand All @@ -35,24 +36,23 @@ class Parametrizable(dict):

def __getstate__(self):
"""For (json)pickle, a Parametrizable should be defined by its internal dict only."""
return self.parameters
return self.data

def __setstate__(self, state):
"""For (json)pickle, a Parametrizable in only defined by its internal dict."""
self.update(state)
# Unpickling skips the init, so we must _set_ data, we can't just update it - it's not there yet
self.data = {**state}

def __getattr__(self, attr):
"""Get attributes."""
try:
return self.__getitem__(attr)
except KeyError as err:
# Raise the proper error type for getattr
raise AttributeError(*err.args) from err
if attr == "data" or attr not in self.data:
return self.__getattribute__(attr)
return self.data[attr]

@property
def parameters(self) -> dict:
"""All parameters as a dictionary. Read-only."""
return {**self}
return {**self.data}

def __repr__(self) -> str:
"""Return a string representation."""
Expand Down
Loading