liblaf-cherries 0.5.2__tar.gz → 0.5.4__tar.gz

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: liblaf-cherries
-Version: 0.5.2
+Version: 0.5.4
 Summary: 🍒 Sweet experiment tracking with Comet, DVC, and Git integration.
 Project-URL: Changelog, https://github.com/liblaf/cherries/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://cherries.readthedocs.io/

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/_entrypoint.py

@@ -1,3 +1,4 @@
+import datetime
 import inspect
 import itertools
 from collections.abc import Callable, Mapping, Sequence
@@ -10,6 +11,7 @@ from liblaf.cherries import core, profiles
 
 
 def end(*args, **kwargs) -> None:
+    core.active_run.log_other("cherries.end_time", datetime.datetime.now().astimezone())
     core.active_run.end(*args, **kwargs)
 
 

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.5.2'
-__version_tuple__ = version_tuple = (0, 5, 2)
+__version__ = version = '0.5.4'
+__version_tuple__ = version_tuple = (0, 5, 4)
 
 __commit_id__ = commit_id = None

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/core/_run.py

@@ -1,4 +1,3 @@
-import contextlib
 import datetime
 from collections.abc import Mapping
 from pathlib import Path
@@ -37,8 +36,12 @@ class Run(Plugin):
         return path_utils.exp_dir()
 
     @plugin_cached_property
-    def name(self) -> str:
-        return self.start_time.strftime("%Y-%m-%dT%H%M%S")
+    def exp_name(self) -> str:
+        return (
+            self.entrypoint.relative_to(self.project_dir)
+            .as_posix()
+            .removeprefix("exp/")
+        )
 
     @plugin_property
     def params(self) -> Mapping[str, Any]:
@@ -72,7 +75,7 @@ class Run(Plugin):
     @spec(first_result=True)
     def get_url(self) -> str: ...
 
-    @spec(delegate=False)
+    @spec
     def log_asset(
         self,
         path: PathLike,
@@ -80,12 +83,7 @@ class Run(Plugin):
         *,
         metadata: Mapping[str, Any] | None = None,
         **kwargs,
-    ) -> None:
-        if name is None:
-            path = Path(path)
-            with contextlib.suppress(ValueError):
-                name = path.relative_to(self.data_dir)
-        self.delegate("log_asset", (path, name), {"metadata": metadata, **kwargs})
+    ) -> None: ...
 
     @spec
     def log_input(
@@ -150,9 +148,8 @@ class Run(Plugin):
         **kwargs,
     ) -> None: ...
 
-    @spec(delegate=False)
-    def start(self, *args, **kwargs) -> None:
-        self.delegate("start", args, kwargs)
+    @spec
+    def start(self, *args, **kwargs) -> None: ...
 
 
 active_run: Run = Run()

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/core/_utils.py

@@ -1,24 +1,6 @@
 import functools
 from collections.abc import Callable
-from typing import TYPE_CHECKING, Any, Self, overload, override
-
-import wrapt
-
-if TYPE_CHECKING:
-    from ._plugin import Plugin
-
-
-def delegate_property_to_root[C: Callable](func: C) -> C:
-    @wrapt.decorator
-    def wrapper(
-        wrapped: Callable, instance: "Plugin", args: tuple, kwargs: dict[str, Any]
-    ) -> None:
-        # TODO: make it work with `@functools.cached_property`
-        if instance.plugin_root is not instance:
-            return wrapped(*args, **kwargs)
-        return getattr(instance.plugin_root, wrapped.__name__)
-
-    return func
+from typing import Any, Self, overload, override
 
 
 class PluginCachedProperty[T](functools.cached_property[T]):
@@ -30,7 +12,7 @@ class PluginCachedProperty[T](functools.cached_property[T]):
     def __get__(self, instance: object | None, owner: type | None = None) -> Self | T:
         if instance is None:
             return super().__get__(instance, owner)
-        if (parent := getattr(instance, "_plugin_parent", None)) is not None:
+        while (parent := getattr(instance, "_plugin_parent", None)) is not None:
             instance = parent
         return super().__get__(instance, owner)
 
@@ -50,7 +32,7 @@ class PluginProperty[T](property):
     ) -> Self | T:
         if instance is None:
             return super().__get__(instance, owner)
-        if (parent := getattr(instance, "_plugin_parent", None)) is not None:
+        while (parent := getattr(instance, "_plugin_parent", None)) is not None:
             instance = parent
         return super().__get__(instance, owner)
 

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/plugins/comet.py

@@ -7,21 +7,36 @@ import comet_ml
 import cytoolz as toolz
 import dvc.api
 import dvc.exceptions
+import git
+from loguru import logger
 
 from liblaf import grapes
 from liblaf.cherries import core, path_utils
 from liblaf.cherries.typing import PathLike
 
 
+@attrs.frozen
+class Asset:
+    path: PathLike
+    name: PathLike | None
+    metadata: Mapping[str, Any] | None = None
+    kwargs: Mapping[str, Any] = attrs.field(factory=dict)
+
+
 @attrs.define
 class Comet(core.Run):
     disabled: bool = attrs.field(default=False)
     exp: comet_ml.CometExperiment = attrs.field(default=None)
+    _assets_git: list[Asset] = attrs.field(factory=list)
 
     @override
-    @core.impl(after=("Logging",))
+    @core.impl(after=("Git", "Logging"))
     def end(self, *args, **kwargs) -> None:
-        return self.exp.end()
+        try:
+            self._log_asset_git_end()
+        except git.GitError as err:
+            logger.exception(err)
+        self.exp.end()
 
     @override
     @core.impl
@@ -44,23 +59,14 @@ class Comet(core.Run):
         self,
         path: PathLike,
         name: PathLike | None = None,
-        *,
-        metadata: Mapping[str, Any] | None = None,
         **kwargs,
     ) -> None:
-        path = Path(path)
+        if self._log_asset_git(path, name, **kwargs):
+            return
+        if self._log_asset_dvc(path, name, **kwargs):
+            return
         name = path_utils.as_posix(name)
-        try:
-            # ? I don't know why, but `dvc.api.get_url` only works with this. Maybe a DVC bug?
-            dvc_path: Path = path.absolute().relative_to(Path.cwd())
-            uri: str = dvc.api.get_url(str(dvc_path))
-        except dvc.exceptions.OutputNotFoundError:
-            self.exp.log_asset(path, name, metadata=metadata, **kwargs)  # pyright: ignore[reportArgumentType]
-        else:
-            dvc_file: Path = path.with_name(path.name + ".dvc")
-            dvc_meta: Mapping[str, Any] = grapes.yaml.load(dvc_file)
-            metadata = toolz.merge(metadata or {}, dvc_meta["outs"][0])
-            self.exp.log_remote_asset(uri, name, metadata=metadata, **kwargs)  # pyright: ignore[reportArgumentType]
+        self.exp.log_asset(path, name, **kwargs)
 
     @override
     @core.impl(after=("Dvc",))
@@ -130,6 +136,73 @@ class Comet(core.Run):
         self.exp = comet_ml.start(
             project_name=self.project_name,
             experiment_config=comet_ml.ExperimentConfig(
-                disabled=self.disabled, name=self.name
+                disabled=self.disabled, name=self.exp_name
             ),
         )
+
+    def _log_asset_dvc(
+        self,
+        path: PathLike,
+        name: PathLike | None = None,
+        *,
+        metadata: Mapping[str, Any] | None = None,
+        **kwargs,
+    ) -> bool:
+        path = Path(path)
+        name = path_utils.as_posix(name)
+        try:
+            # ? I don't know why, but `dvc.api.get_url` only works with this. Maybe a DVC bug?
+            dvc_path: Path = path.absolute().relative_to(Path.cwd())
+            uri: str = dvc.api.get_url(str(dvc_path))
+        except dvc.exceptions.OutputNotFoundError:
+            return False
+        dvc_file: Path = path.with_name(path.name + ".dvc")
+        dvc_meta: Mapping[str, Any] = grapes.yaml.load(dvc_file)
+        metadata: dict[str, Mapping] = toolz.merge(metadata or {}, dvc_meta["outs"][0])
+        self.exp.log_remote_asset(uri, name, metadata=metadata, **kwargs)
+        return True
+
+    def _log_asset_git(
+        self,
+        path: PathLike,
+        name: PathLike | None = None,
+        *,
+        metadata: Mapping[str, Any] | None = None,
+        **kwargs,
+    ) -> bool:
+        try:
+            repo = git.Repo(search_parent_directories=True)
+        except git.InvalidGitRepositoryError:
+            return False
+        try:
+            if repo.ignored(path):
+                return False
+        except git.GitCommandError:
+            # `path` may be outside repository
+            return False
+        self._assets_git.append(
+            Asset(path=path, name=name, metadata=metadata, kwargs=kwargs)
+        )
+        return True
+
+    def _log_asset_git_end(self) -> None:
+        if len(self._assets_git) == 0:
+            return
+        repo = git.Repo(search_parent_directories=True)
+        info: grapes.git.GitInfo = grapes.git.info()
+        for asset in self._assets_git:
+            uri: str
+            match str(info.platform):
+                case "github":
+                    path: Path = Path(asset.path).absolute()
+                    path_rel: str = path.relative_to(repo.working_tree_dir).as_posix()  # pyright: ignore[reportArgumentType]
+                    sha: str = repo.head.commit.hexsha
+                    uri = f"https://{info.host}/{info.owner}/{info.repo}/raw/{sha}/{path_rel}"
+                case _:
+                    uri = path_utils.as_posix(asset.path)
+            self.exp.log_remote_asset(
+                uri,
+                path_utils.as_posix(asset.name),
+                metadata=dict(asset.metadata) if asset.metadata is not None else None,
+                **asset.kwargs,
+            )

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/plugins/git_.py

@@ -6,6 +6,7 @@ from typing import Any, override
 
 import attrs
 import git
+from loguru import logger
 
 from liblaf import grapes
 from liblaf.cherries import core
@@ -14,6 +15,7 @@ from liblaf.cherries.typing import PathLike
 
 @attrs.define
 class Git(core.Run):
+    commit: bool = True
     inputs: list[Path] = attrs.field(factory=list)
     outputs: list[Path] = attrs.field(factory=list)
     repo: git.Repo = attrs.field(default=None)
@@ -22,12 +24,15 @@ class Git(core.Run):
     @override
     @core.impl(after=("Dvc",))
     def end(self, *args, **kwargs) -> None:
-        if not self.repo.is_dirty(untracked_files=True):
-            return
-        self.repo.git.add(all=True)
-        subprocess.run(["git", "status"], check=False)
-        message: str = self._make_commit_message()
-        self.repo.git.commit(message=message, no_verify=not self.verify)
+        if self.commit and self.repo.is_dirty(untracked_files=True):
+            try:
+                self.repo.git.add(all=True)
+                subprocess.run(["git", "status"], check=False)
+                message: str = self._make_commit_message()
+                self.repo.git.commit(message=message, no_verify=not self.verify)
+            except git.GitCommandError as err:
+                logger.exception(err)
+        self.plugin_root.log_other("cherries.git.sha", self.repo.head.commit.hexsha)
 
     @override
     @core.impl
@@ -49,10 +54,10 @@ class Git(core.Run):
     @override
     @core.impl
     def start(self, *args, **kwargs) -> None:
-        self.repo = git.Repo(self.project_dir, search_parent_directories=True)
+        self.repo = git.Repo(search_parent_directories=True)
 
     def _make_commit_message(self) -> str:
-        name: str = self.name
+        name: str = self.exp_name
         message: str = f"chore(cherries): {name}\n\n"
         meta: dict[str, Any] = {}
         if url := self.url:

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/plugins/local.py

@@ -20,8 +20,13 @@ class Local(core.Run):
         name: PathLike | None = None,
         **kwargs,
     ) -> None:
+        path = Path(path)
         if name is None:
-            name = Path(path).name
+            path_absolute: Path = path.resolve()
+            if path_absolute.is_relative_to(self.exp_dir):
+                name = path_absolute.relative_to(self.exp_dir)
+            else:
+                name = path
         target: Path = self.folder / name
         self._copy(path, target)
 
@@ -54,7 +59,12 @@ class Local(core.Run):
     @override
     @core.impl
     def start(self, *args, **kwargs) -> None:
-        self.folder = self.exp_dir / ".cherries" / self.name
+        self.folder = (
+            self.exp_dir
+            / ".cherries"
+            / self.entrypoint.stem
+            / self.start_time.strftime("%Y-%m-%dT%H%M%S")
+        )
         entrypoint: Path = self.entrypoint
         self.log_asset(entrypoint, f"src/{entrypoint.name}")
 

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/plugins/logging.py

@@ -11,7 +11,7 @@ from liblaf.cherries import core
 class Logging(core.Run):
     @property
     def log_file(self) -> Path:
-        return self.exp_dir / "run.log"
+        return self.exp_dir / "logs" / self.entrypoint.with_suffix(".log").name
 
     @override
     @core.impl
@@ -21,4 +21,4 @@ class Logging(core.Run):
     @override
     @core.impl
     def end(self, *args, **kwargs) -> None:
-        self.log_asset(self.log_file)
+        self.plugin_root.log_asset(self.log_file, "run.log")

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/profiles/_default.py

@@ -10,7 +10,6 @@ class ProfileDefault(Profile):
     def init(self) -> core.Run:
         run: core.Run = core.active_run
         run.register(plugins.Comet())
-        run.register(plugins.Dvc())
         run.register(plugins.Git())
         run.register(plugins.Local())
         run.register(plugins.Logging())

{liblaf_cherries-0.5.2 → liblaf_cherries-0.5.4}/src/liblaf/cherries/profiles/_playground.py

@@ -10,6 +10,7 @@ class ProfilePlayground(Profile):
     def init(self) -> core.Run:
         run: core.Run = core.active_run
         run.register(plugins.Comet(disabled=True))
+        run.register(plugins.Git(commit=False))
         run.register(plugins.Local())
         run.register(plugins.Logging())
         return run