Factorize deletion test

Author: thomass-dev

skore-local-project/src/skore_local_project/project.py

@@ -4,6 +4,7 @@
 
 import io
 import os
+from functools import wraps
 from pathlib import Path
 from types import SimpleNamespace
 from typing import TYPE_CHECKING
@@ -40,6 +41,21 @@ class Metadata(TypedDict):  # noqa: D101
         predict_time_mean: float | None
 
 
+def ensure_project_is_not_deleted(method):
+    """Ensure project is not deleted, before executing any other operation."""
+
+    @wraps(method)
+    def wrapper(self, *args, **kwargs):
+        if self.name not in self._Project__projects_storage:
+            raise RuntimeError(
+                f"Skore could not proceed because {repr(self)} does not exist anymore."
+            )
+
+        return method(self, *args, **kwargs)
+
+    return wrapper
+
+
 class Project:
     r"""
     API to manage a collection of key-report pairs persisted in a local storage.
@@ -173,6 +189,7 @@ def pickle(report: EstimatorReport | CrossValidationReport) -> tuple[str, bytes]
 
         return pickle_hash, pickle_bytes
 
+    @ensure_project_is_not_deleted
     def put(self, key: str, report: EstimatorReport | CrossValidationReport):
         """
         Put a key-report pair to the local project.
@@ -207,12 +224,6 @@ def put(self, key: str, report: EstimatorReport | CrossValidationReport):
                 f"ort` (found '{type(report)}')"
             )
 
-        if self.name not in self.__projects_storage:
-            raise RuntimeError(
-                f"Bad condition: {repr(self)} does not exist anymore, "
-                f"it had to be removed."
-            )
-
         pickle_hash, pickle_bytes = Project.pickle(report)
 
         if pickle_hash not in self.__artifacts_storage:
@@ -228,6 +239,7 @@ def put(self, key: str, report: EstimatorReport | CrossValidationReport):
             )
         )
 
+    @ensure_project_is_not_deleted
     def get(self, id: str) -> EstimatorReport:
         """Get a persisted report by its id."""
         if id in self.__artifacts_storage:
@@ -236,14 +248,9 @@ def get(self, id: str) -> EstimatorReport:
 
         raise KeyError(id)
 
+    @ensure_project_is_not_deleted
     def summarize(self) -> list[Metadata]:
         """Obtain metadata/metrics for all persisted reports in insertion order."""
-        if self.name not in self.__projects_storage:
-            raise RuntimeError(
-                f"Bad condition: {repr(self)} does not exist anymore, "
-                f"it had to be removed."
-            )
-
         return [
             {
                 "id": value["artifact_id"],
@@ -272,11 +279,6 @@ def summarize(self) -> list[Metadata]:
     @property
     def reports(self):
         """Accessor for interaction with the persisted reports."""
-        if self.name not in self.__projects_storage:
-            raise RuntimeError(
-                f"Bad condition: {repr(self)} does not exist anymore, "
-                f"it had to be removed."
-            )
 
         def get(id: str) -> EstimatorReport:
             """

skore-local-project/tests/unit/test_project.py

@@ -192,8 +192,9 @@ def test_put_exception(self, tmp_path, regression):
         with raises(
             RuntimeError,
             match=re.escape(
-                f"Bad condition: {repr(project)} does not exist anymore, "
-                f"it had to be removed.",
+                f"Skore could not proceed because "
+                f"Project(mode='local', name='<project>', workspace='{tmp_path}') "
+                f"does not exist anymore."
             ),
         ):
             project.put("<key>", regression)
@@ -287,21 +288,6 @@ def test_reports(self, tmp_path):
         assert hasattr(project.reports, "get")
         assert hasattr(project.reports, "metadata")
 
-    def test_reports_exception(self, tmp_path):
-        import re
-
-        project = Project("<project>", workspace=tmp_path)
-        Project.delete("<project>", workspace=tmp_path)
-
-        with raises(
-            RuntimeError,
-            match=re.escape(
-                f"Bad condition: {repr(project)} does not exist anymore, "
-                f"it had to be removed.",
-            ),
-        ):
-            project.reports  # noqa: B018
-
     def test_reports_get(self, tmp_path, regression):
         project = Project("<project>", workspace=tmp_path)
         project.put("<key>", regression)
@@ -315,6 +301,22 @@ def test_reports_get(self, tmp_path, regression):
         assert report.estimator_name_ == regression.estimator_name_
         assert report._ml_task == regression._ml_task
 
+    def test_reports_get_exception(self, tmp_path, regression):
+        import re
+
+        project = Project("<project>", workspace=tmp_path)
+        Project.delete("<project>", workspace=tmp_path)
+
+        with raises(
+            RuntimeError,
+            match=re.escape(
+                f"Skore could not proceed because "
+                f"Project(mode='local', name='<project>', workspace='{tmp_path}') "
+                f"does not exist anymore."
+            ),
+        ):
+            project.reports.get(None)
+
     def test_reports_metadata(self, tmp_path, Datetime, regression, cv_regression):
         project = Project("<project>", workspace=tmp_path)
 
@@ -389,6 +391,22 @@ def test_reports_metadata(self, tmp_path, Datetime, regression, cv_regression):
             },
         ]
 
+    def test_reports_metadata_exception(self, tmp_path, regression):
+        import re
+
+        project = Project("<project>", workspace=tmp_path)
+        Project.delete("<project>", workspace=tmp_path)
+
+        with raises(
+            RuntimeError,
+            match=re.escape(
+                f"Skore could not proceed because "
+                f"Project(mode='local', name='<project>', workspace='{tmp_path}') "
+                f"does not exist anymore."
+            ),
+        ):
+            project.reports.metadata()
+
     def test_delete(self, tmp_path, binary_classification, regression):
         project1 = Project("<project1>", workspace=tmp_path)
         project1.put("<project1-key1>", binary_classification)