feat: add comment metadata api endpoint

src/kiara/defaults.py

@@ -9,6 +9,7 @@
 import typing
 import uuid
 from enum import Enum
+from pathlib import Path
 
 from appdirs import AppDirs
 
@@ -139,6 +140,9 @@
 VALUE_ATTR_DELIMITER = "::"
 VALID_VALUE_QUERY_CATEGORIES = ["data", "properties"]
 
+CHUNK_CACHE_BASE_DIR = Path(kiara_app_dirs.user_cache_dir) / "data" / "chunks"
+CHUNK_CACHE_DIR_DEPTH = 2
+CHUNK_CACHE_DIR_WIDTH = 1
 
 class SpecialValue(Enum):
 

src/kiara/interfaces/python_api/__init__.py

@@ -3117,6 +3117,29 @@ def get_job_record(self, job_id: Union[str, uuid.UUID]) -> Union["JobRecord", No
         job_record = self.context.job_registry.get_job_record(job_id=job_id)
         return job_record
 
+    def set_job_comment(self, job_id: Union[str, uuid.UUID], comment: str, force: bool = True):
+        """Set a comment for the specified job.
+
+        Arguments:
+            job_id: the job id
+            comment: the comment to set
+            force: whether to overwrite an existing comment
+        """
+
+        from kiara.models.metadata import CommentMetadata
+
+        if isinstance(job_id, str):
+            job_id = uuid.UUID(job_id)
+
+        metadata = CommentMetadata(comment=comment)
+        items = {
+            "comment": comment
+        }
+
+        self.context.metadata_registry.register_job_metadata_items(
+            job_id=job_id, items=items, force=force
+        )
+
     def get_job_comment(self, job_id: Union[str, uuid.UUID]) -> Union[str, None]:
         """Retrieve the comment for the specified job.
 

src/kiara/registries/data/data_store/sqlite_store.py

@@ -21,7 +21,7 @@
 from sqlalchemy import text
 from sqlalchemy.engine import Connection, Engine
 
-from kiara.defaults import CHUNK_COMPRESSION_TYPE, kiara_app_dirs
+from kiara.defaults import CHUNK_COMPRESSION_TYPE, kiara_app_dirs, CHUNK_CACHE_BASE_DIR, CHUNK_CACHE_DIR_DEPTH, CHUNK_CACHE_DIR_WIDTH
 from kiara.models.values.value import PersistedData, Value
 from kiara.registries import (
     ARCHIVE_CONFIG_CLS,
@@ -94,10 +94,11 @@ def __init__(
         )
         self._db_path: Union[Path, None] = None
         self._cached_engine: Union[Engine, None] = None
-        self._data_cache_dir = Path(kiara_app_dirs.user_cache_dir) / "data" / "chunks"
+        self._data_cache_dir = CHUNK_CACHE_BASE_DIR
         self._data_cache_dir.mkdir(parents=True, exist_ok=True, mode=0o700)
-        self._cache_dir_depth = 2
-        self._cache_dir_width = 1
+
+        self._cache_dir_depth = CHUNK_CACHE_DIR_DEPTH
+        self._cache_dir_width = CHUNK_CACHE_DIR_WIDTH
         self._value_id_cache: Union[Iterable[uuid.UUID], None] = None
         self._use_wal_mode: bool = archive_config.use_wal_mode
         # self._lock: bool = True

src/kiara/registries/metadata/__init__.py

@@ -192,6 +192,7 @@ def register_job_metadata_items(
         job_id: uuid.UUID,
         items: Mapping[str, Any],
         store: Union[str, uuid.UUID, None] = None,
+        force: bool = False,
     ) -> None:
 
         for key, value in items.items():
@@ -205,6 +206,7 @@ def register_job_metadata_items(
                 reference_item_type="job",
                 reference_item_id=str(job_id),
                 store=store,
+                force=force,
             )
 
     def retrieve_job_metadata_items(self, job_id: uuid.UUID):