Skip to content
ocx
install

SweepReport

SweepReportclassdataclass#

Re-exported from ocx_sdk._resultsView source
class SweepReport(tags: tuple[SweptTagReport, ...])

ocx package sign --tags / attest --tags (or --tags-file) (C-017, D2).

Upstream is generic (sweep.rs:152, SweepReport<R> { tags: Vec<SweptTagReport<R>> }); this is its Python shape for both instantiations. Carries no command or exit_code field — both are #[serde(skip)] upstream.

Payload is enveloped (D11): the envelope’s data holds {"tags": [...]}, and its exit_code — not part of data — is the process’s own. A partially-failed sweep exits non-zero, so a failed row usually arrives through partial_report(err) rather than a normal return (D10); both paths parse through this same from_json.

Attributes

NameTypeDescription
tagstuple[SweptTagReport, ...]One row per swept tag. A plain Vec upstream with no skip, so always present, not absent-when-empty.

tagsattributeinstance attribute#

tags: tuple[SweptTagReport, ...]

from_jsonmethodclassmethod#

def from_json(raw: str, row: Callable[[Mapping[str, Any]], _SweepRow]) -> SweepReport

Parse an enveloped sweep payload from a swept sign or attest.

Parameters

NameTypeDescription
rawstrCaptured stdout.
rowCallable[[Mapping[str, Any]], _SweepRow]Parses each row’s report object — see SweptTagReport.from_dict.