experimaestro 2.0.0a1__py3-none-any.whl → 2.0.0a4__py3-none-any.whl

experimaestro/connectors/__init__.py

@@ -16,7 +16,7 @@ from experimaestro.utils import logger
 from experimaestro.locking import Lock
 from experimaestro.tokens import Token
 from experimaestro.utils.asyncio import asyncThreadcheck
-import pkg_resources
+from importlib.metadata import entry_points
 
 
 class RedirectType(enum.Enum):
@@ -101,7 +101,7 @@ class Process:
         """Get a handler"""
         if Process.HANDLERS is None:
             Process.HANDLERS = {}
-            for ep in pkg_resources.iter_entry_points(group="experimaestro.process"):
+            for ep in entry_points(group="experimaestro.process"):
                 logging.debug("Adding process handler for type %s", ep.name)
                 handler = ep.load()
                 Process.HANDLERS[ep.name] = handler

experimaestro/core/arguments.py

@@ -80,10 +80,13 @@ class Argument:
 
         self.generator = generator
         self.default = None
+        self.ignore_generated = False
 
         if default is not None:
             assert self.generator is None, "generator and default are exclusive options"
             if isinstance(default, field):
+                self.ignore_generated = default.ignore_generated
+
                 if default.default is not None:
                     self.default = default.default
                 elif default.default_factory is not None:
@@ -184,13 +187,29 @@ DataPath = Annotated[Path, dataHint]
 class field:
     """Extra information for a given experimaestro field (param or meta)"""
 
-    def __init__(self, *, default: Any = None, default_factory: Callable = None):
+    def __init__(
+        self,
+        *,
+        default: Any = None,
+        default_factory: Callable = None,
+        ignore_generated=False,
+    ):
+        """Gives some extra per-field information
+
+        :param default: a default value, defaults to None
+        :param default_factory: a default factory for values, defaults to None
+        :param ignore_generated: True if the value is hidden – it won't be accessible in
+            tasks, defaults to False. The interest of hidden is to add a
+            configuration field that changes the identifier, but will not be
+            used.
+        """
         assert not (
             (default is not None) and (default_factory is not None)
         ), "default and default_factory are mutually exclusive options"
 
         self.default_factory = default_factory
         self.default = default
+        self.ignore_generated = ignore_generated
 
 
 class help(TypeAnnotation):

experimaestro/core/objects/config.py

@@ -169,10 +169,33 @@ class ConfigInformation:
         self._sealed = False
         self._meta = None
 
-        #: This flags is True when a value in this configuration,
-        #: or any sub-configuration, is generated. This prevents problem
-        #: when a configuration with generated values is re-used
-        self._has_generated_value = False
+        # This contains the list of generated values (using context) in this
+        # configuration or any sub-configuration, is generated. This prevents
+        # problem when a configuration with generated values is re-used.
+        self._generated_values = []
+
+    def get_generated_paths(
+        self, path: list[str] = None, paths: list[str] = None
+    ) -> list[str]:
+        """Get the list of generated paths, useful to track down those
+
+        :param path: The current path
+        :param paths: The list of generated paths so far, defaults to None
+        :return: The full list of generated paths
+        """
+        paths = [] if paths is None else paths
+        path = [] if path is None else path
+
+        for key in self._generated_values:
+            value = self.values[key]
+            if isinstance(value, ConfigMixin) and value.__xpm__._generated_values:
+                path.append(key)
+                value.__xpm__.get_generated_paths(path, paths)
+                path.pop()
+            else:
+                paths.append(".".join(path + [key]))
+
+        return paths
 
     def set_meta(self, value: Optional[bool]):
         """Sets the meta flag"""
@@ -191,6 +214,31 @@ class ConfigInformation:
         # Not an argument, bypass
         return object.__getattribute__(self.pyobject, name)
 
+    @staticmethod
+    def is_generated_value(argument, value):
+        if argument.ignore_generated:
+            return False
+
+        if value is None:
+            return False
+
+        if isinstance(value, (int, str, float, bool, Path)):
+            return False
+
+        if isinstance(value, ConfigMixin):
+            return value.__xpm__._generated_values and value.__xpm__.task is None
+
+        if isinstance(value, list):
+            return any(ConfigInformation.is_generated_value(argument, x) for x in value)
+
+        if isinstance(value, dict):
+            return any(
+                ConfigInformation.is_generated_value(argument, x)
+                for x in value.values()
+            )
+
+        assert False, f"Cannot handle values of type {type(value)}"
+
     def set(self, k, v, bypass=False):
         from experimaestro.generators import Generator
 
@@ -207,18 +255,16 @@ class ConfigInformation:
                 "Configuration (and not objects) should be used. Consider using .C(...)"
             )
 
-        if (
-            isinstance(v, ConfigMixin)
-            and v.__xpm__._has_generated_value
-            and v.__xpm__.task is None
-        ):
-            raise AttributeError(
-                f"Cannot set {k} to a configuration with generated values"
-            )
-
         try:
             argument = self.xpmtype.arguments.get(k, None)
             if argument:
+                if ConfigInformation.is_generated_value(argument, v):
+                    raise AttributeError(
+                        f"Cannot set {k} to a configuration with generated values. "
+                        "Here is the list of paths to help you: "
+                        f"""{', '.join(v.__xpm__.get_generated_paths([k]))}"""
+                    )
+
                 if not bypass and (
                     (isinstance(argument.generator, Generator)) or argument.constant
                 ):
@@ -344,14 +390,15 @@ class ConfigInformation:
         Arguments:
             - context: the generation context
         """
-        subconfigs = [
-            v.__xpm__
-            for v in self.values.values()
-            if isinstance(v, Config) and v.__xpm__.task is None
-        ]
-
-        if any(v._has_generated_value for v in subconfigs):
-            raise AttributeError("Cannot seal a configuration with generated values")
+        if generated_keys := [
+            k
+            for k, v in self.values.items()
+            if ConfigInformation.is_generated_value(self.xpmtype.arguments[k], v)
+        ]:
+            raise AttributeError(
+                "Cannot seal a configuration with generated values:"
+                f"""{",".join(generated_keys)} in {context.currentpath}"""
+            )
 
         class Sealer(ConfigWalk):
             def preprocess(self, config: ConfigMixin):
@@ -375,13 +422,18 @@ class ConfigInformation:
                                 if len(sig.parameters) == 0:
                                     value = argument.generator()
                                 elif len(sig.parameters) == 2:
+                                    # Only in that case do we need to flag this configuration
+                                    # as containing generated values
+                                    if not argument.ignore_generated:
+                                        config.__xpm__._generated_values.append(k)
+                                    else:
+                                        logging.warning("Ignoring %s", k)
                                     value = argument.generator(self.context, config)
                                 else:
                                     assert (
                                         False
                                     ), "generator has either two parameters (context and config), or none"
                             config.__xpm__.set(k, value, bypass=True)
-                            config.__xpm__._has_generated_value = True
                         else:
                             value = config.__xpm__.values.get(k)
                     except Exception:
@@ -392,11 +444,14 @@ class ConfigInformation:
 
                     # Propagate the generated value flag
                     if (
-                        (value is not None)
+                        value is not None
                         and isinstance(value, ConfigMixin)
-                        and value.__xpm__._has_generated_value
+                        and value.__xpm__._generated_values
                     ):
-                        self._has_generated_value = True
+                        if not argument.ignore_generated:
+                            config.__xpm__._generated_values.append(k)
+                        else:
+                            logging.warning("Ignoring %s", k)
 
                 config.__xpm__._sealed = True
 
@@ -889,6 +944,7 @@ class ConfigInformation:
                 "workspace": str(context.workspace.path.absolute()),
                 "tags": {key: value for key, value in self.tags().items()},
                 "version": 2,
+                "experimaestro": experimaestro.__version__,
                 "objects": self.__get_objects__([], context),
             },
             out,

experimaestro/core/objects/config_walk.py

@@ -71,6 +71,7 @@ class ConfigWalk:
         return self.context.push(str(i))
 
     def map(self, k: str):
+        """Provides a path context when processing a tree"""
         return self.context.push(k)
 
     def stub(self, config):
@@ -123,7 +124,8 @@ class ConfigWalk:
                 and self.recurse_task
                 and x.__xpm__.task is not x
             ):
-                self(x.__xpm__.task)
+                with self.map("__task__"):
+                    self(x.__xpm__.task)
 
             processed = self.postprocess(stub, x, result)
             self.visited[xid] = processed

experimaestro/scheduler/__init__.py

@@ -1 +1,18 @@
-from .base import *
+from .base import Scheduler, Listener
+from .workspace import Workspace, RunMode
+from .experiment import experiment, FailedExperiment
+from .jobs import Job, JobState, JobFailureStatus, JobDependency, JobContext
+
+__all__ = [
+    "Scheduler",
+    "Listener",
+    "Workspace",
+    "RunMode",
+    "experiment",
+    "FailedExperiment",
+    "Job",
+    "JobState",
+    "JobFailureStatus",
+    "JobDependency",
+    "JobContext",
+]