Skip to content

fix(skore-local-project): Clear the report cache instead of deleting it before serialization #2017

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

Merged
merged 1 commit into from
Sep 5, 2025
Merged

fix(skore-local-project): Clear the report cache instead of deleting it before serialization #2017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion skore-local-project/src/skore_local_project/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,9 @@ def pickle(report: EstimatorReport | CrossValidationReport) -> tuple[str, bytes]
The report is pickled without its cache, to avoid salting the hash.
"""
reports = [report] + getattr(report, "estimator_reports_", [])
caches = [report_to_clear.__dict__.pop("_cache") for report_to_clear in reports]
caches = [report_to_clear._cache for report_to_clear in reports]

report.clear_cache()

try:
with io.BytesIO() as stream:
Expand Down
32 changes: 26 additions & 6 deletions skore-local-project/tests/unit/test_project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,36 +126,56 @@ def test_init(self, monkeypatch, tmp_path):
def test_pickle_estimator_report(self, regression):
# Pickle the report once, without any value in the cache
assert not regression._cache
pickle_1 = Project.pickle(regression)
hash1, pickle1 = Project.pickle(regression)
assert not regression._cache

# Pickle the same report, but with values in the cache
regression.cache_predictions()

assert regression._cache
pickle_2 = Project.pickle(regression)
hash2, pickle2 = Project.pickle(regression)
assert regression._cache

# Make sure that the two pickles on the report are not affected by the cache
assert pickle_1 == pickle_2
assert (hash1, pickle1) == (hash2, pickle2)

# Make sure that pickles are not broken
with BytesIO(pickle1) as stream:
report1 = joblib.load(stream)

with BytesIO(pickle2) as stream:
report2 = joblib.load(stream)

report1.cache_predictions()
report2.cache_predictions()

def test_pickle_cross_validation_report(self, cv_regression):
reports = [cv_regression] + cv_regression.estimator_reports_

# Pickle the report once, without any value in the cache
assert not any(report._cache for report in reports)
pickle_1 = Project.pickle(cv_regression)
hash1, pickle1 = Project.pickle(cv_regression)
assert not any(report._cache for report in reports)

# Pickle the same report, but with values in the cache
cv_regression.cache_predictions()

assert any(report._cache for report in reports)
pickle_2 = Project.pickle(cv_regression)
hash2, pickle2 = Project.pickle(cv_regression)
assert any(report._cache for report in reports)

# Make sure that the two pickles on the report are not affected by the cache
assert pickle_1 == pickle_2
assert (hash1, pickle1) == (hash2, pickle2)

# Make sure that pickles are not broken
with BytesIO(pickle1) as stream:
report1 = joblib.load(stream)

with BytesIO(pickle2) as stream:
report2 = joblib.load(stream)

report1.cache_predictions()
report2.cache_predictions()

def test_init_with_envar(self, monkeypatch, tmp_path):
monkeypatch.setenv("SKORE_WORKSPACE", str(tmp_path))
Expand Down
Loading