StatusReport

Result of Repo.status.

Usage

Source

StatusReport(
    manifest_hash,
    stale,
    objects=list(),
    stale_keys=list(),
    bookmark=None,
    trunk=False,
    bookmark_drift=list(),
    vcs_drift=list(),
    unprotected=list(),
    fresh=True,
    snapshot_at=None
)

Parameter Attributes

manifest_hash: str

Hash of the committed object set (the dataset’s “tree id”).

stale: bool

Some forked object’s committed manifest changed underneath this workspace.

objects: list[ObjectStatus] = list()

Per-object classifications, sorted by key.

stale_keys: list[str] = list()

The objects that make the workspace stale (see Repo.stale_keys).

bookmark: str | None = None

The bookmark this workspace works on (None: read-only working copy).

trunk: bool = False

Whether that bookmark is the trunk (writes land on upstream branches).

bookmark_drift: list[str] = list()

Ways the VCS bookmark and this workspace have parted (see Repo.bookmark_drift), each with what to do about it.

vcs_drift: list[VcsDrift] = list()

Dataset commits this workspace made that left VCS history behind tether’s back (see Repo.vcs_drift).

unprotected: list[str] = list()

Objects with a deferred fork and no pin: only the store’s retention keeps their recorded state (see Repo.unprotected_keys).

fresh: bool = True

Whether the states were fingerprinted by this call (False: the cached snapshot from snapshot_at was reused).

snapshot_at: str | None = None

When the states shown were fingerprinted (UTC, ISO 8601).