ClaimReport (1 of 2)

ClaimReportclassdataclass#

Re-exported from ocx_sdk._resultsView source

class ClaimReport(package: str, name: str, status: str, forge: str, transport: str, credential_kind: str, push_credential_kind: str | None, author: ClaimOwner | None, author_identity_source: str | None, owners: tuple[ClaimOwner, ...], owner_identity_source: str, branch: str, pull_request_url: str | None, pull_request_number: int | None, fork: str | None, written_paths: tuple[str, ...], capability_checks: tuple[CapabilityCheck, ...])

ocx package claim — the index entry a claim rendered (C-060).

Payload is bare (D11), seventeen keys, every one always on the wire. A package that is already claimed never produces this: ocx exits 65 with an error envelope instead, which error_envelope(err) recovers.

Attributes

Name	Type	Description
package	str	The claimed <namespace>/<package>, as given.
name	str	The logical name written into the root.
status	str	"updated" or "unchanged" — against the open claim branch, not the committed root, so a --out run is always "updated".
forge	str	"github" or "gitlab".
transport	str	"api" or "git".
credential_kind	str	"job-token", "token" or "none".
push_credential_kind	str | None	"job-token", "token", "git-helper", or None under the api transport.
author	ClaimOwner | None	The identity that authored the request, or None when neither the token nor the CI environment named one. Not attested — see author_identity_source.
author_identity_source	str | None	"resolved" when the forge’s own answer about the credential produced author, "ci-environment" when an ordinary environment read did; None exactly when author is.
owners	tuple[ClaimOwner, ...]	The recorded owners, in order.
owner_identity_source	str	"resolved", "asserted" or "ci-environment".
branch	str	The claim branch.
pull_request_url	str | None	The request’s URL, when one was opened.
pull_request_number	int | None	Its number, likewise.
fork	str | None	The fork the request came from, when --fork was given.
written_paths	tuple[str, ...]	Files written under --out; empty otherwise.
capability_checks	tuple[CapabilityCheck, ...]	The forge probes, in CapabilityName order.

branchattributeinstance attribute#

View source

branch: str

capability_checksattributeinstance attribute#

View source

capability_checks: tuple[CapabilityCheck, ...]

forkattributeinstance attribute#

View source

fork: str | None

nameattributeinstance attribute#

View source

name: str

pull_request_numberattributeinstance attribute#

View source

pull_request_number: int | None

written_pathsattributeinstance attribute#

View source

written_paths: tuple[str, ...]