liblaf-cherries 0.1.6__py3-none-any.whl → 0.2.0__py3-none-any.whl

liblaf/cherries/meta/_name.py

@@ -3,7 +3,7 @@ from pathlib import Path
 import git.exc
 
 from liblaf import grapes
-from liblaf.cherries import pathutils as _path
+from liblaf.cherries import paths
 
 from ._git import git_info
 
@@ -18,8 +18,8 @@ def project_name() -> str:
 
 
 def exp_name() -> str:
-    exp_dir: Path = _path.entrypoint(absolute=False)
-    exp_name: str = _path.as_posix(exp_dir)
+    exp_dir: Path = paths.entrypoint(absolute=False)
+    exp_name: str = paths.as_posix(exp_dir)
     exp_name = exp_name.removeprefix("exp")
     exp_name = exp_name.removeprefix("/")
     return exp_name

liblaf/cherries/{pathutils → paths}/_path.py

@@ -1,4 +1,5 @@
 import sys
+from collections.abc import Container
 from pathlib import Path
 
 import git
@@ -27,7 +28,7 @@ def git_root_safe() -> Path:
     try:
         return git_root()
     except git.exc.InvalidGitRepositoryError:
-        logger.warning("Not in a git repository, using current directory")
+        logger.warning("Not in a git repository, using current directory", once=True)
         return _entrypoint_absolute().parent
 
 
@@ -50,15 +51,16 @@ def _entrypoint_relative() -> Path:
     return path.relative_to(git_root_safe())
 
 
+EXP_DIR_NAMES: Container[str] = {"exp", "experiment", "experiments", "exps", "src"}
+
+
 @utils.cache
 def _exp_dir_absolute() -> Path:
     entrypoint: Path = _entrypoint_absolute()
-    for path in entrypoint.parents:
-        if (path / "exp.cherries.toml").is_file():
-            return path
-        if (path / "src").is_dir():
-            return path
-    return git_root_safe()
+    parent: Path = entrypoint.parent
+    if parent.name in EXP_DIR_NAMES:
+        return parent.parent
+    return parent
 
 
 @utils.cache

liblaf/cherries/plugins/__init__.pyi

@@ -0,0 +1,3 @@
+from .logging import Logging
+
+__all__ = ["Logging"]

liblaf/cherries/plugins/logging.py

@@ -0,0 +1,25 @@
+from typing import override
+
+from liblaf import grapes
+from liblaf.cherries import core
+
+
+class Logging(core.Run):
+    @override
+    @core.impl
+    def start(self, *args, **kwargs) -> None:
+        profile = grapes.logging.profiles.ProfileCherries(
+            handlers=[
+                grapes.logging.rich_handler(),
+                grapes.logging.file_handler(sink=self.plugin_root.exp_dir / "run.log"),
+            ]
+        )
+        grapes.logging.init(profile=profile)
+
+    @override
+    @core.impl
+    def end(self, *args, **kwargs) -> None:
+        if (self.plugin_root.exp_dir / "run.log").exists():
+            self.plugin_root.log_asset(self.plugin_root.exp_dir / "run.log")
+        if (self.plugin_root.exp_dir / "run.log.jsonl").exists():
+            self.plugin_root.log_asset(self.plugin_root.exp_dir / "run.log.jsonl")

liblaf/cherries/profiles/__init__.pyi

@@ -0,0 +1,13 @@
+from ._abc import Profile
+from ._default import ProfileDefault
+from ._factory import ProfileLike, ProfileName, factory
+from ._playground import ProfilePlayground
+
+__all__ = [
+    "Profile",
+    "ProfileDefault",
+    "ProfileLike",
+    "ProfileName",
+    "ProfilePlayground",
+    "factory",
+]

liblaf/cherries/profiles/_abc.py

@@ -0,0 +1,10 @@
+import abc
+
+import autoregistry
+
+from liblaf.cherries import core
+
+
+class Profile(abc.ABC, autoregistry.Registry, prefix="Profile"):
+    @abc.abstractmethod
+    def init(self) -> core.Run: ...

liblaf/cherries/profiles/_default.py

@@ -0,0 +1,12 @@
+from typing import override
+
+from liblaf.cherries import core
+
+from ._playground import ProfilePlayground
+
+
+class ProfileDefault(ProfilePlayground):
+    @override  # impl Profile
+    def init(self) -> core.Run:
+        run: core.Run = super().init()
+        return run

liblaf/cherries/profiles/_factory.py

@@ -0,0 +1,21 @@
+from typing import Literal
+
+from ._abc import Profile
+
+# ensure profiles are registered
+from ._default import ProfileDefault
+from ._playground import ProfilePlayground  # noqa: F401
+
+# for code-completion
+type ProfileName = Literal["default", "playground"] | str  # noqa: PYI051
+type ProfileLike = ProfileName | Profile | type[Profile]
+
+
+def factory(profile: ProfileLike | None = None) -> Profile:
+    if profile is None:
+        return ProfileDefault()
+    if isinstance(profile, str):
+        return Profile[profile]()
+    if isinstance(profile, Profile):
+        return profile
+    return profile()

liblaf/cherries/profiles/_playground.py

@@ -0,0 +1,13 @@
+from typing import override
+
+from liblaf.cherries import core, plugins
+
+from ._abc import Profile
+
+
+class ProfilePlayground(Profile):
+    @override  # impl Profile
+    def init(self) -> core.Run:
+        run: core.Run = core.active_run
+        run.register(plugins.Logging())
+        return run

{liblaf_cherries-0.1.6.dist-info → liblaf_cherries-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: liblaf-cherries
-Version: 0.1.6
+Version: 0.2.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/
@@ -31,17 +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: lazy-loader<0.5,>=0.4.0
-Requires-Dist: liblaf-grapes<0.4,>=0.3.0
+Requires-Dist: lazy-loader<0.5,>=0.4
+Requires-Dist: liblaf-grapes<0.7,>=0.6.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
 Description-Content-Type: text/markdown
 
 <div align="center" markdown><a name="readme-top"></a>

liblaf_cherries-0.2.0.dist-info/RECORD

@@ -0,0 +1,43 @@
+liblaf/cherries/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
+liblaf/cherries/__init__.pyi,sha256=urWKt4Q2hPNdZK-eLO1fkqqbIJ0dtiHTb6QYWgDojkA,823
+liblaf/cherries/_entrypoint.py,sha256=bBjzM770-9lybNq0qtSYdiIPsWIVoHttgkxj02myyAU,1581
+liblaf/cherries/_version.py,sha256=iB5DfB5V6YB5Wo4JmvS-txT42QtmGaWcWp3udRT7zCI,511
+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=1CMEQlPneeRXCG51KDUj6Zmqs0xzUF3gilqeuHPlsVc,359
+liblaf/cherries/config/_asset.py,sha256=OZQ521GIOWNWMdcF_iV3t5ZG5XhdlaQ6_diuqP_DPx0,2472
+liblaf/cherries/config/_config.py,sha256=WPwwk-3O96FyHGb2W8__LDfHpXBHLQM44aOcrMPjDL4,171
+liblaf/cherries/core/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
+liblaf/cherries/core/__init__.pyi,sha256=3hAxoGwuAYfJs5UzYGiyZSwA4nYNarGziceK7jh-CLs,414
+liblaf/cherries/core/_impl.py,sha256=1sRAIdWNB5eLJ45cZOdLn0VZ06mqkxI6r5GXSMXoUWo,1374
+liblaf/cherries/core/_plugin.py,sha256=mZxki48dC64CxsOj5dZiKlSPZG9zioun_pP0y3AHtZo,3138
+liblaf/cherries/core/_run.py,sha256=O8B2aOZwxdnwBfAv24nA7FkFn7KgLF9EjFkeQs6hcrQ,1020
+liblaf/cherries/core/_spec.py,sha256=b6sTw5C08dnAjw_YRcGyd32XbSTvGMekkzE_qPvZI9g,1789
+liblaf/cherries/core/typed.py,sha256=razpiUtLAGFD9J4H5RbIEHKEXWzxFHFjtOBBRllhea4,42
+liblaf/cherries/meta/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
+liblaf/cherries/meta/__init__.pyi,sha256=kQFneP3IiV9rBIzpep_uX0z-5IRPrXkPmyNRt19j8fg,282
+liblaf/cherries/meta/_git.py,sha256=HhxqwKY52KahvAYU0R3BTRNT7lMJIjJLpnuSYfm02W4,1219
+liblaf/cherries/meta/_name.py,sha256=JdV47Ji4qHUILe8GEfIMC_MgkwKx2ottXqwotJ5XwS0,548
+liblaf/cherries/paths/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
+liblaf/cherries/paths/__init__.pyi,sha256=mr3Dk8ragpNGXmXJriMt21vc7YmqUD6X587exFe9tCI,413
+liblaf/cherries/paths/_convert.py,sha256=IrXN_9s-rfH7EKk0_ilr1giGmfN8FlvB_edm2kI-k3I,807
+liblaf/cherries/paths/_path.py,sha256=Wz3C4ZgERzP659I_eC1N9lMokyyvbIedCMs3PpYrYus,1606
+liblaf/cherries/paths/_special.py,sha256=b5D3PtW__u0Zpiv69OYoV7TTYc6Dgs4Bu-P8jwrROV4,1415
+liblaf/cherries/plugins/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
+liblaf/cherries/plugins/__init__.pyi,sha256=PUOon4osKSfGEQCj6NG2wUgwCOh4G8LcHfOad_RFs6o,52
+liblaf/cherries/plugins/logging.py,sha256=_Dzzc-jBWIvWWhfq_i-dq2IsX1Vnan0cDNy7Sar_Uvc,836
+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=7V0BkyB80iVOI7bray4rWHGYlMqN3oEzAg3eOJ2XRWI,269
+liblaf/cherries/profiles/_factory.py,sha256=FhYfHBmWe0uPOhRmCCg8zilUggHIPIllrPDx4Gkc8C8,602
+liblaf/cherries/profiles/_playground.py,sha256=QS_YjYu5ewloF3_U4dZFmqCHx3WVHyIKcqsVe1WbYrc,295
+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.2.0.dist-info/METADATA,sha256=yH-oOPeBTRybMUFCvinx6g3lTpNn000NxbkP4bDjxI4,6256
+liblaf_cherries-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+liblaf_cherries-0.2.0.dist-info/licenses/LICENSE,sha256=Ph4NzyU3lGVDeYv-mf8aRmImH8v9rVL9F362FV4G6Ow,1063
+liblaf_cherries-0.2.0.dist-info/RECORD,,

liblaf/cherries/_run.py

@@ -1,51 +0,0 @@
-from collections.abc import Callable
-from typing import get_type_hints
-
-import pydantic
-
-from liblaf.cherries import config, integration, presets
-from liblaf.cherries import pathutils as _path
-
-
-def run[C: pydantic.BaseModel, T](
-    main: Callable[[], T] | Callable[[C], T],
-    *,
-    play: bool = False,
-    preset: presets.Preset = presets.default,
-) -> T:
-    exp: integration.Experiment = start(preset=preset, play=play)
-    type_hints: dict[str, type[C]] = get_type_hints(main)
-    del type_hints["return"]
-    args: list[C] = []
-    if len(type_hints) == 1:
-        cls: type[C] = next(iter(type_hints.values()))
-        cfg: C = cls()
-        args.append(cfg)
-        for path in config.get_inputs(cfg):
-            exp.log_input(path)
-    try:
-        result: T = main(*args)
-    finally:
-        if len(type_hints) == 1:
-            cfg: C = args[0]
-            for path in config.get_outputs(cfg):
-                exp.log_output(path)
-        exp.end()
-    return result
-
-
-def start(
-    preset: presets.Preset = presets.default, *, play: bool = False
-) -> integration.Experiment:
-    if play:
-        preset = presets.playground
-    exp: integration.Experiment = preset(integration.exp)
-    exp.start()
-    exp.log_other("cherries.entrypoint", _path.entrypoint(absolute=False))
-    exp.log_other("cherries.exp-dir", _path.exp_dir(absolute=False))
-    exp.log_other("cherries.start-time", exp.start_time)
-    return exp
-
-
-def end() -> None:
-    integration.exp.end()

liblaf/cherries/core/_exp.py

@@ -1,119 +0,0 @@
-import datetime
-import functools
-from pathlib import Path
-from typing import Any
-
-from liblaf.cherries import pathutils as _path
-from liblaf.cherries.typed import PathLike
-
-from ._spec import Plugin, spec
-
-
-class Experiment(Plugin):
-    @functools.cached_property
-    def exp_dir(self) -> Path:
-        return _path.exp_dir(absolute=True)
-
-    @property
-    def exp_id(self) -> str:
-        return self.get_exp_id()
-
-    @property
-    def exp_name(self) -> str:
-        return self.get_exp_name()
-
-    @exp_name.setter
-    def exp_name(self, value: str) -> None:
-        self.set_exp_name(value)
-
-    @property
-    def exp_url(self) -> str:
-        return self.get_exp_url()
-
-    @property
-    def project_id(self) -> str:
-        return self.get_project_id()
-
-    @property
-    def project_name(self) -> str:
-        return self.get_project_name()
-
-    @functools.cached_property
-    def start_time(self) -> datetime.datetime:
-        return datetime.datetime.now().astimezone()
-
-    def log_input(self, path: PathLike, /, **kwargs) -> None:
-        self.log_asset(path, prefix="inputs/", **kwargs)
-
-    def log_output(self, path: PathLike, /, **kwargs) -> None:
-        self.log_asset(path, prefix="outputs/", **kwargs)
-
-    @spec
-    def add_tag(self, tag: str, /) -> None: ...
-
-    @spec
-    def add_tags(self, tags: list[str], /) -> None: ...
-
-    @spec
-    def end(self) -> None: ...
-
-    @spec(firstresult=True)
-    def get_exp_id(self) -> str: ...
-
-    @spec(firstresult=True)
-    def get_exp_name(self) -> str: ...
-
-    @spec(firstresult=True)
-    def get_exp_url(self) -> str: ...
-
-    @spec(firstresult=True)
-    def get_project_id(self) -> str: ...
-
-    @spec(firstresult=True)
-    def get_project_name(self) -> str: ...
-
-    @spec(firstresult=True)
-    def get_project_url(self) -> str: ...
-
-    @spec
-    def log_asset(self, path: PathLike, /, prefix: str | None = None) -> None: ...
-
-    @spec
-    def log_code(self, path: str, /) -> None: ...
-
-    @spec
-    def log_metric(
-        self,
-        key: str,
-        value: float,
-        /,
-        step: int | None = None,
-        epoch: int | None = None,
-    ) -> None: ...
-
-    @spec
-    def log_metrics(
-        self,
-        metrics: dict[str, float],
-        /,
-        step: int | None = None,
-        epoch: int | None = None,
-    ) -> None: ...
-
-    @spec
-    def log_other(self, key: str, value: Any, /) -> None: ...
-
-    @spec
-    def log_others(self, others: dict[str, Any], /) -> None: ...
-
-    @spec
-    def log_param(self, key: str, value: Any, /) -> None: ...
-
-    @spec
-    def log_params(self, params: dict[str, Any], /) -> None: ...
-
-    @spec
-    def set_exp_name(self, name: str, /) -> None: ...
-
-    @spec
-    def start(self) -> None: ...

liblaf/cherries/integration/__init__.pyi

@@ -1,72 +0,0 @@
-from . import comet, dvc, git, logging
-from ._abc import (
-    AddTag,
-    AddTags,
-    End,
-    LogAsset,
-    LogCode,
-    LogMetric,
-    LogMetrics,
-    LogOther,
-    LogOthers,
-    LogParam,
-    LogParams,
-    Plugin,
-    Start,
-)
-from ._exp import (
-    Experiment,
-    add_tag,
-    add_tags,
-    current_exp,
-    end,
-    exp,
-    log_asset,
-    log_code,
-    log_input,
-    log_metric,
-    log_metrics,
-    log_other,
-    log_others,
-    log_output,
-    log_param,
-    log_params,
-    start,
-)
-
-__all__ = [
-    "AddTag",
-    "AddTags",
-    "End",
-    "Experiment",
-    "LogAsset",
-    "LogCode",
-    "LogMetric",
-    "LogMetrics",
-    "LogOther",
-    "LogOthers",
-    "LogParam",
-    "LogParams",
-    "Plugin",
-    "Start",
-    "add_tag",
-    "add_tags",
-    "comet",
-    "current_exp",
-    "dvc",
-    "end",
-    "exp",
-    "git",
-    "log_asset",
-    "log_code",
-    "log_input",
-    "log_metric",
-    "log_metrics",
-    "log_other",
-    "log_others",
-    "log_output",
-    "log_param",
-    "log_params",
-    "logging",
-    "start",
-]

liblaf/cherries/integration/_abc.py

@@ -1,144 +0,0 @@
-import bisect
-import functools
-import operator
-from collections.abc import Iterable, Mapping
-from typing import Any
-
-import attrs
-from loguru import logger
-
-from liblaf.cherries.typed import PathLike
-
-
-@attrs.define
-@functools.total_ordering
-class Plugin[**P, T]:
-    priority: int = attrs.field(default=0, kw_only=True)
-    _children: list["Plugin"] = attrs.field(
-        factory=list, eq=False, order=False, alias="children"
-    )
-
-    def __attrs_post_init__(self) -> None:
-        self._children.sort(key=operator.attrgetter("priority"))
-
-    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> T:
-        ret: T | None = None
-        for child in self._children:
-            try:
-                ret = child(*args, **kwargs)
-            except BaseException as err:
-                if isinstance(err, (KeyboardInterrupt, SystemExit)):
-                    raise
-                logger.exception(child)
-        return ret  # pyright: ignore[reportReturnType]
-
-    def __lt__(self, other: "Plugin") -> bool:
-        if not isinstance(other, Plugin):
-            return NotImplemented
-        return self.priority < other.priority
-
-    def __eq__(self, other: "Plugin") -> bool:  # pyright: ignore[reportIncompatibleMethodOverride]
-        if not isinstance(other, Plugin):
-            return NotImplemented
-        return self.priority == other.priority
-
-    @property
-    def children(self) -> list["Plugin"]:
-        return self._children
-
-    def add(self, *children: "Plugin") -> None:
-        for c in children:
-            bisect.insort(self._children, c, key=operator.attrgetter("priority"))
-
-    def extend(self, children: Iterable["Plugin"]) -> None:
-        self.add(*children)
-
-    def remove(self, child: "Plugin") -> None:
-        self._children.remove(child)
-
-
-@attrs.define
-class AddTag(Plugin):
-    def __call__(self, tag: str, /, **kwargs) -> None:
-        super().__call__(tag, **kwargs)
-
-
-@attrs.define
-class AddTags(Plugin):
-    def __call__(self, tags: Iterable[str], /, **kwargs) -> None:
-        super().__call__(tags, **kwargs)
-
-
-@attrs.define
-class End(Plugin):
-    def __call__(self, **kwargs) -> None:
-        super().__call__(**kwargs)
-
-
-@attrs.define
-class LogAsset(Plugin):
-    def __call__(self, path: PathLike, /, prefix: str | None = None, **kwargs) -> None:
-        super().__call__(path, prefix=prefix, **kwargs)
-
-
-@attrs.define
-class LogCode(Plugin):
-    def __call__(self, path: PathLike, /, **kwargs) -> None:
-        super().__call__(path, **kwargs)
-
-
-@attrs.define
-class LogMetric(Plugin):
-    def __call__(
-        self,
-        key: str,
-        value: float,
-        /,
-        step: int | None = None,
-        epoch: int | None = None,
-        **kwargs,
-    ) -> None:
-        super().__call__(key, value, step=step, epoch=epoch, **kwargs)
-
-
-@attrs.define
-class LogMetrics(Plugin):
-    def __call__(
-        self,
-        metrics: Mapping[str, Any],
-        /,
-        step: int | None = None,
-        epoch: int | None = None,
-        **kwargs,
-    ) -> None:
-        super().__call__(metrics, step=step, epoch=epoch, **kwargs)
-
-
-@attrs.define
-class LogOther(Plugin):
-    def __call__(self, key: str, value: Any, /, **kwargs) -> None:
-        super().__call__(key, value, **kwargs)
-
-
-@attrs.define
-class LogOthers(Plugin):
-    def __call__(self, others: Mapping[str, Any], /, **kwargs) -> None:
-        super().__call__(others, **kwargs)
-
-
-@attrs.define
-class LogParam(Plugin):
-    def __call__(self, name: str, value: Any, /, **kwargs) -> None:
-        super().__call__(name, value, **kwargs)
-
-
-@attrs.define
-class LogParams(Plugin):
-    def __call__(self, params: Mapping[str, Any], /, **kwargs) -> None:
-        super().__call__(params, **kwargs)
-
-
-@attrs.define
-class Start(Plugin):
-    def __call__(self, **kwargs) -> None:
-        super().__call__(**kwargs)