Merge pull request #68 from fractal-analytics-platform/improve_caching

add ttl and num entries to config

Author: lorenzocerrone

src/fractal_feature_explorer/config.py

@@ -4,7 +4,7 @@
 import streamlit as st
 from typing import Literal
 from typing import Annotated
-
+from datetime import timedelta
 from streamlit.logger import get_logger
 import os
 
@@ -22,17 +22,23 @@ def remove_trailing_slash(value: str) -> str:
     return value.rstrip("/")
 
 
-class LocalConfig(BaseModel):
+class BaseConfig(BaseModel):
     model_config = ConfigDict(extra="forbid")
-    deployment_type: Literal["local"]
+    deployment_type: Literal["local", "production"]
+    allow_local_paths: bool
+    cache_ttl: float | timedelta | str | None = None
+    cache_max_entries: int | None = None
+
+
+class LocalConfig(BaseConfig):
+    deployment_type: Literal["local"]  # type: ignore override type
     fractal_data_urls: list[Annotated[str, AfterValidator(remove_trailing_slash)]]
     allow_local_paths: bool = True
 
 
-class ProductionConfig(BaseModel):
-    model_config = ConfigDict(extra="forbid")
-    deployment_type: Literal["production"]
-    allow_local_paths: Literal[False] = False
+class ProductionConfig(BaseConfig):
+    deployment_type: Literal["production"]  # type: ignore override type
+    allow_local_paths: Literal[False] = False  # type: ignore override type
     fractal_data_url: Annotated[str, AfterValidator(remove_trailing_slash)]
     fractal_backend_url: Annotated[str, AfterValidator(remove_trailing_slash)]
     fractal_frontend_url: Annotated[str, AfterValidator(remove_trailing_slash)]
@@ -103,3 +109,23 @@ def get_config() -> LocalConfig | ProductionConfig:
     logger.debug(f"{config=}")
     logger.info(f"Streamlit version: {st.__version__}")
     return config
+
+
+def st_cache_data_wrapper(func):
+    """
+    Wrapper around st.cache_data to set a default ttl.
+    """
+    config = get_config()
+    return st.cache_data(ttl=config.cache_ttl, max_entries=config.cache_max_entries)(
+        func
+    )
+
+
+def st_cache_resource_wrapper(func):
+    """
+    Wrapper around st.cache_resource to set a default ttl.
+    """
+    config = get_config()
+    return st.cache_resource(
+        ttl=config.cache_ttl, max_entries=config.cache_max_entries
+    )(func)

src/fractal_feature_explorer/pages/setup_page/_tables_io.py

@@ -17,6 +17,7 @@
     plate_name_from_url,
     extras_from_url,
 )
+from fractal_feature_explorer.config import st_cache_data_wrapper
 
 from streamlit.logger import get_logger
 
@@ -93,7 +94,7 @@ def list_images_tables(
 # ====================================================================
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _load_single_plate_condition_table(
     url: str,
     table_name: str,
@@ -122,7 +123,7 @@ def _load_single_plate_condition_table(
     return table_df
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _collect_condition_table_from_plates_cached(
     list_urls: list[str],
     table_name: str,
@@ -139,7 +140,7 @@ def _collect_condition_table_from_plates_cached(
     return condition_table
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _collect_condition_table_from_images_cached(
     list_urls: list[str],
     table_name: str,
@@ -214,7 +215,7 @@ def collect_condition_table_from_images(
 # ====================================================================
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _load_plate_feature_table(
     url: str,
     table_name: str,
@@ -249,7 +250,7 @@ def _load_plate_feature_table(
     return table_df
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _collect_feature_table_from_plates_cached(
     list_urls: list[str],
     table_name: str,
@@ -264,7 +265,7 @@ def _collect_feature_table_from_plates_cached(
     return feature_table
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _collect_feature_table_from_images_cached(
     list_urls: list[str],
     table_name: str,

src/fractal_feature_explorer/utils/ngio_io_caches.py

@@ -26,7 +26,11 @@
 from fractal_feature_explorer.utils import get_fractal_token
 from streamlit.logger import get_logger
 
-from fractal_feature_explorer.config import get_config
+from fractal_feature_explorer.config import (
+    get_config,
+    st_cache_data_wrapper,
+    st_cache_resource_wrapper,
+)
 
 logger = get_logger(__name__)
 
@@ -78,7 +82,7 @@ def is_http_url(url: str) -> bool:
     return url.startswith("http://") or url.startswith("https://")
 
 
-@st.cache_data
+@st_cache_resource_wrapper
 def _get_http_store(
     url: str, fractal_token: str | None = None
 ) -> fsspec.mapping.FSMap | None:
@@ -140,7 +144,7 @@ def get_and_validate_store(url: str) -> fsspec.mapping.FSMap | str | None:
     return _get_and_validate_store(url, fractal_token=fractal_token)
 
 
-@st.cache_resource
+@st_cache_resource_wrapper
 def _get_ome_zarr_plate(url: str, fractal_token: str | None = None) -> OmeZarrPlate:
     store = _get_and_validate_store(url, fractal_token=fractal_token)
     if store is None:
@@ -154,7 +158,7 @@ def get_ome_zarr_plate(url: str) -> OmeZarrPlate:
     return _get_ome_zarr_plate(url, fractal_token=fractal_token)
 
 
-@st.cache_resource
+@st_cache_resource_wrapper
 def _get_ome_zarr_image_container(
     url: str, fractal_token: str | None = None
 ) -> OmeZarrContainer:
@@ -176,7 +180,7 @@ def _get_ome_zarr_container_in_plate(
     return images[path]
 
 
-@st.cache_resource
+@st_cache_resource_wrapper
 def _get_ome_zarr_container(
     url: str,
     fractal_token: str | None = None,
@@ -198,7 +202,7 @@ def get_ome_zarr_container(
     return _get_ome_zarr_image_container(url, fractal_token=fractal_token)
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _list_image_tables(
     urls: list[str],
     fractal_token: str | None = None,
@@ -212,7 +216,7 @@ def _list_image_tables(
     return image_list
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def list_image_tables(
     urls: list[str],
     fractal_token: str | None = None,
@@ -245,7 +249,7 @@ def roi_to_slice_kwargs(
     return raster_roi  # type: ignore
 
 
-@st.cache_resource
+@st_cache_resource_wrapper
 def _get_masking_roi(
     image_url: str,
     ref_label: str,
@@ -268,7 +272,7 @@ def _get_masking_roi(
     return masking_roi
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _get_image_array(
     image_url: str,
     ref_label: str,
@@ -309,7 +313,7 @@ def _get_image_array(
     return image_array
 
 
-@st.cache_data
+@st_cache_data_wrapper
 def _get_label_array(
     image_url: str,
     ref_label: str,