experimaestro 1.8.0rc2__tar.gz → 1.8.0rc4__tar.gz

{experimaestro-1.8.0rc2 → experimaestro-1.8.0rc4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: experimaestro
-Version: 1.8.0rc2
+Version: 1.8.0rc4
 Summary: "Experimaestro is a computer science experiment manager"
 License: GPL-3
 Keywords: experiment manager

{experimaestro-1.8.0rc2 → experimaestro-1.8.0rc4}/pyproject.toml

@@ -20,7 +20,7 @@ include = [
     "src/experimaestro/mkdocs/style.css",
     { path="src/experimaestro/server/data/*", format=['sdist', 'wheel']}
 ]
-version = "1.8.0-rc2"
+version = "1.8.0-rc4"
 repository = "https://github.com/experimaestro/experimaestro-python"
 documentation = "https://experimaestro-python.readthedocs.io/"
 
@@ -117,12 +117,12 @@ max-line-length = "88"
 extend-ignore = "E203"
 
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.10"
 warn_unused_ignores = true
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "1.8.0rc2"
+version = "1.8.0rc4"
 changelog_start_rev = "v1.0.0"
 tag_format = "v$major.$minor.$patch$prerelease"
 # update_changelog_on_bump = true

{experimaestro-1.8.0rc2 → experimaestro-1.8.0rc4}/src/experimaestro/__init__.py

@@ -27,7 +27,15 @@ from .annotations import (
     # Method
     config_only,
 )
-from .core.serialization import load, save, state_dict, from_state_dict, from_task_dir
+from .core.serialization import (
+    load,
+    save,
+    state_dict,
+    from_state_dict,
+    from_task_dir,
+    serialize,
+    deserialize,
+)
 from .core.arguments import (
     # Types
     Param,

experimaestro-1.8.0rc4/src/experimaestro/core/callbacks.py

@@ -0,0 +1,52 @@
+from collections import defaultdict
+import threading
+from typing import Callable, ClassVar, Optional
+from experimaestro.core.objects import ConfigInformation
+from experimaestro.scheduler import Listener, Job, JobState, experiment
+
+
+class TaskEventListener(Listener):
+    INSTANCE: ClassVar[Optional["TaskEventListener"]] = None
+    """The general instance"""
+
+    def __init__(self):
+        self.lock = threading.Lock()
+        self.experiments: set[int] = set()
+
+        self._on_completed: defaultdict[int, Callable] = defaultdict(list)
+
+    @staticmethod
+    def connect(xp: experiment):
+        _self = TaskEventListener.instance()
+        with _self.lock:
+            if id(xp) not in _self.experiments:
+                _self.experiments.add(id(xp))
+                xp.scheduler.addlistener(_self)
+
+    @staticmethod
+    def instance():
+        if TaskEventListener.INSTANCE is None:
+            TaskEventListener.INSTANCE = TaskEventListener()
+
+        return TaskEventListener.INSTANCE
+
+    def job_state(self, job: Job):
+        if job.state == JobState.DONE:
+            with self.lock:
+                for callback in self._on_completed.get(id(job.config.__xpm__), []):
+                    callback()
+
+    @staticmethod
+    def on_completed(
+        config_information: ConfigInformation, callback: Callable[[], None]
+    ):
+        instance = TaskEventListener.instance()
+
+        with instance.lock:
+            instance._on_completed[id(config_information)].append(callback)
+
+            if (
+                config_information.job is not None
+                and config_information.job == JobState.DONE
+            ):
+                callback()

{experimaestro-1.8.0rc2 → experimaestro-1.8.0rc4}/src/experimaestro/core/objects.py

@@ -47,6 +47,7 @@ from experimaestro.core.types import DeprecatedAttribute, ObjectType
 from .context import SerializationContext, SerializedPath, SerializedPathLoader
 
 if TYPE_CHECKING:
+    from .callbacks import TaskEventListener
     from experimaestro.scheduler.base import Job
     from experimaestro.scheduler.workspace import RunMode
     from experimaestro.launchers import Launcher
@@ -607,6 +608,7 @@ class ConfigInformation:
 
         # State information
         self.job = None
+        self._job_listener: "TaskEventListener" | None = None
 
         #: True when this configuration was loaded from disk
         self.loaded = False
@@ -947,6 +949,15 @@ class ConfigInformation:
         if self.job:
             self.job.watch_output(watched)
 
+    def on_completed(self, callback: Callable[[], None]):
+        """Call a method when the task is completed successfully
+
+        :param callback: _description_
+        """
+        from .callbacks import TaskEventListener
+
+        TaskEventListener.on_completed(self, callback)
+
     def submit(
         self,
         workspace: "Workspace",
@@ -957,6 +968,7 @@ class ConfigInformation:
     ):
         from experimaestro.scheduler import experiment, JobContext
         from experimaestro.scheduler.workspace import RunMode
+        from .callbacks import TaskEventListener
 
         # --- Prepare the object
 
@@ -1009,6 +1021,7 @@ class ConfigInformation:
             workspace.run_mode if run_mode is None else run_mode
         ) or RunMode.NORMAL
         if run_mode == RunMode.NORMAL:
+            TaskEventListener.connect(experiment.CURRENT)
             other = experiment.CURRENT.submit(self.job)
             if other:
                 # Just returns the other task
@@ -2015,6 +2028,9 @@ class Task(LightweightTask):
         """
         self.__xpm__.watch_output(method, callback)
 
+    def on_completed(self, callback: Callable[[], None]):
+        self.__xpm__.on_completed(callback)
+
 
 # --- Utility functions
 

{experimaestro-1.8.0rc2 → experimaestro-1.8.0rc4}/src/experimaestro/core/serialization.py

@@ -36,7 +36,7 @@ def state_dict(context: SerializationContext, obj: Any):
     :param context: The serialization context
     :param obj: the object to serialize
     """
-    objects = []
+    objects: list[Any] = []
     data = json_object(context, obj, objects)
     return {"objects": objects, "data": data}
 
@@ -50,11 +50,17 @@ def save_definition(obj: Any, context: SerializationContext, path: Path):
 def save(obj: Any, save_directory: Optional[Path]):
     """Saves an object into a disk file
 
+    The serialization process also stores in the given folder the different
+    files or folders that are registered as Path parameters (or
+    meta-parameters).
+
     :param save_directory: The directory in which the object and its data will
         be saved (by default, the object is saved in "definition.json")
     """
     context = SerializationContext(save_directory=save_directory)
-    save_definition(obj, context, save_directory / "definition.json")
+    save_definition(
+        obj, context, save_directory / "definition.json" if save_directory else None
+    )
 
 
 def get_data_loader(path: Union[str, Path, SerializedPathLoader]):
@@ -129,3 +135,47 @@ def from_task_dir(
     content["data"] = {"type": "python", "value": content["objects"][-1]["id"]}
 
     return from_state_dict(content, as_instance=as_instance)
+
+
+def serialize(
+    obj: Any, save_directory: Path, *, init_tasks: list["LightweightTask"] = []
+):
+    """Saves an object into a disk file, including initialization tasks
+
+    The serialization process also stores in the given folder the different
+    files or folders that are registered as Path parameters (or
+    meta-parameters).
+
+    :param save_directory: The directory in which the object and its data will
+        be saved (by default, the object is saved in "definition.json")
+    :param init_tasks: The optional
+    """
+    context = SerializationContext(save_directory=save_directory)
+    save_definition((obj, init_tasks), context, save_directory / "definition.json")
+
+
+def deserialize(
+    path: Union[str, Path, SerializedPathLoader],
+    as_instance: bool = False,
+) -> tuple[Any, List["LightweightTask"]] | Any:
+    """Load data from disk, and initialize the object
+
+    :param path: A directory or a function that transforms relative file path
+        into absolute ones
+    :param as_instance: returns instances instead of configuration objects
+    :returns: either the object (as_instance is true), or a tuple
+    """
+    data_loader = get_data_loader(path)
+
+    with data_loader("definition.json").open("rt") as fh:
+        content = json.load(fh)
+
+    object, init_tasks = from_state_dict(content, as_instance=as_instance)
+
+    if as_instance:
+        for init_task in init_tasks:
+            init_task.execute()
+
+        return object
+
+    return object, init_tasks

{experimaestro-1.8.0rc2 → experimaestro-1.8.0rc4}/src/experimaestro/scheduler/base.py

@@ -819,6 +819,7 @@ class experiment:
         """
 
         from experimaestro.server import Server
+        from experimaestro.scheduler import Listener
 
         settings = get_settings()
         if not isinstance(env, WorkspaceSettings):
@@ -835,6 +836,7 @@ class experiment:
         self.xplock = None
         self.old_experiment = None
         self.services: Dict[str, Service] = {}
+        self._job_listener: Optional[Listener] = None
 
         # Get configuration settings
 

{experimaestro-1.8.0rc2 → experimaestro-1.8.0rc4}/src/experimaestro/tests/test_experiment.py

@@ -48,3 +48,26 @@ def test_experiment_history():
         (task_b_info,) = xp.get_jobs(TaskB)
         assert task_b_info.tags == {"x": 1}
         assert task_b_info.depends_on == [task_a_info]
+
+
+class FlagHandler:
+    def __init__(self):
+        self.flag = False
+
+    def set(self):
+        self.flag = True
+
+    def is_set(self):
+        return self.flag
+
+
+def test_experiment_events():
+    """Test handlers"""
+
+    flag = FlagHandler()
+    with TemporaryExperiment("experiment"):
+        task_a = TaskA()
+        task_a.submit()
+        task_a.on_completed(flag.set)
+
+    assert flag.is_set()