liblaf-cherries 0.4.3__tar.gz → 0.5.0__tar.gz

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: liblaf-cherries
-Version: 0.4.3
+Version: 0.5.0
 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.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/__init__.pyi

@@ -1,4 +1,4 @@
-from . import config, core, meta, paths, plugins
+from . import config, core, meta, pathutils, plugins
 from ._entrypoint import end, run, start
 from .config import BaseConfig, input, output  # noqa: A004
 from .core import (
@@ -15,17 +15,16 @@ from .core import (
     log_parameter,
     log_parameters,
 )
-from .paths import (
+from .pathutils import (
     as_os_path,
     as_path,
     as_posix,
     data,
     entrypoint,
     exp_dir,
-    git_root,
-    git_root_safe,
     params,
     path,
+    project_dir,
     src,
 )
 
@@ -43,8 +42,6 @@ __all__ = [
     "end",
     "entrypoint",
     "exp_dir",
-    "git_root",
-    "git_root_safe",
     "input",
     "log_asset",
     "log_input",
@@ -59,8 +56,9 @@ __all__ = [
     "output",
     "params",
     "path",
-    "paths",
+    "pathutils",
     "plugins",
+    "project_dir",
     "run",
     "src",
     "start",

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/_entrypoint.py

@@ -40,8 +40,8 @@ def start(
 ) -> core.Run:
     run: core.Run = profiles.factory(profile).init()
     run.start()
-    run.log_other("cherries.entrypoint", run.entrypoint.relative_to(run.root_dir))
-    run.log_other("cherries.exp_dir", run.exp_dir.relative_to(run.root_dir))
+    run.log_other("cherries.entrypoint", run.entrypoint.relative_to(run.project_dir))
+    run.log_other("cherries.exp_dir", run.exp_dir.relative_to(run.project_dir))
     run.log_other("cherries.start_time", run.start_time)
     return run
 

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.4.3'
-__version_tuple__ = version_tuple = (0, 4, 3)
+__version__ = version = '0.5.0'
+__version_tuple__ = version_tuple = (0, 5, 0)
 
 __commit_id__ = commit_id = None

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/config/__init__.pyi

@@ -8,6 +8,7 @@ from ._asset import (
     input,  # noqa: A004
     model_dump_without_assets,
     output,
+    path_generators,
 )
 from ._config import BaseConfig
 
@@ -22,4 +23,5 @@ __all__ = [
     "input",
     "model_dump_without_assets",
     "output",
+    "path_generators",
 ]

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/config/_asset.py

@@ -6,8 +6,8 @@ from typing import Any, Literal
 import pydantic
 
 from liblaf import grapes
-from liblaf.cherries import paths
-from liblaf.cherries.typed import PathLike
+from liblaf.cherries import pathutils
+from liblaf.cherries.typing import PathLike
 
 
 class AssetKind(enum.StrEnum):
@@ -20,6 +20,21 @@ type PathGenerator = (
 )
 
 
+path_generators: dict[str, PathGenerator] = {}
+
+
+def _path_generator_series(path: PathLike) -> list[Path]:
+    path = Path(path)
+    if (folder := path.with_suffix(".d")).exists():
+        return [folder]
+    if (folder := path.with_suffix("")).exists():
+        return [folder]
+    return []
+
+
+path_generators[".series"] = _path_generator_series
+
+
 class MetaAsset:
     kind: AssetKind
     _extra: PathGenerator | None = None
@@ -29,15 +44,27 @@ class MetaAsset:
         self._extra = extra
 
     def get_extra(self, value: Path) -> list[Path]:
-        if self._extra is None:
+        extra: PathGenerator | None = self._extra
+        if extra is None:
+            extra = path_generators.get(value.suffix)
+        if extra is None:
             return []
-        if callable(self._extra):
-            extra: Iterable[PathLike] = grapes.as_iterable(self._extra(value))
-            return [Path(p) for p in extra]
-        extra: Iterable[PathLike] = grapes.as_iterable(self._extra)
+        if callable(extra):
+            extra = extra(value)
+        extra = grapes.as_iterable(extra)
         return [Path(p) for p in extra]
 
 
+def asset(
+    path: PathLike, extra: PathGenerator | None = None, *, kind: AssetKind, **kwargs
+) -> Path:
+    field_info: pydantic.fields.FieldInfo = pydantic.Field(
+        pathutils.data(path), **kwargs
+    )  # pyright: ignore[reportAssignmentType]
+    field_info.metadata.append(MetaAsset(kind=kind, extra=extra))
+    return field_info  # pyright: ignore[reportReturnType]
+
+
 def get_assets(cfg: pydantic.BaseModel, kind: AssetKind) -> list[Path]:
     assets: list[Path] = []
     for name, info in type(cfg).model_fields.items():
@@ -61,9 +88,7 @@ def get_outputs(cfg: pydantic.BaseModel) -> list[Path]:
 
 
 def input(path: PathLike, extra: PathGenerator | None = None, **kwargs) -> Path:  # noqa: A001
-    field_info: pydantic.fields.FieldInfo = pydantic.Field(paths.data(path), **kwargs)  # pyright: ignore[reportAssignmentType]
-    field_info.metadata.append(MetaAsset(kind=AssetKind.INPUT, extra=extra))
-    return field_info  # pyright: ignore[reportReturnType]
+    return asset(path, extra=extra, kind=AssetKind.INPUT, **kwargs)
 
 
 def model_dump_without_assets(
@@ -87,6 +112,4 @@ def model_dump_without_assets(
 
 
 def output(path: PathLike, extra: PathGenerator | None = None, **kwargs) -> Path:
-    field_info: pydantic.fields.FieldInfo = pydantic.Field(paths.data(path), **kwargs)  # pyright: ignore[reportAssignmentType]
-    field_info.metadata.append(MetaAsset(kind=AssetKind.OUTPUT, extra=extra))
-    return field_info  # pyright: ignore[reportReturnType]
+    return asset(path, extra=extra, kind=AssetKind.OUTPUT, **kwargs)

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/core/_plugin.py

@@ -1,4 +1,4 @@
-from collections.abc import Mapping, MutableMapping, Sequence
+from collections.abc import Mapping, Sequence
 from typing import Any, Self
 
 import attrs
@@ -6,15 +6,15 @@ import networkx as nx
 
 from ._impl import ImplInfo, get_impl_info
 from ._spec import SpecInfo, collect_specs
-from .typed import MethodName
+from .typed import MethodName, PluginId
 
 
 @attrs.define
 class Plugin:
-    plugins: dict[str, "Plugin"] = attrs.field(factory=dict, kw_only=True)
+    plugins: dict[PluginId, "Plugin"] = attrs.field(factory=dict, kw_only=True)
 
     _plugin_parent: Self | None = attrs.field(default=None, kw_only=True)
-    _sort_plugins_cache: MutableMapping[MethodName, Sequence["Plugin"]] = attrs.field(
+    _sort_plugins_cache: dict[MethodName, Sequence["Plugin"]] = attrs.field(
         factory=dict, init=False
     )
 

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/core/_run.py

@@ -6,10 +6,9 @@ from pathlib import Path
 from typing import Any
 
 import attrs
-import git
 
-from liblaf.cherries import paths
-from liblaf.cherries.typed import PathLike
+from liblaf.cherries import pathutils
+from liblaf.cherries.typing import PathLike
 
 from ._plugin import Plugin
 from ._spec import spec
@@ -29,19 +28,19 @@ class Run(Plugin):
     def data_dir(self) -> Path:
         if self._plugin_parent is not None:
             return self.plugin_root.data_dir
-        return paths.data()
+        return pathutils.data()
 
     @functools.cached_property
     def entrypoint(self) -> Path:
         if self._plugin_parent is not None:
             return self.plugin_root.entrypoint
-        return paths.entrypoint()
+        return pathutils.entrypoint()
 
     @functools.cached_property
     def exp_dir(self) -> Path:
         if self._plugin_parent is not None:
             return self.plugin_root.exp_dir
-        return paths.exp_dir()
+        return pathutils.exp_dir()
 
     @functools.cached_property
     def name(self) -> str:
@@ -59,23 +58,13 @@ class Run(Plugin):
     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:
-            return None
-        else:
-            return Path(repo.working_dir).name
+        return self.project_dir.name
 
     @functools.cached_property
-    def root_dir(self) -> Path:
+    def project_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:
-            return self.entrypoint.parent
-        else:
-            return Path(repo.working_dir).absolute()
+            return self.plugin_root.project_dir
+        return pathutils.project_dir()
 
     @functools.cached_property
     def start_time(self) -> datetime.datetime:

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/meta/_git.py

@@ -3,7 +3,7 @@ import subprocess as sp
 import git
 
 from liblaf import grapes
-from liblaf.cherries import paths
+from liblaf.cherries import pathutils
 
 
 def git_auto_commit(
@@ -40,10 +40,10 @@ def git_commit_url(sha: str | None = None) -> str:
 
 def git_info() -> grapes.git.GitInfo:
     info: grapes.git.GitInfo = grapes.git.info(
-        paths.entrypoint(absolute=True), search_parent_directories=True
+        pathutils.exp_dir(absolute=True), search_parent_directories=True
     )
     return info
 
 
 def _repo() -> git.Repo:
-    return git.Repo(paths.entrypoint(absolute=True), search_parent_directories=True)
+    return git.Repo(pathutils.exp_dir(absolute=True), search_parent_directories=True)

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/meta/_name.py

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

{liblaf_cherries-0.4.3/src/liblaf/cherries/paths → liblaf_cherries-0.5.0/src/liblaf/cherries/pathutils}/__init__.pyi

@@ -1,5 +1,5 @@
 from ._convert import as_os_path, as_path, as_posix
-from ._path import entrypoint, exp_dir, git_root, git_root_safe
+from ._path import entrypoint, exp_dir, project_dir
 from ._special import config, data, params, path, src
 
 __all__ = [
@@ -10,9 +10,8 @@ __all__ = [
     "data",
     "entrypoint",
     "exp_dir",
-    "git_root",
-    "git_root_safe",
     "params",
     "path",
+    "project_dir",
     "src",
 ]

{liblaf_cherries-0.4.3/src/liblaf/cherries/paths → liblaf_cherries-0.5.0/src/liblaf/cherries/pathutils}/_convert.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 from typing import overload
 
-from liblaf.cherries.typed import PathLike
+from liblaf.cherries.typing import PathLike
 
 
 @overload

liblaf_cherries-0.5.0/src/liblaf/cherries/pathutils/_path.py

@@ -0,0 +1,43 @@
+import sys
+from pathlib import Path
+
+import git
+import git.exc
+from loguru import logger
+
+from liblaf.cherries import utils
+
+
+@utils.cache
+def entrypoint(*, absolute: bool = True) -> Path:
+    path = Path(sys.argv[0])
+    if absolute:
+        return path.absolute()
+    return path.relative_to(project_dir())
+
+
+EXP_DIR_NAMES: set[str] = {"exp", "experiment", "experiments", "exps", "src"}
+
+
+@utils.cache
+def exp_dir(*, absolute: bool = True) -> Path:
+    entrypoint_: Path = entrypoint(absolute=True)
+    parent: Path = entrypoint_.parent
+    exp_dir: Path
+    exp_dir = parent.parent if parent.name in EXP_DIR_NAMES else parent
+    if absolute:
+        return exp_dir
+    exp_dir = exp_dir.relative_to(project_dir())
+    return exp_dir
+
+
+@utils.cache
+def project_dir() -> Path:
+    exp_dir_: Path = exp_dir(absolute=True)
+    try:
+        repo = git.Repo(exp_dir_, search_parent_directories=True)
+    except git.exc.InvalidGitRepositoryError:
+        logger.warning("Not in a git repository, using current directory", once=True)
+        return exp_dir_
+    else:
+        return Path(repo.working_dir)

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/plugins/comet.py

@@ -5,10 +5,12 @@ from typing import Any, override
 import attrs
 import comet_ml
 import cytoolz as toolz
+import dvc.api
+import dvc.exceptions
 
 from liblaf import grapes
-from liblaf.cherries import core, paths
-from liblaf.cherries.typed import PathLike
+from liblaf.cherries import core, pathutils
+from liblaf.cherries.typing import PathLike
 
 
 @attrs.define
@@ -47,13 +49,18 @@ class Comet(core.Run):
         **kwargs,
     ) -> None:
         path = Path(path)
-        name = paths.as_posix(name)
-        dvc_file: Path = path.with_name(path.name + ".dvc")
-        if dvc_file.exists():
-            path = dvc_file
+        name = pathutils.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_asset(path, name, metadata=metadata, **kwargs)  # pyright: ignore[reportArgumentType]
+            self.exp.log_remote_asset(uri, name, metadata=metadata, **kwargs)  # pyright: ignore[reportArgumentType]
 
     @override
     @core.impl(after=("Dvc",))

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/plugins/dvc.py

@@ -5,7 +5,7 @@ from typing import override
 import attrs
 
 from liblaf.cherries import core
-from liblaf.cherries.typed import PathLike
+from liblaf.cherries.typing import PathLike
 
 
 @attrs.define

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/plugins/git_.py

@@ -6,16 +6,10 @@ from typing import Any, override
 
 import attrs
 import git
-import msgspec
 
+from liblaf import grapes
 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
+from liblaf.cherries.typing import PathLike
 
 
 @attrs.define
@@ -39,7 +33,7 @@ class Git(core.Run):
     @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))
+        self.inputs.append(path.relative_to(self.project_dir))
 
     @override
     @core.impl
@@ -50,12 +44,12 @@ class Git(core.Run):
         **kwargs,
     ) -> None:
         path: Path = Path(path)
-        self.outputs.append(path.relative_to(self.repo.working_dir))
+        self.outputs.append(path.relative_to(self.project_dir))
 
     @override
     @core.impl
     def start(self, *args, **kwargs) -> None:
-        self.repo = git.Repo(self.plugin_root.exp_dir, search_parent_directories=True)
+        self.repo = git.Repo(self.project_dir, search_parent_directories=True)
 
     def _make_commit_message(self) -> str:
         name: str = self.plugin_root.name
@@ -70,5 +64,5 @@ class Git(core.Run):
             metadata["inputs"] = inputs
         if outputs := self.outputs:
             metadata["outputs"] = outputs
-        message += msgspec.yaml.encode(metadata, enc_hook=enc_hook).decode()
+        message += grapes.yaml.encode(metadata).decode()
         return message

{liblaf_cherries-0.4.3 → liblaf_cherries-0.5.0}/src/liblaf/cherries/plugins/local.py

@@ -5,7 +5,7 @@ from typing import override
 import attrs
 
 from liblaf.cherries import core
-from liblaf.cherries.typed import PathLike
+from liblaf.cherries.typing import PathLike
 
 
 @attrs.define
@@ -54,8 +54,8 @@ class Local(core.Run):
     @override
     @core.impl
     def start(self, *args, **kwargs) -> None:
-        self.folder = self.plugin_root.exp_dir / ".cherries" / self.plugin_root.name
-        entrypoint: Path = self.plugin_root.entrypoint
+        self.folder = self.exp_dir / ".cherries" / self.name
+        entrypoint: Path = self.entrypoint
         self.log_asset(entrypoint, f"src/{entrypoint.name}")
 
     def _copy(self, source: PathLike, target: PathLike) -> None:

liblaf_cherries-0.4.3/src/liblaf/cherries/paths/_path.py

@@ -1,70 +0,0 @@
-import sys
-from collections.abc import Container
-from pathlib import Path
-
-import git
-import git.exc
-from loguru import logger
-
-from liblaf.cherries import utils
-
-
-@utils.cache
-def entrypoint(*, absolute: bool = True) -> Path:
-    if absolute:
-        return _entrypoint_absolute()
-    return _entrypoint_relative()
-
-
-@utils.cache
-def git_root() -> Path:
-    entrypoint: Path = _entrypoint_absolute()
-    repo = git.Repo(entrypoint, search_parent_directories=True)
-    return Path(repo.working_dir)
-
-
-@utils.cache
-def git_root_safe() -> Path:
-    try:
-        return git_root()
-    except git.exc.InvalidGitRepositoryError:
-        logger.warning("Not in a git repository, using current directory", once=True)
-        return _entrypoint_absolute().parent
-
-
-@utils.cache
-def exp_dir(*, absolute: bool = True) -> Path:
-    if absolute:
-        return _exp_dir_absolute()
-    return _exp_dir_relative()
-
-
-@utils.cache
-def _entrypoint_absolute() -> Path:
-    path = Path(sys.argv[0])
-    return path.absolute()
-
-
-@utils.cache
-def _entrypoint_relative() -> Path:
-    path: Path = _entrypoint_absolute()
-    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()
-    parent: Path = entrypoint.parent
-    if parent.name in EXP_DIR_NAMES:
-        return parent.parent
-    return parent
-
-
-@utils.cache
-def _exp_dir_relative() -> Path:
-    absolute: Path = _exp_dir_absolute()
-    root: Path = git_root_safe()
-    return absolute.relative_to(root)