StatusReport

StatusReportclassdataclass#

Re-exported from ocx_sdk._resultsView source

class StatusReport(project: str, lock: LockStatus = LockStatus(), groups: Mapping[str, GroupStatus] = _EMPTY, package_settings: Mapping[str, Mapping[str, Any]] = _EMPTY)

ocx status — the project’s declaration, lock, and groups.

Exits 0 even when the lock is broken, so this struct is where a caller learns something is wrong (lock.current, lock.error).

Attributes

Name	Type	Description
project	str	Path to the ocx.toml the report describes.
lock	LockStatus	Lock file state.
groups	Mapping[str, GroupStatus]	Group name to its contents.
package_settings	Mapping[str, Mapping[str, Any]]	Per-package settings, carried through untyped — they are ocx’s configuration surface, not the SDK’s.

groupsattributeclass attributeinstance attribute#

View source

groups: Mapping[str, GroupStatus] = _EMPTY

lockattributeclass attributeinstance attribute#

View source

lock: LockStatus = field(default_factory=LockStatus)

package_settingsattributeclass attributeinstance attribute#

View source

package_settings: Mapping[str, Mapping[str, Any]] = _EMPTY

projectattributeinstance attribute#

View source

project: str

from_jsonmethodclassmethod#

View source

def from_json(raw: str) -> StatusReport

Parse ocx --format json status output.