Skip to content
ocx
install

CascadeRepairReport

CascadeRepairReportclassdataclass#

Re-exported from ocx_sdk._resultsView source
class CascadeRepairReport(entries: tuple[RepairEntry, ...], dry_run: bool, announce_tags_path: str | None, exit_code: int = 0)

ocx package cascade repair — what was re-pointed, or would be.

Report-then-fail like check: exit 65 with this document when a finding remains — including on a dry_run, where “planned anything” is the finding — so exit_code rather than an exception says whether the registry now agrees with itself.

Attributes

NameTypeDescription
entriestuple[RepairEntry, ...]One entry per package, in input order.
dry_runboolTrue when nothing was written because the run was a preview.
announce_tags_pathstr | NoneWhere --announce-tags was written, when given.
exit_codeint0 when every attempted write succeeded and nothing remains, 65 otherwise.

announce_tags_pathattributeinstance attribute#

announce_tags_path: str | None

dry_runattributeinstance attribute#

dry_run: bool

entriesattributeinstance attribute#

entries: tuple[RepairEntry, ...]

exit_codeattributeclass attributeinstance attribute#

exit_code: int = 0

cleanproperty#

clean: bool

Whether no finding remains — the exit code’s answer.

from_jsonmethodclassmethod#

def from_json(raw: str, *, exit_code: int = 0) -> CascadeRepairReport

Parse ocx --format json package cascade repair output.

Parameters

NameTypeDefaultDescription
rawstrrequiredCaptured stdout.
exit_codeint0The process’s exit status, carried onto the result.