CommandResult, ConfigSetupReport

CommandResultclassdataclass#

Re-exported from ocx_sdk._resultsView source

class CommandResult(argv: tuple[str, ...], exit_code: int, stdout: str, stderr: str)

The outcome of one ocx process, before any typing.

What invoke() returns and what every typed method is built on.

Attributes

Name	Type	Description
argv	tuple[str, ...]	The argv that ran, with secrets already redacted by _process.
exit_code	int	The exit status. int, not ExitCode: a child killed by a signal reports a code ocx never assigns.
stdout	str	Raw stdout — JSON text for a --format json call.
stderr	str	Captured stderr in full, redacted.

argvattributeinstance attribute#

View source

argv: tuple[str, ...]

exit_codeattributeinstance attribute#

View source

exit_code: int

stderrattributeinstance attribute#

View source

stderr: str

stdoutattributeinstance attribute#

View source

stdout: str

ConfigSetupReportclassdataclass#

Re-exported from ocx_sdk._resultsView source

class ConfigSetupReport(status: str)

ocx config setup — the managed_config block of self setup’s report.

ocx wraps the block in an envelope; the SDK flattens it, because the envelope has exactly one key and a ConfigSetupReport.managed_config.status chain says nothing .status does not.

Attributes

Name	Type	Description
status	str	What the run did or would do, e.g. "would_adopt".

statusattributeinstance attribute#

View source

status: str

from_jsonmethodclassmethod#

View source

def from_json(raw: str) -> ConfigSetupReport

Parse ocx --format json config setup output.