handles.GitHandle

A git/jj repository positioned at a sha (and optional worktree path).

Usage

Source

handles.GitHandle(
    key,
    read_only,
    path,
    sha,
    worktree=None,
)

Parameter Attributes

key: str

A short native label for display: the store’s URI, path, repository, or database – or, for a branch-addressed system such as Neon, the branch the handle opens. Not an identity: two handles on one store may carry different keys, and the engine never compares handles by it. Use the typed fields (uri, path, branch, snapshot_id, …) for anything that matters.

read_only: bool

Whether writes through this handle are allowed.

path: str

Absolute path of the repository.

sha: str

Commit the handle refers to.

worktree: str | None = None

Path of a checked-out worktree, when one was created.