feat(skore): Add Project.delete function (#1778)

Closes #1734 .

> [!CAUTION]
> #1777 must be merged before
> #1775 must be merged before

Author: thomass-dev

skore/src/skore/project/project.py

@@ -50,14 +50,15 @@ class Project(DirNamesMixin):
     Otherwise, the project is configured to the ``local`` mode to be persisted on
     the user machine in a directory called ``workspace``.
 
-    The workspace can be shared between all the projects.
-    The workspace can be set using kwargs or the envar ``SKORE_WORKSPACE``.
-    If not, it will be by default set to a ``skore/`` directory in the USER
-    cache directory:
+    | The workspace can be shared between all the projects.
+    | The workspace can be set using kwargs or the environment variable
+      ``SKORE_WORKSPACE``.
+    | If not, it will be by default set to a ``skore/`` directory in the USER
+      cache directory:
 
-    - in Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
-    - in Linux, usually ``${HOME}/.cache/skore``,
-    - in macOS, usually ``${HOME}/Library/Caches/skore``.
+    - on Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
+    - on Linux, usually ``${HOME}/.cache/skore``,
+    - on macOS, usually ``${HOME}/Library/Caches/skore``.
 
     Refer to the :ref:`project` section of the user guide for more details.
 
@@ -76,14 +77,15 @@ class Project(DirNamesMixin):
         workspace : Path, mode:local only.
             The directory where the local project is persisted.
 
-            The workspace can be shared between all the projects.
-            The workspace can be set using kwargs or the envar ``SKORE_WORKSPACE``.
-            If not, it will be by default set to a ``skore/`` directory in the USER
-            cache directory:
+            | The workspace can be shared between all the projects.
+            | The workspace can be set using kwargs or the environment variable
+              ``SKORE_WORKSPACE``.
+            | If not, it will be by default set to a ``skore/`` directory in the USER
+              cache directory:
 
-            - in Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
-            - in Linux, usually ``${HOME}/.cache/skore``,
-            - in macOS, usually ``${HOME}/Library/Caches/skore``.
+            - on Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
+            - on Linux, usually ``${HOME}/.cache/skore``,
+            - on macOS, usually ``${HOME}/Library/Caches/skore``.
 
     Attributes
     ----------
@@ -149,32 +151,67 @@ class Project(DirNamesMixin):
     """
 
     __HUB_NAME_PATTERN = re.compile(r"hub://(?P<tenant>[^/]+)/(?P<name>.+)")
+
     reports: _ReportsAccessor
     _Project__project: Any
     _Project__mode: str
     _Project__name: str
 
-    def __init__(self, name: str, **kwargs):
+    @staticmethod
+    def __setup_plugin(name: str) -> tuple[str, str, Any, dict]:
         if not (PLUGINS := entry_points(group="skore.plugins.project")):
             raise SystemError("No project plugin found, please install at least one.")
 
-        if match := re.match(self.__HUB_NAME_PATTERN, name):
+        if match := re.match(Project.__HUB_NAME_PATTERN, name):
             mode = "hub"
             name = match["name"]
-            kwargs |= {"tenant": match["tenant"], "name": name}
+            parameters = {"tenant": match["tenant"], "name": name}
         else:
             mode = "local"
-            kwargs |= {"name": name}
+            parameters = {"name": name}
 
         if mode not in PLUGINS.names:
             raise ValueError(
                 f"Unknown mode `{mode}`. "
                 f"Please install the `skore-{mode}-project` python package."
             )
 
+        return mode, name, PLUGINS[mode].load(), parameters
+
+    def __init__(self, name: str, **kwargs):
+        r"""
+        Initialize a project.
+
+        Parameters
+        ----------
+        name : str
+            The name of the project:
+
+            - if the ``name`` takes the form of the URI ``hub://<tenant>/<name>``, the
+              project is configured to communicate with the ``skore hub``,
+            - otherwise, the project is configured to communicate with a local storage,
+              on the user machine.
+        **kwargs : dict
+            Extra keyword arguments passed to the project, depending on its mode.
+
+            workspace : Path, mode:local only.
+                The directory where the local project is persisted.
+
+                | The workspace can be shared between all the projects.
+                | The workspace can be set using kwargs or the environment variable
+                  ``SKORE_WORKSPACE``.
+                | If not, it will be by default set to a ``skore/`` directory in the
+                  USER cache directory:
+
+                - on Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
+                - on Linux, usually ``${HOME}/.cache/skore``,
+                - on macOS, usually ``${HOME}/Library/Caches/skore``.
+        """
+        mode, name, plugin, parameters = Project.__setup_plugin(name)
+
         self.__mode = mode
         self.__name = name
-        self.__project = PLUGINS[mode].load()(**kwargs)
+        self.__project = plugin(**(kwargs | parameters))
 
     @property
     def mode(self):
@@ -218,5 +255,39 @@ def put(self, key: str, report: EstimatorReport):
     def __repr__(self) -> str:  # noqa: D105
         return self.__project.__repr__()
 
+    @staticmethod
+    def delete(name: str, **kwargs):
+        r"""
+        Delete a project.
+
+        Parameters
+        ----------
+        name : str
+            The name of the project:
+
+            - if the ``name`` takes the form of the URI ``hub://<tenant>/<name>``, the
+              project is configured to communicate with the ``skore hub``,
+            - otherwise, the project is configured to communicate with a local storage,
+              on the user machine.
+        **kwargs : dict
+            Extra keyword arguments passed to the project, depending on its mode.
+
+            workspace : Path, mode:local only.
+                The directory where the local project is persisted.
+
+                | The workspace can be shared between all the projects.
+                | The workspace can be set using kwargs or the environment variable
+                  ``SKORE_WORKSPACE``.
+                | If not, it will be by default set to a ``skore/`` directory in the
+                  USER cache directory:
+
+                - on Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
+                - on Linux, usually ``${HOME}/.cache/skore``,
+                - on macOS, usually ``${HOME}/Library/Caches/skore``.
+        """
+        _, _, plugin, parameters = Project.__setup_plugin(name)
+
+        return plugin.delete(**(kwargs | parameters))
+
 
 _register_accessor("reports", Project)(_ReportsAccessor)

skore/tests/unit/project/test_project.py

@@ -15,71 +15,81 @@
     from importlib.metadata import EntryPoint, EntryPoints
 
 
-class FakeLocalProject(Mock):
-    def __init__(self, *args, **kwargs):
-        super().__init__(constructor_args=args, constructor_kwargs=kwargs)
-
-
-class FakeHubProject(Mock):
-    def __init__(self, *args, **kwargs):
-        super().__init__(constructor_args=args, constructor_kwargs=kwargs)
+class FakeEntryPoint(EntryPoint):
+    def load(self):
+        return self.value
+
+
+@fixture
+def FakeLocalProject():
+    return Mock()
+
+
+@fixture
+def FakeHubProject():
+    return Mock()
+
+
+@fixture(autouse=True)
+def monkeypatch_entrypoints(monkeypatch, request, FakeLocalProject, FakeHubProject):
+    monkeypatch.setattr(
+        "skore.project.project.entry_points",
+        lambda **kwargs: EntryPoints(
+            [
+                FakeEntryPoint(
+                    name="local",
+                    value=FakeLocalProject,
+                    group="skore.plugins.project",
+                ),
+                FakeEntryPoint(
+                    name="hub",
+                    value=FakeHubProject,
+                    group="skore.plugins.project",
+                ),
+            ]
+        ),
+    )
+
+
+@fixture(scope="module")
+def regression():
+    X, y = make_regression(random_state=42)
+    X_train, X_test, y_train, y_test = train_test_split(
+        X, y, test_size=0.2, random_state=42
+    )
+
+    return EstimatorReport(
+        LinearRegression(),
+        X_train=X_train,
+        y_train=y_train,
+        X_test=X_test,
+        y_test=y_test,
+    )
 
 
 class TestProject:
-    @fixture(autouse=True)
-    def monkeypatch_entrypoints(self, monkeypatch, request):
-        monkeypatch.setattr(
-            "skore.project.project.entry_points",
-            lambda **kwargs: EntryPoints(
-                [
-                    EntryPoint(
-                        name="local",
-                        value=f"{__name__}:FakeLocalProject",
-                        group="skore.plugins.project",
-                    ),
-                    EntryPoint(
-                        name="hub",
-                        value=f"{__name__}:FakeHubProject",
-                        group="skore.plugins.project",
-                    ),
-                ]
-            ),
-        )
-
-    @fixture(scope="class")
-    def regression(self):
-        X, y = make_regression(random_state=42)
-        X_train, X_test, y_train, y_test = train_test_split(
-            X, y, test_size=0.2, random_state=42
-        )
-
-        return EstimatorReport(
-            LinearRegression(),
-            X_train=X_train,
-            y_train=y_train,
-            X_test=X_test,
-            y_test=y_test,
-        )
-
-    def test_init_local(self):
-        project = Project("<name>")
+    def test_init_local(self, FakeLocalProject):
+        project = Project("<name>", workspace="<workspace>")
 
         assert isinstance(project, Project)
         assert project._Project__mode == "local"
         assert project._Project__name == "<name>"
-        assert isinstance(project._Project__project, FakeLocalProject)
-        assert not project._Project__project.constructor_args
-        assert project._Project__project.constructor_kwargs == {"name": "<name>"}
+        assert FakeLocalProject.called
+        assert not FakeLocalProject.call_args.args
+        assert FakeLocalProject.call_args.kwargs == {
+            "name": "<name>",
+            "workspace": "<workspace>",
+        }
 
-    def test_init_hub(self):
+    def test_init_hub(self, FakeHubProject):
         project = Project("hub://<tenant>/<name>")
 
         assert isinstance(project, Project)
         assert project._Project__mode == "hub"
         assert project._Project__name == "<name>"
-        assert isinstance(project._Project__project, FakeHubProject)
-        assert not project._Project__project.constructor_args
-        assert project._Project__project.constructor_kwargs == {
+        assert FakeHubProject.called
+        assert not FakeHubProject.call_args.args
+        assert FakeHubProject.call_args.kwargs == {
             "tenant": "<tenant>",
             "name": "<name>",
         }
@@ -125,12 +135,12 @@ def test_name(self):
         assert Project("<name>").name == "<name>"
         assert Project("hub://<tenant>/<name>").name == "<name>"
 
-    def test_put(self, regression):
+    def test_put(self, regression, FakeLocalProject):
         project = Project("<name>")
 
         project.put("<key>", regression)
 
-        assert isinstance(project._Project__project, FakeLocalProject)
+        assert FakeLocalProject.called
         assert project._Project__project.put.called
         assert not project._Project__project.put.call_args.args
         assert project._Project__project.put.call_args.kwargs == {
@@ -152,12 +162,12 @@ def test_reports(self):
         assert hasattr(project.reports, "get")
         assert hasattr(project.reports, "metadata")
 
-    def test_reports_get(self):
+    def test_reports_get(self, FakeLocalProject):
         project = Project("<name>")
 
         project.reports.get("<id>")
 
-        assert isinstance(project._Project__project, FakeLocalProject)
+        assert FakeLocalProject.called
         assert project._Project__project.reports.get.called
         assert project._Project__project.reports.get.call_args.args == ("<id>",)
         assert not project._Project__project.reports.get.call_args.kwargs
@@ -195,3 +205,25 @@ def test_reports_metadata(self):
     def test_repr(self):
         project = Project("<name>")
         assert repr(project) == repr(project._Project__project)
+
+    def test_delete_local(self, FakeLocalProject):
+        Project.delete("<name>", workspace="<workspace>")
+
+        assert not FakeLocalProject.called
+        assert FakeLocalProject.delete.called
+        assert not FakeLocalProject.delete.call_args.args
+        assert FakeLocalProject.delete.call_args.kwargs == {
+            "name": "<name>",
+            "workspace": "<workspace>",
+        }
+
+    def test_delete_hub(self, FakeHubProject):
+        Project.delete("hub://<tenant>/<name>")
+
+        assert not FakeHubProject.called
+        assert FakeHubProject.delete.called
+        assert not FakeHubProject.delete.call_args.args
+        assert FakeHubProject.delete.call_args.kwargs == {
+            "tenant": "<tenant>",
+            "name": "<name>",
+        }