Git

Bases: Plugin

              flowchart TD
              liblaf.cherries.plugins.git.Git[Git]
              liblaf.cherries.core.plugin._plugin.Plugin[Plugin]

                              liblaf.cherries.core.plugin._plugin.Plugin --> liblaf.cherries.plugins.git.Git
                


              click liblaf.cherries.plugins.git.Git href "" "liblaf.cherries.plugins.git.Git"
              click liblaf.cherries.core.plugin._plugin.Plugin href "" "liblaf.cherries.core.plugin._plugin.Plugin"
            

Record Git metadata and optionally commit dirty experiment outputs.

Attributes:

Parameters:

• name (PluginName, default: <dynamic> ) –
• run (Run) –
• commit (bool, default: False ) –
• verify (bool, default: False ) –

Methods:

• end –

  Commit dirty changes if configured and log the final Git SHA.

commit: bool = attrs.field(default=False, kw_only=True)

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

repo: Repo | None

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

verify: bool = attrs.field(default=False, kw_only=True)

end(exc: BaseException | None = None) -> None

31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

@core.impl(before=("Comet",))
def end(self, exc: BaseException | None = None) -> None:
    """Commit dirty changes if configured and log the final Git SHA."""
    del exc
    if self.repo is None:
        return
    if self.commit and self.repo.is_dirty(untracked_files=True):
        message: str = self._make_commit_message()
        try:
            self.repo.git.add(all=True)
            subprocess.run(["git", "status"], check=False)
            self.repo.git.commit(message=message, no_verify=not self.verify)
        except git.GitCommandError:
            logger.exception("")
    self.run.log_other("cherries/git/sha", self.repo.head.commit.hexsha)