liblaf-cherries 0.3.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

liblaf/cherries/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.0'
-__version_tuple__ = version_tuple = (0, 3, 0)
+__version__ = version = '0.4.0'
+__version_tuple__ = version_tuple = (0, 4, 0)
+
+__commit_id__ = commit_id = None

liblaf/cherries/config/_asset.py

@@ -79,6 +79,7 @@ def model_dump_without_assets(
             value = model_dump_without_assets(value)
         for meta in info.metadata:
             if isinstance(meta, MetaAsset):
+                del data[name]
                 break
         else:
             data[name] = value

liblaf/cherries/core/_plugin.py

@@ -75,18 +75,22 @@ class Plugin:
                 for plugin_id, plugin in self.plugins.items()
                 if (info := get_impl_info(getattr(plugin, method, None))) is not None
             }
+
+            def key_fn(node: str) -> int:
+                return plugin_infos[node].priority
+
             graph = nx.DiGraph()
             for plugin_id, impl_info in plugin_infos.items():
                 graph.add_node(plugin_id)
                 for after in impl_info.after:
-                    graph.add_edge(after, plugin_id)
+                    if after in plugin_infos:
+                        graph.add_edge(after, plugin_id)
                 for before in impl_info.before:
-                    graph.add_edge(plugin_id, before)
+                    if before in plugin_infos:
+                        graph.add_edge(plugin_id, before)
             self._sort_plugins_cache[method] = tuple(
                 plugin
-                for plugin_id in nx.lexicographical_topological_sort(
-                    graph, key=lambda node: plugin_infos[node].priority
-                )
+                for plugin_id in nx.lexicographical_topological_sort(graph, key=key_fn)
                 if (plugin := self.plugins.get(plugin_id)) is not None
             )
         return self._sort_plugins_cache[method]

liblaf/cherries/core/_run.py

@@ -13,7 +13,6 @@ from liblaf.cherries.typed import PathLike
 
 from ._plugin import Plugin
 from ._spec import spec
-from ._utils import delegate_property_to_root
 
 
 @attrs.define
@@ -27,28 +26,39 @@ class Run(Plugin):
     """
 
     @functools.cached_property
-    @delegate_property_to_root
     def data_dir(self) -> Path:
+        if self._plugin_parent is not None:
+            return self.plugin_root.data_dir
         return paths.data()
 
     @functools.cached_property
-    @delegate_property_to_root
     def entrypoint(self) -> Path:
+        if self._plugin_parent is not None:
+            return self.plugin_root.entrypoint
         return paths.entrypoint()
 
     @functools.cached_property
-    @delegate_property_to_root
     def exp_dir(self) -> Path:
+        if self._plugin_parent is not None:
+            return self.plugin_root.exp_dir
         return paths.exp_dir()
 
     @functools.cached_property
-    @delegate_property_to_root
     def name(self) -> str:
+        if self._plugin_parent is not None:
+            return self.plugin_root.name
         return self.start_time.strftime("%Y-%m-%dT%H%M%S")
 
+    @property
+    def params(self) -> Mapping[str, Any]:
+        if self._plugin_parent is not None:
+            return self.plugin_root.params
+        return self.get_params()
+
     @functools.cached_property
-    @delegate_property_to_root
     def project_name(self) -> str | None:
+        if self._plugin_parent is not None:
+            return self.plugin_root.project_name
         try:
             repo: git.Repo = git.Repo(search_parent_directories=True)
         except git.InvalidGitRepositoryError:
@@ -57,8 +67,9 @@ class Run(Plugin):
             return Path(repo.working_dir).name
 
     @functools.cached_property
-    @delegate_property_to_root
     def root_dir(self) -> Path:
+        if self._plugin_parent is not None:
+            return self.plugin_root.root_dir
         try:
             repo: git.Repo = git.Repo(search_parent_directories=True)
         except git.InvalidGitRepositoryError:
@@ -67,18 +78,26 @@ class Run(Plugin):
             return Path(repo.working_dir).absolute()
 
     @functools.cached_property
-    @delegate_property_to_root
     def start_time(self) -> datetime.datetime:
+        if self._plugin_parent is not None:
+            return self.plugin_root.start_time
         return datetime.datetime.now().astimezone()
 
     @functools.cached_property
-    @delegate_property_to_root
     def url(self) -> str:
+        if self._plugin_parent is not None:
+            return self.plugin_root.url
         return self.get_url()
 
     @spec
     def end(self, *args, **kwargs) -> None: ...
 
+    @spec(first_result=True)
+    def get_others(self) -> Mapping[str, Any]: ...
+
+    @spec(first_result=True)
+    def get_params(self) -> Mapping[str, Any]: ...
+
     @spec(first_result=True)
     def get_url(self) -> str: ...
 

liblaf/cherries/plugins/__init__.pyi

@@ -1,6 +1,7 @@
 from .comet import Comet
 from .dvc import Dvc
+from .git_ import Git
 from .local import Local
 from .logging import Logging
 
-__all__ = ["Comet", "Dvc", "Local", "Logging"]
+__all__ = ["Comet", "Dvc", "Git", "Local", "Logging"]

liblaf/cherries/plugins/comet.py

@@ -13,6 +13,7 @@ from liblaf.cherries.typed import PathLike
 
 @attrs.define
 class Comet(core.Run):
+    disabled: bool = attrs.field(default=False)
     exp: comet_ml.CometExperiment = attrs.field(default=None)
 
     @override
@@ -20,6 +21,16 @@ class Comet(core.Run):
     def end(self, *args, **kwargs) -> None:
         return self.exp.end()
 
+    @override
+    @core.impl
+    def get_others(self) -> Mapping[str, Any]:
+        return self.exp.others
+
+    @override
+    @core.impl
+    def get_params(self) -> Mapping[str, Any]:
+        return self.exp.params
+
     @override
     @core.impl
     def get_url(self) -> str:
@@ -55,7 +66,8 @@ class Comet(core.Run):
         **kwargs,
     ) -> None:
         if name is None:
-            name = f"inputs/{Path(path).name}"
+            path = Path(path)
+            name = f"inputs/{path.name}"
         metadata = toolz.assoc(metadata or {}, "type", "input")
         self.log_asset(path, name, metadata=metadata, **kwargs)
 
@@ -90,7 +102,8 @@ class Comet(core.Run):
         **kwargs,
     ) -> None:
         if name is None:
-            name = f"outputs/{Path(path).name}"
+            path = Path(path)
+            name = f"outputs/{path.name}"
         metadata = toolz.assoc(metadata or {}, "type", "output")
         self.log_asset(path, name, metadata=metadata, **kwargs)
 
@@ -109,5 +122,7 @@ class Comet(core.Run):
     def start(self, *args, **kwargs) -> None:
         self.exp = comet_ml.start(
             project_name=self.plugin_root.project_name,
-            experiment_config=comet_ml.ExperimentConfig(name=self.plugin_root.name),
+            experiment_config=comet_ml.ExperimentConfig(
+                disabled=self.disabled, name=self.plugin_root.name
+            ),
         )

liblaf/cherries/plugins/git_.py

@@ -0,0 +1,73 @@
+import shlex
+import subprocess
+import sys
+from pathlib import Path
+from typing import Any, override
+
+import attrs
+import git
+import msgspec
+
+from liblaf.cherries import core
+from liblaf.cherries.typed import PathLike
+
+
+def enc_hook(obj: Any) -> Any:
+    if isinstance(obj, Path):
+        return str(obj)
+    raise NotImplementedError
+
+
+@attrs.define
+class Git(core.Run):
+    inputs: list[Path] = attrs.field(factory=list)
+    outputs: list[Path] = attrs.field(factory=list)
+    repo: git.Repo = attrs.field(default=None)
+
+    @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)
+
+    @override
+    @core.impl
+    def log_input(self, path: PathLike, *args, **kwargs) -> None:
+        path: Path = Path(path)
+        self.inputs.append(path.relative_to(self.repo.working_dir))
+
+    @override
+    @core.impl
+    def log_output(
+        self,
+        path: PathLike,
+        name: PathLike | None = None,
+        **kwargs,
+    ) -> None:
+        path: Path = Path(path)
+        self.outputs.append(path.relative_to(self.repo.working_dir))
+
+    @override
+    @core.impl
+    def start(self, *args, **kwargs) -> None:
+        self.repo = git.Repo(self.plugin_root.exp_dir, search_parent_directories=True)
+
+    def _make_commit_message(self) -> str:
+        name: str = self.plugin_root.name
+        message: str = f"chore(cherries): {name}\n\n"
+        metadata: dict[str, Any] = {}
+        metadata["cmd"] = shlex.join(sys.orig_argv)
+        if url := self.plugin_root.url:
+            metadata["url"] = url
+        if params := self.plugin_root.get_params():
+            metadata["params"] = params
+        if inputs := self.inputs:
+            metadata["inputs"] = inputs
+        if outputs := self.outputs:
+            metadata["outputs"] = outputs
+        message += msgspec.yaml.encode(metadata, enc_hook=enc_hook).decode()
+        return message

liblaf/cherries/profiles/_default.py

@@ -2,13 +2,16 @@ from typing import override
 
 from liblaf.cherries import core, plugins
 
-from ._playground import ProfilePlayground
+from ._abc import Profile
 
 
-class ProfileDefault(ProfilePlayground):
+class ProfileDefault(Profile):
     @override  # impl Profile
     def init(self) -> core.Run:
-        run: core.Run = super().init()
+        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())
         return run

liblaf/cherries/profiles/_factory.py

@@ -1,9 +1,11 @@
 from typing import Literal
 
+from environs import env
+
 from ._abc import Profile
 
 # ensure profiles are registered
-from ._default import ProfileDefault
+from ._default import ProfileDefault  # noqa: F401
 from ._playground import ProfilePlayground  # noqa: F401
 
 # for code-completion
@@ -12,8 +14,10 @@ type ProfileLike = ProfileName | Profile | type[Profile]
 
 
 def factory(profile: ProfileLike | None = None) -> Profile:
+    if profile is None and env.bool("DEBUG", default=False):
+        profile = "playground"
     if profile is None:
-        return ProfileDefault()
+        profile = env.str("PROFILE", default="default")
     if isinstance(profile, str):
         return Profile[profile]()
     if isinstance(profile, Profile):

liblaf/cherries/profiles/_playground.py

@@ -9,6 +9,7 @@ class ProfilePlayground(Profile):
     @override  # impl Profile
     def init(self) -> core.Run:
         run: core.Run = core.active_run
+        run.register(plugins.Comet(disabled=True))
         run.register(plugins.Local())
         run.register(plugins.Logging())
         return run

{liblaf_cherries-0.3.0.dist-info → liblaf_cherries-0.4.0.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: liblaf-cherries
-Version: 0.3.0
+Version: 0.4.0
 Summary: Add your description here
 Project-URL: Changelog, https://github.com/liblaf/cherries/blob/main/CHANGELOG.md
-Project-URL: Documentation, https://liblaf.github.io/cherries/
+Project-URL: Documentation, https://cherries.readthedocs.io/
 Project-URL: Homepage, https://github.com/liblaf/cherries
 Project-URL: Issue Tracker, https://github.com/liblaf/cherries/issues
 Project-URL: Release Notes, https://github.com/liblaf/cherries/releases
@@ -31,19 +31,19 @@ Classifier: Topic :: System :: Logging
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.12
-Requires-Dist: attrs<26,>=25.0.0
-Requires-Dist: comet-ml<4,>=3.0.0
-Requires-Dist: dvc[webdav]<4,>=3.0.0
-Requires-Dist: environs<15,>=14.0.0
-Requires-Dist: gitpython<4,>=3.0.0
+Requires-Dist: attrs<26,>=25
+Requires-Dist: comet-ml<4,>=3
+Requires-Dist: dvc[all]<4,>=3
+Requires-Dist: environs<15,>=14
+Requires-Dist: gitpython<4,>=3
 Requires-Dist: lazy-loader<0.5,>=0.4
-Requires-Dist: liblaf-grapes<2,>=1.0.0
-Requires-Dist: loguru<0.8,>=0.7.0
-Requires-Dist: networkx<4,>=3.0.0
-Requires-Dist: pydantic-settings<3,>=2.0.0
-Requires-Dist: pydantic<3,>=2.0.0
-Requires-Dist: rich<15,>=14.0.0
-Requires-Dist: wrapt<2,>=1.0.0
+Requires-Dist: liblaf-grapes<3,>=2
+Requires-Dist: loguru<0.8,>=0.7
+Requires-Dist: networkx<4,>=3
+Requires-Dist: pydantic-settings<3,>=2
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: rich<15,>=14
+Requires-Dist: wrapt<2,>=1
 Description-Content-Type: text/markdown
 
 <!-- -*- mode: markdown; -*- -->

{liblaf_cherries-0.3.0.dist-info → liblaf_cherries-0.4.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
 liblaf/cherries/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
 liblaf/cherries/__init__.pyi,sha256=vQIYxi3iwe0Uij8Q8RCFlzN5MCCDuWgcnyox01C_nJo,1066
 liblaf/cherries/_entrypoint.py,sha256=pSRbOCuMhUnYrAsZTEideVbUDEmGocvKlMgGt_MX_Z0,2262
-liblaf/cherries/_version.py,sha256=AGmG_Lx0-9ztFw_7d9mYbaYuC-2abxE1oXOUNAY29YY,511
+liblaf/cherries/_version.py,sha256=2_0GUP7yBCXRus-qiJKxQD62z172WSs1sQ6DVpPsbmM,704
 liblaf/cherries/_version.pyi,sha256=Pnv4Bxw13LHeuVkPLPsTtnp4N4jOGcAfFJw05uMMgBY,108
 liblaf/cherries/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 liblaf/cherries/typed.py,sha256=mim8QVtwczTSHyw5mhEdfFcXis9o32n0CZyu8BrEorE,50
 liblaf/cherries/config/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
 liblaf/cherries/config/__init__.pyi,sha256=Tl-GCtMEtQOcYC5poH3qzQxR91A1RcjYDP3fEdJ9Qzc,425
-liblaf/cherries/config/_asset.py,sha256=DaM-uDgZvFcvQSakdei8qfJZEXzzmlTs8cfbkXIcOJY,3088
+liblaf/cherries/config/_asset.py,sha256=pKHlzjOBc5yso3zJ18QfPzMwNETq1557E13qberoWZ0,3119
 liblaf/cherries/config/_config.py,sha256=WPwwk-3O96FyHGb2W8__LDfHpXBHLQM44aOcrMPjDL4,171
 liblaf/cherries/core/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
 liblaf/cherries/core/__init__.pyi,sha256=jgmGgzlTDlyFKHnSjNw3g22ZBuBQ07NmeRiq4qKZFdg,727
 liblaf/cherries/core/_impl.py,sha256=LCd4f5oX5bEMa4uX37r0yiPntqZM1Lwqrd7vKL1oc7w,1459
-liblaf/cherries/core/_plugin.py,sha256=24nXWLUFBL2eeHn2fUImo-45A7a8XB3CsCjyvLYk2z8,3074
-liblaf/cherries/core/_run.py,sha256=1R16v88qFv3ncx9hZeiTpgoXJqRBIVbHENlR7ZoXICw,4647
+liblaf/cherries/core/_plugin.py,sha256=LcCxNQkkInOOrPnSd5ZwKhnKQiUl4T-YicE9PEvF3XI,3198
+liblaf/cherries/core/_run.py,sha256=GNJEHGldjbvURkN5nAy8K9u1mWwxYHd-vkbnvfaOw8U,5403
 liblaf/cherries/core/_spec.py,sha256=F73wxygkc_3v0hOKwfFSGaLRHEDhhENWLQZakruuRq8,1950
 liblaf/cherries/core/_utils.py,sha256=WpS79yqTH0Kl9ewzCIAiUcxamHKzJOB7ZWhjq_13bzY,572
 liblaf/cherries/core/typed.py,sha256=razpiUtLAGFD9J4H5RbIEHKEXWzxFHFjtOBBRllhea4,42
@@ -27,21 +27,22 @@ liblaf/cherries/paths/_convert.py,sha256=IrXN_9s-rfH7EKk0_ilr1giGmfN8FlvB_edm2kI
 liblaf/cherries/paths/_path.py,sha256=36T4eE8OdT83LDwEaKjcBWS5r4jZEGBXFxeJqiB7-IQ,1604
 liblaf/cherries/paths/_special.py,sha256=w6bflcWiYzx3B_wr88JcZiUNrFRoviSLwqotYZ8XXII,1099
 liblaf/cherries/plugins/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
-liblaf/cherries/plugins/__init__.pyi,sha256=110kRPqeN0Lif68DUkxMpIwdQIhK3Zah-Q2RXoEfAPw,148
-liblaf/cherries/plugins/comet.py,sha256=r_Mhm8KpWDQK5m0GuqgKcr0Xc9dSjQrVvNRuoXg_gkQ,3241
+liblaf/cherries/plugins/__init__.pyi,sha256=dyTB5ZS78Kg_7oWeChk_h7Ry_gU9k1sDiL5YOmnoG7I,177
+liblaf/cherries/plugins/comet.py,sha256=DzQ-ktyFO6JeV1di89J3P38Ok4X07mTVtAgUZDm0FLc,3607
 liblaf/cherries/plugins/dvc.py,sha256=2HslDy_8gcFehly2CNCSZpRs0Wet7RTGMwbxxlo9IVc,1052
+liblaf/cherries/plugins/git_.py,sha256=F6JLsfkNLKseCIRrpusysW_VFhcW_44Bwfck9u8J2TI,2142
 liblaf/cherries/plugins/local.py,sha256=WHBJo6HIJOoTBRedd2a6nKoTJsaSUxhGN0jSAV94de8,1714
 liblaf/cherries/plugins/logging.py,sha256=xgK41wUQjm-jqW_d4kDbzn9m-V1sdeIX5_-d0yS32hM,758
 liblaf/cherries/profiles/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
 liblaf/cherries/profiles/__init__.pyi,sha256=qXxy2LOG9hE0LKCnECdJSv2VoHhOTMVDE3sUKIuZKmw,292
 liblaf/cherries/profiles/_abc.py,sha256=1tpRrocBZNHonWaj3a264GnL5UoGS_HqU06aNZpruqY,193
-liblaf/cherries/profiles/_default.py,sha256=hGHdnOeyL5yusKiF5M_a6nfodEdI9YPnU9jbigr20nw,352
-liblaf/cherries/profiles/_factory.py,sha256=FhYfHBmWe0uPOhRmCCg8zilUggHIPIllrPDx4Gkc8C8,602
-liblaf/cherries/profiles/_playground.py,sha256=B11N0S8gSOHGQ7jHimkfZ5EwSYk0KjsJYWGpKRja6Gs,333
+liblaf/cherries/profiles/_default.py,sha256=cfV003HBA5aGAZkgDDaHAyongFcxCWYsEFpSQNICcMs,440
+liblaf/cherries/profiles/_factory.py,sha256=d-PaE8JYllkzcqQDiyi5aP52lFJOkFdLai3XXgSKAE8,758
+liblaf/cherries/profiles/_playground.py,sha256=Aru-7RVoxNhomPLUxDLiM5wD5ZCPLy5Eymw0xQL2F9g,384
 liblaf/cherries/utils/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
 liblaf/cherries/utils/__init__.pyi,sha256=F5aTcXpWVmUoctPbLfmQXKyuXYRspAIjaIzfL1_3Lrw,51
 liblaf/cherries/utils/_functools.py,sha256=0Puwvj1Wq4kp3S--hI-CXwUBZ56AtfkqIzFHllQtuug,181
-liblaf_cherries-0.3.0.dist-info/METADATA,sha256=J_DaZSjQdIb_Wio4WEd9EoP_73MoMB2z8aQu9N5k5lc,6304
-liblaf_cherries-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-liblaf_cherries-0.3.0.dist-info/licenses/LICENSE,sha256=Ph4NzyU3lGVDeYv-mf8aRmImH8v9rVL9F362FV4G6Ow,1063
-liblaf_cherries-0.3.0.dist-info/RECORD,,
+liblaf_cherries-0.4.0.dist-info/METADATA,sha256=6Pn0aYTIS-sgG01GpJ3yFKf4O_z9uGFfTXAV9P2AGZQ,6253
+liblaf_cherries-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+liblaf_cherries-0.4.0.dist-info/licenses/LICENSE,sha256=Ph4NzyU3lGVDeYv-mf8aRmImH8v9rVL9F362FV4G6Ow,1063
+liblaf_cherries-0.4.0.dist-info/RECORD,,