Skip to content
ocx
install

PullReport, PushResult

PullReportclassdataclass#

Re-exported from ocx_sdk._resultsView source
class PullReport(packages: Mapping[str, WhichResult] = _EMPTY, advisories: tuple[Mapping[str, Any], ...] = ())

ocx pull at the project tier — paths plus advisories.

The wire object mixes both: identifiers key {path, kind} values, and a sibling advisories key sits among them. An identifier is always at least <repo>/<name>, so it can never collide with that key.

Attributes

NameTypeDescription
packagesMapping[str, WhichResult]Pinned identifier to where it landed.
advisoriestuple[Mapping[str, Any], ...]Warnings, carried untyped — no probe has seen a populated one, and ocx env’s advisory shape is not known to apply here.

advisoriesattributeclass attributeinstance attribute#

advisories: tuple[Mapping[str, Any], ...] = ()

packagesattributeclass attributeinstance attribute#

packages: Mapping[str, WhichResult] = _EMPTY

from_jsonmethodclassmethod#

def from_json(raw: str) -> PullReport

Parse ocx --format json pull output.

PushResultclassdataclass#

Re-exported from ocx_sdk._resultsView source
class PushResult(identifier: str, status: str, manifest_digest: str, cascade_tags_written: tuple[str, ...], keep_tags_written: tuple[str, ...], layers: Mapping[str, Any], platform_digests: Mapping[str, str] = _EMPTY, signatures: tuple[SignedPlatformReport, ...] = (), attestation: AttestationOutcome | None = None)

ocx package push — what landed in the registry.

Attributes

NameTypeDescription
identifierstrWhat was pushed.
statusstrWhat happened, e.g. "pushed".
manifest_digeststrDigest of the manifest that was written.
cascade_tags_writtentuple[str, ...]Cascading tags updated by the push.
keep_tags_writtentuple[str, ...]The __ocx.keep.sha256-<hex> tags written, one per platform manifest — push’s --keep-tag flag, which is on by default. Named for the wire key ocx 0.6 emits (C-005); 0.5 called it canonical_tags_written and wrote a sha256.<hex> tag, so a 0.1 call site reading the old attribute must be edited.
layersMapping[str, Any]Layer counts (mounted, uploaded, verified).
platform_digestsMapping[str, str]Manifest digest per pushed platform (C-005). Absent-when-unused (D7).
signaturestuple[SignedPlatformReport, ...]One row per platform’s signing outcome, when push(..., sign=True) was requested (C-005, C-018). Absent-when-unused (D7).
attestationAttestationOutcome | NoneThe push’s attestation outcome, when one was requested (C-005, C-019). Absent-when-unused (D7).