experimaestro 1.5.3__tar.gz → 1.5.5__tar.gz

{experimaestro-1.5.3 → experimaestro-1.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: experimaestro
-Version: 1.5.3
+Version: 1.5.5
 Summary: "Experimaestro is a computer science experiment manager"
 Home-page: https://github.com/experimaestro/experimaestro-python
 License: GPL-3
@@ -41,7 +41,7 @@ Requires-Dist: pyparsing (>=3.1,<4.0)
 Requires-Dist: pytools (>=2023.1.1,<2024.0.0)
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
 Requires-Dist: requests (>=2.31,<3.0)
-Requires-Dist: rpyc (>=5,<6)
+Requires-Dist: rpyc (>=5,<7)
 Requires-Dist: sortedcontainers (>=2.4,<3.0)
 Requires-Dist: termcolor (>=2.3)
 Requires-Dist: tqdm (>=4.66.1,<5.0.0)

{experimaestro-1.5.3 → experimaestro-1.5.5}/pyproject.toml

@@ -19,7 +19,7 @@ include = [
     "src/experimaestro/sphinx/static/experimaestro.css",
     "src/experimaestro/mkdocs/style.css"
 ]
-version = "1.5.3"
+version = "1.5.5"
 repository = "https://github.com/experimaestro/experimaestro-python"
 documentation = "https://experimaestro-python.readthedocs.io/"
 
@@ -61,7 +61,7 @@ watchdog = "^2"
 marshmallow = "^3.20"
 fabric = "^3"
 decorator = "^5"
-rpyc = "^5"
+rpyc = ">=5,<7"
 
 [tool.poetry.group.ssh]
 optional = true
@@ -123,7 +123,7 @@ warn_unused_ignores = true
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "1.5.3"
+version = "1.5.5"
 changelog_start_rev = "0.15.0"
 tag_format = "v$version"
 update_changelog_on_bump = true

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/__init__.py

@@ -53,7 +53,6 @@ from .core.context import SerializationContext
 from .core.serializers import SerializationLWTask, PathSerializationLWTask
 from .core.types import Any, SubmitHook
 from .launchers import Launcher
-from .scheduler.environment import Environment
 from .scheduler.workspace import Workspace, RunMode
 from .scheduler import Scheduler, experiment, FailedExperiment
 from .notifications import progress, tqdm

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/click.py

@@ -1,6 +1,4 @@
 import click
-from experimaestro import Environment
-from experimaestro.run import parse_commandline
 
 """Defines the task command line argument prefix for experimaestro-handled command lines"""
 
@@ -45,36 +43,3 @@ class forwardoption(metaclass=forwardoptionMetaclass):
     def __getattr__(self, key):
         """Access to a class field"""
         return forwardoption([key])
-
-
-def environment(name: str):
-    def annotate(f):
-        def callback_env(ctx, name, value):
-            if value:
-                assert name not in ctx.params, "Environment has already been set"
-            else:
-                return ctx.params.get(name, None)
-            return Environment.get(value)
-
-        def callback(ctx, param, value):
-            if value:
-                if name not in ctx.params:
-                    ctx.params[name] = Environment()
-                ctx.params[name].workdir = value
-
-        f = click.option(
-            f"--{name}-workdir",
-            type=str,
-            callback=callback,
-            expose_value=False,
-            help="Experimaestro environment",
-        )(f)
-        f = click.option(
-            f"--{name}",
-            type=str,
-            callback=callback_env,
-            help="Experimaestro environment",
-        )(f)
-        return f
-
-    return annotate

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/experiments/cli.py

@@ -1,5 +1,4 @@
 import inspect
-import itertools
 import json
 import logging
 import sys
@@ -12,7 +11,7 @@ import yaml
 from experimaestro import LauncherRegistry, RunMode, experiment
 from experimaestro.experiments.configuration import ConfigurationBase
 from experimaestro.exceptions import HandledException
-from experimaestro.settings import get_settings, get_workspace
+from experimaestro.settings import get_workspace
 from omegaconf import OmegaConf, SCMode
 from termcolor import cprint
 
@@ -105,11 +104,17 @@ def load(yaml_file: Path):
 @click.option(
     "--file", "xp_file", help="The file containing the main experimental code"
 )
+@click.option(
+    "--workspace",
+    type=str,
+    default=None,
+    help="Workspace ID (reads from settings.yaml in experimaestro config)",
+)
 @click.option(
     "--workdir",
     type=str,
     default=None,
-    help="Working directory - if None, uses the default XPM " "working directory",
+    help="Working environment",
 )
 @click.option("--conf", "-c", "extra_conf", type=str, multiple=True)
 @click.option(
@@ -128,6 +133,7 @@ def experiments_cli(  # noqa: C901
     port: int,
     xpm_config_dir: Path,
     workdir: Optional[Path],
+    workspace: Optional[str],
     env: List[Tuple[str, str]],
     run_mode: RunMode,
     extra_conf: List[str],
@@ -224,26 +230,38 @@ def experiments_cli(  # noqa: C901
         configuration, structured_config_mode=SCMode.INSTANTIATE
     )
 
-    # Get the working directory
-    settings = get_settings()
-    ws_env = {}
+    # Define the workspace
     workdir = Path(workdir) if workdir else None
-    if (workdir is None) or (not workdir.is_dir()):
-        logging.info("Searching for workspace %s", workdir)
-        ws_settings = get_workspace(str(workdir))
-        workdir = ws_settings.path.expanduser()
-        ws_env = ws_settings.env
+
+    if workspace:
+        ws_env = get_workspace(workspace)
+        if ws_env is None:
+            raise RuntimeError("No workspace named %s", workspace)
+
+        logging.info("Using workspace %s", ws_env.id)
+        if workdir:
+            # Overrides working directory
+            logging.info(" override working directory: %s", workdir)
+            ws_env.path = workdir
+        else:
+            workdir = ws_env.path
+    elif workdir:
+        logging.info("Using workdir %s", workdir)
+        ws_env = workdir
+    else:
+        ws_env = get_workspace()
+        assert ws_env is not None, "No workdir or workspace defined, and no default"
+        logging.info("Using default workspace %s", ws_env.id)
 
     logging.info("Using working directory %s", str(workdir.resolve()))
 
     # --- Runs the experiment
     with experiment(
-        workdir, configuration.id, host=host, port=port, run_mode=run_mode
+        ws_env, configuration.id, host=host, port=port, run_mode=run_mode
     ) as xp:
         # Set up the environment
         # (1) global settings (2) workspace settings and (3) command line settings
-        for key, value in itertools.chain(settings.env.items(), ws_env.items(), env):
-            logging.info("Setting environment: %s=%s", key, value)
+        for key, value in env:
             xp.setenv(key, value)
 
         try:

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/run.py

@@ -92,16 +92,26 @@ class TaskRunner:
             logger.info("Finished cleanup")
 
     def handle_error(self, code, frame_type):
-        logger.info("Finished with code %d", code)
+        logger.info("Error handler: finished with code %d", code)
         self.failedpath.write_text(str(code))
         self.cleanup()
         logger.info("Exiting")
-        os._exit(1)
+        sys.exit(1)
 
     def run(self):
         atexit.register(self.cleanup)
-        signal.signal(signal.SIGTERM, self.handle_error)
-        signal.signal(signal.SIGINT, self.handle_error)
+        sigterm_handler = signal.signal(signal.SIGTERM, self.handle_error)
+        sigint_handler = signal.signal(signal.SIGINT, self.handle_error)
+
+        def remove_signal_handlers(remove_cleanup=True):
+            """Removes cleanup in forked processes"""
+            signal.signal(signal.SIGTERM, sigterm_handler)
+            signal.signal(signal.SIGINT, sigint_handler)
+            atexit.unregister(self.cleanup)
+
+        if sys.platform != "win32":
+            os.register_at_fork(after_in_child=remove_signal_handlers)
+
         try:
             workdir = self.scriptpath.parent
             os.chdir(workdir)
@@ -129,14 +139,23 @@ class TaskRunner:
                 self.started = True
                 run(workdir / "params.json")
 
+                # ... remove the handlers
+                logger.info("Task ended successfully")
+                remove_signal_handlers(remove_cleanup=False)
+
                 # Everything went OK
-                os._exit(0)
+                sys.exit(0)
         except Exception:
             logger.exception("Got exception while running")
             self.handle_error(1, None)
 
         except SystemExit as e:
             if e.code == 0:
+                # Normal exit, just create the ".done" file
                 self.donepath.touch()
+
+                # ... and finish the exit process
+                logger.info("This is the end (TODO: remove this line)")
+                raise
             else:
                 self.handle_error(e.code, None)

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/scheduler/base.py

@@ -1,5 +1,6 @@
 from collections import ChainMap
 from functools import cached_property
+import logging
 import os
 from pathlib import Path
 from shutil import rmtree
@@ -13,13 +14,12 @@ from experimaestro.exceptions import HandledException
 from experimaestro.notifications import LevelInformation, Reporter
 from typing import Dict
 from experimaestro.scheduler.services import Service
-from experimaestro.settings import get_settings
+from experimaestro.settings import WorkspaceSettings, get_settings
 
 
 from experimaestro.core.objects import Config, ConfigWalkContext
 from experimaestro.utils import logger
 from experimaestro.locking import Locks, LockError, Lock
-from .environment import Environment
 from .workspace import RunMode, Workspace
 from .dependencies import Dependency, DependencyStatus, Resource
 import concurrent.futures
@@ -180,7 +180,7 @@ class Job(Resource):
         return ChainMap(
             {},
             self.launcher.environ if self.launcher else {},
-            self.workspace.environment.environ if self.workspace else {},
+            self.workspace.env if self.workspace else {},
         )
 
     @property
@@ -508,6 +508,12 @@ class Scheduler:
         job.scheduler = self
         self.waitingjobs.add(job)
 
+        # Check that we don't have a completed job in
+        # alternate directories
+        for jobspath in experiment.current().alt_jobspaths:
+            # FIXME: check if done
+            pass
+
         # Creates a link into the experiment folder
         path = experiment.current().jobspath / job.relpath
         path.parent.mkdir(parents=True, exist_ok=True)
@@ -719,7 +725,7 @@ class experiment:
     ```
     """
 
-    # Current experiment
+    #: Current experiment
     CURRENT: Optional["experiment"] = None
 
     @staticmethod
@@ -733,7 +739,7 @@ class experiment:
 
     def __init__(
         self,
-        env: Union[Path, str, Environment],
+        env: Union[Path, str, WorkspaceSettings],
         name: str,
         *,
         host: Optional[str] = None,
@@ -761,16 +767,13 @@ class experiment:
 
         from experimaestro.server import Server
 
-        if isinstance(env, Environment):
-            self.environment = env
-        else:
-            self.environment = Environment(workdir=env)
+        settings = get_settings()
+        if not isinstance(env, WorkspaceSettings):
+            env = WorkspaceSettings(id=None, path=Path(env))
 
         # Creates the workspace
         run_mode = run_mode or RunMode.NORMAL
-        self.workspace = Workspace(
-            self.environment, launcher=launcher, run_mode=run_mode
-        )
+        self.workspace = Workspace(settings, env, launcher=launcher, run_mode=run_mode)
 
         # Mark the directory has an experimaestro folder
         self.workdir = self.workspace.experimentspath / name
@@ -780,7 +783,7 @@ class experiment:
         self.old_experiment = None
         self.services: Dict[str, Service] = {}
 
-        settings = get_settings()
+        # Get configuration settings
 
         if host is not None:
             settings.server.host = host
@@ -800,6 +803,11 @@ class experiment:
             else None
         )
 
+        # Copy environment variable from main (but do not
+        # override)
+        for key, value in settings.env.items():
+            self.environment.setenv(key, value, override=False)
+
         if os.environ.get("XPM_ENABLEFAULTHANDLER", "0") == "1":
             import faulthandler
 
@@ -832,6 +840,12 @@ class experiment:
         """Return the directory in which results can be stored for this experiment"""
         return self.workdir / "jobs"
 
+    @property
+    def alt_jobspaths(self):
+        """Return potential other directories"""
+        for alt_workdir in self.workspace.alt_workdirs:
+            yield alt_workdir / "jobs"
+
     @property
     def jobsbakpath(self):
         """Return the directory in which results can be stored for this experiment"""
@@ -876,9 +890,11 @@ class experiment:
         future = asyncio.run_coroutine_threadsafe(awaitcompletion(), self.loop)
         return future.result()
 
-    def setenv(self, name, value):
+    def setenv(self, name, value, override=True):
         """Shortcut to set the environment value"""
-        self.environment.setenv(name, value)
+        if override or name not in self.workspace.env:
+            logging.info("Setting environment: %s=%s", name, value)
+            self.worskpace.env[name] = value
 
     def token(self, name: str, count: int):
         """Returns a token for this experiment

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/scheduler/workspace.py

@@ -1,9 +1,9 @@
+from collections import ChainMap
 from enum import Enum
+from functools import cached_property
 from pathlib import Path
-from typing import Optional, TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from experimaestro.scheduler.environment import Environment
+from typing import Optional
+from experimaestro.settings import WorkspaceSettings, Settings
 
 
 class RunMode(str, Enum):
@@ -25,15 +25,22 @@ class Workspace:
     """
 
     CURRENT = None
-    environment: "Environment"
+    settings: "Settings"
+    worspace: "WorkspaceSettings"
 
     """Creates a workspace for experiments"""
 
     def __init__(
-        self, environment: "Environment", launcher=None, run_mode: RunMode = None
+        self,
+        settings: "Settings",
+        workspace_settings: "WorkspaceSettings",
+        launcher=None,
+        run_mode: RunMode = None,
     ):
-        self.environment = environment
-        path = environment.workdir
+        self.settings = settings
+        self.workspace_settings = workspace_settings
+
+        path = self.workspace_settings.path
         self.notificationURL: Optional[str] = None
         if isinstance(path, Path):
             path = path.absolute()
@@ -43,6 +50,8 @@ class Workspace:
 
         self.launcher = launcher or Launcher.get(path)
 
+        self.env = ChainMap({}, workspace_settings.env, settings.env)
+
     def __enter__(self):
         self.old_workspace = Workspace.CURRENT
         Workspace.CURRENT = self
@@ -50,6 +59,15 @@ class Workspace:
     def __exit__(self, *args):
         Workspace.CURRENT = self.old_workspace
 
+    @cached_property
+    def alt_workspaces(self):
+        for ws_id in self.workspace_settings.alt_workspaces:
+            yield self.settings.workspaces[ws_id]
+
+    @property
+    def alt_workdirs(self):
+        yield from map(lambda ws: ws.path, self.workspace_settings.alt_workspaces)
+
     @property
     def connector(self):
         """Returns the default connector"""

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/scriptbuilder.py

@@ -92,7 +92,11 @@ class PythonScriptBuilder:
         with scriptpath.open("wt") as out:
             out.write("#!{}\n".format(self.pythonpath))
             out.write("# Experimaestro generated task\n\n")
-            out.write("""import logging\nlogging.basicConfig(level=logging.INFO)\n\n""")
+            out.write(
+                """import logging\n"""
+                """logging.basicConfig(level=logging.INFO, """
+                """format='%(levelname)s:%(process)d:%(asctime)s [%(name)s] %(message)s', datefmt='%y-%m-%d %H:%M:%S')\n\n"""
+            )
 
             out.write("\nif __name__ == '__main__':\n\n" "")
 

{experimaestro-1.5.3 → experimaestro-1.5.5}/src/experimaestro/settings.py

@@ -1,5 +1,5 @@
 import os
-from omegaconf import OmegaConf
+from omegaconf import OmegaConf, SCMode
 from dataclasses import field, dataclass
 from functools import lru_cache
 from pathlib import Path
@@ -23,15 +23,23 @@ class ServerSettings:
 
 @dataclass
 class WorkspaceSettings:
+    """Defines the workspace"""
+
     id: str
     """The workspace identifier"""
 
-    path: Path
+    path: Path = field()
     """The workspace path"""
 
     env: Dict[str, str] = field(default_factory=dict)
     """Workspace specific environment variables"""
 
+    alt_workspaces: List[str] = field(default_factory=list)
+    """Alternative workspaces to find jobs or experiments"""
+
+    def __post_init__(self):
+        self.path = self.path.expanduser().resolve()
+
 
 @dataclass
 class Settings:
@@ -51,13 +59,15 @@ def get_settings(path: Optional[Path] = None) -> Settings:
 
         path = path or Path("~/.config/experimaestro/settings.yaml").expanduser()
         if not path.is_file():
-            return schema
+            return schema.to_object()
 
         conf = OmegaConf.load(path)
-        return OmegaConf.merge(schema, conf)
+        return OmegaConf.to_container(
+            OmegaConf.merge(schema, conf), structured_config_mode=SCMode.INSTANTIATE
+        )
 
 
-def get_workspace(id: Optional[str]) -> WorkspaceSettings:
+def get_workspace(id: Optional[str] = None) -> Optional[WorkspaceSettings]:
     """Return the workspace settings given an id (or None for the default one)"""
     workspaces = get_settings().workspaces
     if workspaces:

experimaestro-1.5.3/src/experimaestro/scheduler/environment.py

@@ -1,94 +0,0 @@
-"""Defines an experimental environment"""
-
-from pathlib import Path
-from typing import Dict
-import marshmallow as mm
-from experimaestro.utils.settings import JsonSettings
-from pytools import memoize
-
-
-def schema(schema_cls):
-    def annotate(object_cls):
-        schema_cls.OBJECT_CLS = object_cls
-        object_cls.SCHEMA = schema_cls
-        return object_cls
-
-    return annotate
-
-
-class _Schema(mm.Schema):
-    @mm.post_load
-    def make_settings(self, data, **kwargs):
-        settings = self.__class__.OBJECT_CLS()
-        for key, value in data.items():
-            setattr(settings, key, value)
-        return settings
-
-
-class EnvironmentSchema(_Schema):
-    hostname = mm.fields.Str()
-    """The hostname (can be empty for localhost)"""
-
-    pythonpath = mm.fields.Str()
-    """Path to python executable"""
-    workdir = mm.fields.Str()
-    environ = mm.fields.Dict(keys=mm.fields.Str(), values=mm.fields.Str())
-
-
-class Schema(_Schema):
-    environments = mm.fields.Dict(
-        keys=mm.fields.Str(), values=mm.fields.Nested(EnvironmentSchema)
-    )
-
-
-@schema(Schema)
-class Settings(JsonSettings):
-    """User settings"""
-
-    def __init__(self):
-        self.environments: Dict[str, str] = {}
-
-
-@schema(EnvironmentSchema)
-class Environment:
-    """This defines the environment for an experiment, and can be stored"""
-
-    def __init__(self, workdir=None):
-        self.hostname = None
-        self._workdir = workdir
-        self.pythonpath = None
-        self.environ = {}
-
-    @property
-    def basepath(self):
-        if self.hostname:
-            from ..connectors.ssh import SshPath
-
-            return SshPath(f"ssh://{self.hostname}")
-        return Path()
-
-    @property
-    def workdir(self) -> Path:
-        assert self._workdir, "The working directory has not been set"
-        return self.basepath / self._workdir
-
-    @workdir.setter
-    def workdir(self, value):
-        self._workdir = value
-
-    def setenv(self, key: str, value: str):
-        """Set the environment variable with key"""
-        self.environ[key] = value
-
-    @staticmethod
-    @memoize()
-    def _load():
-        path = (
-            Path("~").expanduser() / ".config" / "experimaestro" / "environments.json"
-        )
-        return Settings.load(path)
-
-    @staticmethod
-    def get(name: str):
-        """Retrieve an environment by name"""
-        return Environment._load().environments[name]