Skip to content

Fix description cache invalidation #1715

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

Open
emphor11 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix description cache invalidation #1715

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb4b6c4
Fix incorrect error message for invalid cache_format in get_dataset
emphor11 Mar 17, 2026
a3bf3c5
ENH: Add TTL-based cache invalidation for dataset description cache
emphor11 Mar 17, 2026
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
17 changes: 13 additions & 4 deletions openml/datasets/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
# ruff: noqa: PLR0913
from __future__ import annotations

import contextlib
import logging
import os
import time
import warnings
from collections import OrderedDict
from functools import partial
Expand Down Expand Up @@ -456,7 +458,7 @@ def get_dataset( # noqa: C901, PLR0912

if cache_format not in ["feather", "pickle"]:
raise ValueError(
"cache_format must be one of 'feather' or 'pickle. "
"cache_format must be one of 'feather' or 'pickle'. "
f"Invalid format specified: {cache_format}",
)

Expand Down Expand Up @@ -1071,6 +1073,9 @@ def _topic_delete_dataset(data_id: int, topic: str) -> int:
return int(data_id)


DESCRIPTION_CACHE_TTL = 86400 # 24 hours


def _get_dataset_description(did_cache_dir: Path, dataset_id: int) -> dict[str, Any]:
"""Get the dataset description as xml dictionary.

Expand All @@ -1090,11 +1095,15 @@ def _get_dataset_description(did_cache_dir: Path, dataset_id: int) -> dict[str,
XML Dataset description parsed to a dict.

"""
# TODO implement a cache for this that invalidates itself after some time
# This can be saved on disk, but cannot be cached properly, because
# it contains the information on whether a dataset is active.
description_file = did_cache_dir / "description.xml"

# Invalidate stale cache
if description_file.is_file():
file_age = time.time() - description_file.stat().st_mtime
if file_age >= DESCRIPTION_CACHE_TTL:
with contextlib.suppress(OSError):
description_file.unlink()

try:
with description_file.open(encoding="utf8") as fh:
dataset_xml = fh.read()
Expand Down