Local

Bases: Plugin

              flowchart TD
              liblaf.cherries.plugins.local.Local[Local]
              liblaf.cherries.core.plugin._plugin.Plugin[Plugin]

                              liblaf.cherries.core.plugin._plugin.Plugin --> liblaf.cherries.plugins.local.Local
                


              click liblaf.cherries.plugins.local.Local href "" "liblaf.cherries.plugins.local.Local"
              click liblaf.cherries.core.plugin._plugin.Plugin href "" "liblaf.cherries.core.plugin._plugin.Plugin"
            

Copy the entrypoint, logs, and artifacts into .cherries/runs/.

Attributes:

Parameters:

• name (PluginName, default: <dynamic> ) –
• run (Run) –

Methods:

• log_asset –

  Copy path under the snapshot's assets/ directory.

• start –

  Configure local logging and copy the entrypoint.

folder: Path

log_file: Path

name: PluginName = attrs.field(
    default=attrs.Factory(_default_name, takes_self=True),
    kw_only=True,
)

run: Run = attrs.field(repr=False)

log_asset(
    path: Path,
    *,
    metadata: Mapping[str, Any] | None = None,
    report: bool = True,
) -> None

49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

@core.impl
def log_asset(
    self,
    path: Path,
    *,
    metadata: Mapping[str, Any] | None = None,
    report: bool = True,
) -> None:
    """Copy `path` under the snapshot's `assets/` directory."""
    del metadata, report
    if path.is_relative_to(self.run.working_dir):
        target: Path = self.folder / path.relative_to(self.run.working_dir)
    else:
        target: Path = self.folder / "assets" / path.name
    self._copy(path, target)

start() -> None

43
44
45
46
47

@core.impl(after=("Logging",))
def start(self) -> None:
    """Configure local logging and copy the entrypoint."""
    self._config_logging()
    self._copy(self.run.entrypoint, self.folder / "src" / self.run.entrypoint.name)